mirrors/Unciv
1
0
Fork 0
mirror of https://github.com/yairm210/Unciv.git synced 2025-07-15 02:09:21 +07:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation to contain information on victory types (#6615)

Browse Source
This commit is contained in:
Xander Lenstra
2022-04-26 11:31:11 +02:00
committed by GitHub
parent 27718bd605
commit c985782113
2 changed files with 58 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/Modders/uniques.md
View File

@ -280,6 +280,16 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: Global
??? example "[stats] when a city adopts this religion for the first time (modified by game speed)"
Example: "[+1 Gold, +2 Production] when a city adopts this religion for the first time (modified by game speed)"
Applicable to: Global
??? example "[stats] when a city adopts this religion for the first time"
Example: "[+1 Gold, +2 Production] when a city adopts this religion for the first time"
Applicable to: Global
??? example "[relativeAmount]% Unhappiness from [populationFilter] [cityFilter]"
Example: "[+20]% Unhappiness from [Followers of this Religion] [in all cities]"
@ -679,6 +689,11 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: Global, Unit
??? example "When spreading religion to a city, gain [amount] times the amount of followers of other religions as [stat]"
Example: "When spreading religion to a city, gain [3] times the amount of followers of other religions as [Culture]"
Applicable to: Global, Unit
??? example "No defensive terrain bonus"
Applicable to: Global, Unit
@ -785,6 +800,12 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
??? example "Only available"
Applicable to: Tech, Policy, Building, Unit, Promotion, Improvement
## FounderBelief uniques
??? example "[stats] for each global city following this religion"
Example: "[+1 Gold, +2 Production] for each global city following this religion"
Applicable to: FounderBelief
## FollowerBelief uniques
??? example "[relativeAmount]% [stat] from every follower, up to [relativeAmount]%"
Example: "[+20]% [Culture] from every follower, up to [+20]%"

38
docs/Other/Miscellaneous-JSON-files.md
View File

@ -62,7 +62,7 @@ Each era can have the following attributes:
## ModOptions.json
[Link to original](https://github.com/yairm210/Unciv/tree/master/android/assets/jsons/Civ%20V%20-%20Gods%20&%20Kings/ModOptions.json)
<!-- [Link to original](https://github.com/yairm210/Unciv/tree/master/android/assets/jsons/Civ%20V%20-%20Gods%20&%20Kings/ModOptions.json) -->
This file is a little different:
@ -135,6 +135,42 @@ Legend:
- [^H]: MapGenerator.spawnLakesAndCoasts: Water bodies up to this tile count become Lakes
- [^I]: RiverGenerator: river frequency and length bounds
## VictoryTypes.json
[link to original](https://github.com/yairm210/Unciv/tree/master/android/assets/jsons/Civ%20V%20-%20Gods%20&%20Kings/VictoryTypes.json)
These files contain which victories this mod provides, and what milestones must be reached for someone to win a victory.
Most of the file contains of strings that are shown to the user in the victory screen, with the rest being the requirements for winning.
Each victory can have the following attributes:
| Attribute | Type | Optional | Notes |
| --------- | ---- | -------- | ----- |
| name | String | Required | Name of the victory |
| victoryScreenHeader | String | Defaults to "" | Shown in the footer of the victory in the `our status` in the victory screen |
| victoryString | String | Defaults to "" | Shown in the footer of the victory screen when you won the game with this victory |
| defeatString | String | Defaults to "" | Shown in the footer of the victory screen when someone else won the game with this victory |
| hiddenInVictoryScreen | Boolean | Defaults to false | Whether progress of this victory is hidden in the victory screen |
| requiredSpaceshipParts | List of Strings | Defaults to "" | What spaceship parts must be added to the capital for the corresponding milestone |
| Milestones | List of Strings | Required | List of milestones that must be accomplished to win, see [below](#Milestones) |
### Milestones
Currently the following milestones are supported:
| Milestone | Requirement |
| --------- | ----------- |
| Build [building] | Build the building [building] in any city |
| Anyone build [building] | Anyone must build the building [building] for all players to have this milestone |
| Add all [comment] in capital | Add all units in the `requiredSpaceshipParts` field of this victory to the capital |
| Destroy all players | You must be the only major civilization with any cities left |
| Capture all capitals | Capture all the original capitals of major civilizations in the game |
| Complete [amount] Policy branches | Fully complete at least [amount] policy branches |
| Win diplomatic vote | At any point in the game win a diplomatic vote (UN). You may lose afterwards and still retain this milestone |
| Become the world religion | Have your religion be the majority religion in a majority of cities of all major civs |
| Have highest score after max turns | Basically time victory. Enables the 'max turn' slider and calculates score when that amount is reached |
## Civilopedia text
Any 'thing' defined in json and listed in the Civilopedia can supply extra text, specifically for the Civilopedia. This can be used to explain special considerations better when the automatically generated display is insufficient, or for 'flavour', background stories and the like. Such text can be formatted and linked to other Civilopedia entries, within limits.