ModUI: Difference between revisions

From The Colonists
Jump to navigation Jump to search
add example JSON
placeholder for change to globalStorageUISpec
Line 1: Line 1:
The '''ui.json''' file may be used to change the game interface.
The '''ui.json''' file may be used to change the game interface.<br>
'''pending change. resourceCategoriesDict obsolete and change to globalStorageUISpec'''.<br>


==JSON fields==
==JSON fields==

Revision as of 01:51, 8 January 2023

The ui.json file may be used to change the game interface.
pending change. resourceCategoriesDict obsolete and change to globalStorageUISpec.

JSON fields

Name Entry Description
constructionGridBuildingIds building ID Defines order, not the menu, of buildings in the building selection (bottom right)
resourceCategoriesDict id
itemTypeId
itemCategory
Defines grouping, categorisation, and order of resources show in the bottom left menu
id should be unique from other resources in this file
itemTypeId matches the value of typeId in resources.json
techCategoryOrderIds Tech category Defines order of research category panels in research window
  • note itemCategory is used when itemTypeId=254 to refer to a category (e.g. "Food", "Luxury Food", "Fuel"), otherwise itemCategory=0.

Example JSON

{
  "constructionGridBuildingIds": [
    41,
    19,
    38
  ],
  "resourceCategoriesDict": {
    "0": [
      {
        "id": 0,
        "itemTypeId": 43,
        "itemCategory": 0
      },
      {
        "id": 1,
        "itemTypeId": 45,
        "itemCategory": 0
      },
      {
        "id": 2,
        "itemTypeId": 46,
        "itemCategory": 0
      }
    ],
    "1": [
      {
        "id": 9,
        "itemTypeId": 6,
        "itemCategory": 0
      },
      {
        "id": 10,
        "itemTypeId": 2,
        "itemCategory": 0
      }
    ],
    "2": [
      {
        "id": 20,
        "itemTypeId": 12,
        "itemCategory": 0
      },
      {
        "id": 21,
        "itemTypeId": 254, // 254 for item category
        "itemCategory": 2 // item category 2 = simple food
      },
      {
        "id": 24,
        "itemTypeId": 254, // 254 for item category
        "itemCategory": 4 // item category 4 = alcohol
      }
    ]
  }
  "techCategoryOrderIds": [
    0,
    6,
    4,
  ]
}