mirrors/Unciv
1
0
Fork 0
mirror of https://github.com/yairm210/Unciv.git synced 2025-07-30 06:39:17 +07:00
Code Issues Packages Projects Releases Wiki Activity

Clarify which entities are for Portraits (#12051)

Browse Source 
* Clarify which entities are for Portraits

Would this work?

* Add documentation for autoupdate workflow

* Remove autoupdate doc
This commit is contained in:
Caballero Arepa
2024-08-02 06:42:24 -05:00
committed by GitHub
parent 1ce9b462d5
commit e10652964b
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/Modders/Images-and-Audio.md
View File

@ -16,7 +16,7 @@ If you're developing your mod on an Android version of Unciv (not recommended!)
- Launch the desktop version with your mod (your mod's main folder is a subfolder of the game's "mods" folder, or symlinked there). This uses the packing methods [documented here](https://libgdx.com/wiki/tools/texture-packer).
- You can ask someone in the Discord server to help you out.
- You can use external tools, [e.g. gdx-texture-packer-gui](https://github.com/crashinvaders/gdx-texture-packer-gui). Utmost care needs to be taken that the files can be discovered by Unciv and internal relative paths are correct.
- The Unciv repo itself has a feature that can pack images on github runners - documentation still needs to be done.
- The Unciv repo itself has a feature that can pack images on github runners
### Multiple texture atlases
@ -171,7 +171,7 @@ For example, [here](https://github.com/yairm210/Unciv-leader-portrait-mod-exampl
### Adding Portraits
The base game uses flat icons, surrounded with colored circles as backgrounds (e.g. for units to fit the civilization's flag colors), to denote entities such as: units, buildings, techs, resources, improvements, religions, promotions, uniques, unit actions and nations in the UI. A mod can supply "Portraits" - static images that will remain uncolored - by adding images to `/Images/<entityType>Portraits/` (e.g. `/Images/BuildingPortraits/`, /Images/ResourcesPortraits/, etc), which will be used in all UI elements (except for unit icons in the world map). The file name must correspond exactly with the unit/building/tech/resource/etc name defined in corresponding JSONs (e.g. Units.json, Buildings.json, TileResources.json, etc) or have the same name as the file they suppose to replace, or they will be ignored.
The base game uses flat icons, surrounded with colored circles as backgrounds (e.g. for units to fit the civilization's flag colors), to denote entities such as: units, buildings, techs, resources, improvements, religions, promotions, uniques, unit actions and nations in the UI. A mod can supply "Portraits" - static images that will remain uncolored - by adding images to `/Images/<entityType>Portraits/` (e.g. `/Images/BuildingPortraits/`, `/Images/ResourcePortraits/`, etc), which will be used in all UI elements (except for unit icons in the world map). The file name must correspond exactly with the unit/building/tech/resource/etc name defined in corresponding JSONs (e.g. Units.json, Buildings.json, TileResources.json, etc) or have the same name as the file they suppose to replace, or they will be ignored.
If mod supplies '/Images/<entityType>Portraits/Background.png' images, they will be used as a background for corresponding portraits instead of default circle.
@ -317,3 +317,6 @@ Notes:
- In case of overlapping holidays, only one is chosen - and the "impact" of longer holidays is equalized by reducing the chance inversely proportional to the number of days. e.g. DiaDeLosMuertos is two days, so each Unciv launch on these days has 50% chance to show the egg.
- Unciv's "map-based" easter eggs work independently!
- No cultural prejudice is intended. If you know a nice custom we should include the date test for, just ask.
*<entityType>Portraits/: Entities are: 'Unit', 'Building', 'Tech', 'Resource', 'Improvement', 'Promotion', 'Unique', 'Nation', 'Religion', 'UnitAction'