mirror of
https://github.com/yairm210/Unciv.git
synced 2025-07-08 23:08:35 +07:00
Step-by-step instructions to create a new Civilization mod
This commit is contained in:
Yair Morgenstern
@ -4,7 +4,7 @@ import java.io.File
|
||||
|
||||
class UiElementDocsWriter {
|
||||
companion object {
|
||||
private const val docPath = "../../docs/Modders/Creating-a-UI-skin.md"
|
||||
private const val docPath = "../../docs/Modders/5-Creating-a-UI-skin.md"
|
||||
private const val startMarker = "<!--- DO NOT REMOVE OR MODIFY THIS LINE UI_ELEMENT_TABLE_REGION -->"
|
||||
private const val endMarker = "<!--- DO NOT REMOVE OR MODIFY THIS LINE UI_ELEMENT_TABLE_REGION_END -->"
|
||||
private const val srcPath = "../../core/src/com/unciv/"
|
||||
|
||||
@ -1,8 +1,14 @@
|
||||
# 'My first mod' - Making a new Civilization
|
||||
|
||||
So you want to add your favorite civilization?
|
||||
By the end of this tutorial, you should have a working, generally-available mod that adds a new Civilization to the game
|
||||
|
||||
There are a few steps required, so we'll walk you through them!
|
||||
## Create your repository
|
||||
|
||||
- Create a [Github account](https://github.com/join), if you don't already have one
|
||||
- Go to the [mod example](https://github.com/yairm210/Unciv-mod-example)
|
||||
- Click the green `Use this template` button - `Create a new repository`
|
||||
- Choose your repository name and click `Create repository from template` (keep setting on 'public'!)
|
||||
- Your new repository is now available!
|
||||
|
||||
## Fill in your Nation info
|
||||
|
||||
@ -10,7 +16,7 @@ Each civ has some basic information - what the civ name is, the leader's name, c
|
||||
|
||||
In addition, each civ has flavor text when declaring war, intoduction etc.
|
||||
|
||||
All of these need to be filled in in [Nations.json](https://github.com/yairm210/Unciv/blob/master/android/assets/jsons/Civ%20V%20-%20Gods%20&%20Kings/Nations.json)
|
||||
All of these need to be filled in in `jsons/Nations.json` file - see [here](https://github.com/yairm210/Unciv/blob/master/android/assets/jsons/Civ%20V%20-%20Gods%20&%20Kings/Nations.json) for the base game file for more examples
|
||||
|
||||
## Get your Civ icon
|
||||
|
||||
@ -18,29 +24,54 @@ Each civ has an icon, like the wreath for Rome, for instant identification.
|
||||
|
||||
All of these icons are white on a transparent background, and are 100x100 pixels - see [icon considerations](#icon-considerations) for details
|
||||
|
||||
You'll need to put your icon in the [NationIcons folder](https://github.com/yairm210/Unciv/tree/master/android/Images.NationIcons/NationIcons).
|
||||
You'll need to put your icon in the `Images/NationIcons` folder - you can navigate there and click `Add file - Create a new file` (top-right corner)
|
||||
|
||||
Same as with the nation name and leader name, the unique ability should also be put in the Nations translation file for bonus points =)
|
||||
## Test it out!
|
||||
|
||||
- Open Unciv
|
||||
- Click 'Mods' - 'Download mod from URL'
|
||||
- Copy-paste your repository's URL to the textbox, and click 'Download'
|
||||
- Exit the mod screen, and create a new game, selecting your mod - which will be under 'Extension mods' on the left
|
||||
|
||||
Congrats, your Civ is now fully playable!
|
||||
|
||||
But apart from the flavor, they are boring gameplay-wise, so now we need to add unique abilities!
|
||||
!!! note
|
||||
|
||||
You currently won't see any images from this mod, since it has no texture atlas - see [here](1-Mods.md#more-on-images-and-the-texture-atlas) for more details
|
||||
If you're on Desktop, you can restart Unciv to generate this atlas and see the images
|
||||
|
||||
But this nation's abilities are exactly those of the base mod. To make it truly unique, we'll need to change some Uniques ;)
|
||||
|
||||
## Adding unique units
|
||||
|
||||
Units in general are added in the [Units.json](https://github.com/yairm210/Unciv/blob/master/android/assets/jsons/Civ%20V%20-%20Gods%20&%20Kings/Units.json) file, with an icon in the [UnitIcons](https://github.com/yairm210/Unciv/tree/master/android/Images.Construction/UnitIcons) folder.
|
||||
Units are defined in the `jsons/Units.json` - for the base game file, see [here](https://github.com/yairm210/Unciv/blob/master/android/assets/jsons/Civ%20V%20-%20Gods%20&%20Kings/Units.json) file, with an icon in the [UnitIcons](https://github.com/yairm210/Unciv/tree/master/android/Images.Construction/UnitIcons) folder.
|
||||
|
||||
The icon must be 200x200 pixels, white on transparent background - see [icon considerations](#icon-considerations) for details
|
||||
The icons must be 200x200 pixels, white on transparent background - see [icon considerations](#icon-considerations) for details - and go in the `Images/UnitIcons` folder
|
||||
|
||||
Remember that these are unique units, so search for an existing unique unit to see how they replace their regular counterparts!
|
||||
|
||||
## Adding unique buildings
|
||||
|
||||
Same as the units - info is in the [Buildings.json](https://github.com/yairm210/Unciv/blob/master/android/assets/jsons/Civ%20V%20-%20Gods%20&%20Kings/Buildings.json) file and icons in the [BuildingIcons](https://github.com/yairm210/Unciv/tree/master/android/Images.Construction/BuildingIcons) folder, same rules for the icons apply (200x200 pixels, icon considerations)
|
||||
Same as the units - info is in `jsons/Buildings.json` - for the base game file, see [Buildings.json](https://github.com/yairm210/Unciv/blob/master/android/assets/jsons/Civ%20V%20-%20Gods%20&%20Kings/Buildings.json) file and icons in the [BuildingIcons](https://github.com/yairm210/Unciv/tree/master/android/Images.Construction/BuildingIcons) folder, same rules for the icons apply (200x200 pixels, icon considerations)
|
||||
|
||||
Icons go in `Images/BuildingIcons`
|
||||
|
||||
## Civ Unique
|
||||
|
||||
Check out our [list of uniques](Unique-parameters.md) to see all the cool special effects you can add to your civilization!
|
||||
Check out our [list of uniques](uniques.md) to see all the cool special effects you can add to your civilization!
|
||||
|
||||
## Make it searchable!
|
||||
|
||||
To list your mod in the Unciv Mods screen:
|
||||
|
||||
- Open your repository
|
||||
- Click the gear icon, to the right of the 'About' label (right side, top)
|
||||
- Under 'Topics', add 'unciv-mod'
|
||||
- 'Save changes'
|
||||
|
||||
Congrats, your mod will now be shown in the mods page!
|
||||
|
||||
The more stars your repo has, the higher towards the top it will appear, so start gaining fans :D
|
||||
|
||||
## Icon considerations
|
||||
|
||||
@ -51,3 +82,13 @@ Icons directly from the base game belong to Firaxis, so I'm not sure we're legal
|
||||
One source I use constantly is [The Noun Project](https://thenounproject.com) - everything there is Creative Commons or open, so they can all be used!
|
||||
|
||||
Credits for icons should go in a `Credits.md` page.
|
||||
|
||||
## What's next?
|
||||
|
||||
You have a working mod, now it's time to go wild!
|
||||
|
||||
- Add the [atlas files](1-Mods.md#more-on-images-and-the-texture-atlas) to your repo so your users get images
|
||||
- Install Git locally, so you can change your files on your device and have those changes reflected in your repository
|
||||
- Expand the abilities of your civ by adding new [uniques](uniques.md)
|
||||
- Add new civs, buildings or units
|
||||
- Expand into other game objects by exploring the rest of the [mod file structure](Mod-file-structure/1-Overview.md)
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Creating a custom2 tileset
|
||||
# Creating a custom tileset
|
||||
|
||||
**You should read the [Mods](1-Mods.md) page first before proceeding**
|
||||
|
||||
|
||||
@ -201,4 +201,4 @@ The color this UI element should have.
|
||||
|
||||
A float value. Default value: null
|
||||
|
||||
The alpha this UI element should have. Overwrites the alpha value of tint if specified.
|
||||
The alpha this UI element should have. Overwrites the alpha value of tint if specified.
|
||||
Reference in New Issue
Block a user