Map-related JSON files

Terrains.json

Link to original

This file contains the base terrains, terrain features and natural wonders that can appear on the map.

Each terrain entry has the following structure:

TileImprovements.json

Link to original

This file lists the improvements that can be constructed or created on a map tile by a unit having the appropriate unique.

Note that improvements have two visual representations - icon and pixel graphic in the tileset. Omitting the icon results in a horribly ugly user interface, while omitting tileset graphics will just miss out on an optional visualization. If you provide a pixel graphic for FantasyHex, please be aware of the layering system and the ruleVariants in the tileset json. A single graphic may suffice if it has lots of transparency, as it will be drawn on top of all other terrain elements.

Each improvement has the following structure:

TileResources.json

Link to original

This file lists the resources that a map tile can have.

Note the predefined resourceType enum cannot be altered in a json.

Note also that resources have two visual representations - icon and pixel graphic in the tileset. Omitting the icon results in a horribly ugly user interface, while omitting tileset graphics will miss out on a visualization on the map. If you provide a pixel graphic for FantasyHex, please be aware of the layering system and the ruleVariants in the tileset json. A single graphic may suffice if it has lots of transparency, as it will be drawn on top of terrain and features but below an improvement - if the single improvement graphic exists at all.

Each resource has the following structure:

Ruins.json

Link to original

This optional file contains the possible rewards ancient ruins give.

Base ruleset Mods can omit the file, in which case they inherit the ones from the Vanilla ruleset. They can, however, provide a file with an empty list ([]) to avoid that. In this case there should be no improvements with the "Provides a random bonus when entered" Unique. Conversely, if there are such improvements, the Mod checker will flag an empty Ruins file as error.

Each of the objects in the file represents a single reward you can get from ruins. It has the following structure:

• Create a list of all possible rewards. Each reward's frequency in the list corresponds to its weight, a reward with weight one will appear once, a reward with weight two will appear twice, etc.
• Shuffle this list
• Try give rewards starting from the top of the list. If any of the uniques of the rewards is valid in this context, reward it and stop trying more rewards.

Notifications

Some of the rewards ruins can give will have results that are not deterministic when writing it in the JSON, so creating a good notification for it would be impossible. An example for this would be the "Gain [50]-[100] [Gold]" unique, which will give a random amount of gold. For this reason, we allow some notifications to have parameters, in which values will be filled, such as "You found [goldAmount] gold in the ruins!". All the uniques which have this property can be found below.

Specific uniques

A few uniques can be added to ancient ruin effects to modify when they can be earned. These are:

• "Only available after [amount] turns"
• "Only available <when religion is enabled>"
• "Hidden after a great prophet has been earned"

Tileset-specific json

Link to original FantasyHex

A mod can define new Tilesets or add to existing ones, namely FantasyHex. There is one json file per Tileset, named same as the Tileset, and placed in a subfolder named "TileSets" relative to the other json files. This is called TileSetConfig and has the following structure:

Layering images

ruleVariants control substitutions when layering images for a tile, they are list looking like:

"ruleVariants": {
    "Grassland+Forest": ["Grassland", "GrasslandForest"],
    "Plains+Forest": ["Plains", "PlainsForest"],
    "Plains+Jungle": ["Plains", "PlainsJungle"],
    // . . .
}

Each line means "if the tile content is this... then combine the following png images". The key part follows a specific order and must match in its entirety, meaning "Plains+Forest" is not valid for "Plains+Forest+Deer", and when it matches no other image layering is done except roads and units (I think - WIP).

When TileSetConfig's for the same Tileset are combined, for the first three properties the last mod wins, while ruleVariants are merged, meaning only an entry with the same key overwrites an earlier entry. (TODO)

Stats

Terrains, features, resources and improvements may list yield statistics. The statistics can be one of the following:

• production
• food
• gold
• science
• culture
• happiness
• faith

General stat

If an object carries general stat(s), it contains any combination (or none) of the above stats, each mapping to a corresponding number ⁶. For Example:

"gold": 2,
"improvement": "Quarry",

Specialized stats

For specialized stats, they might come as sub-object in a named field. The sub-object contains any combination (or none) of the above stats, each mapping to a corresponding number ⁶. For Example:

"improvement": "Quarry",
"improvementStats": { "gold": 1, "production": 1 },