ModUI: Difference between revisions

From The Colonists
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
The '''ui.json''' file may be used to change the game interface.<br>
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 21:24, 11 January 2023

The ui.json file may be used to change the game interface.

JSON fields

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

Example JSON

{
  "constructionGridBuildingIds": [
    41,
    19,
    38
  ],
{
  "globalStorageUISpec": {
    "groupSpecs": [
      {
        "category": 0,
        "entries": [
          {
            "resourceId": 43,
            "resourceCategoryId": 0
          },
          {
            "resourceId": 45,
            "resourceCategoryId": 0
          },
          {
            "resourceId": 46,
            "resourceCategoryId": 0
          }
        ]
      },
      {
        "category": 2,
        "entries": [
          {
            "resourceId": 12,
            "resourceCategoryId": 0
          },
          {
            "resourceId": 254,  // 254 = use Resource Group
            "resourceCategoryId": 2 // Simple Food Group
          },
          {
            "resourceId": 0,
            "resourceCategoryId": 0
          },
          {
            "resourceId": 254, // 254 = use Resource Group
            "resourceCategoryId": 4	// Alcohol Group
          },
          {
            "resourceId": 9,
            "resourceCategoryId": 0
          },
          {
            "resourceId": 10,
            "resourceCategoryId": 0
          },
          {
            "resourceId": 48,
            "resourceCategoryId": 0
          },
          {
            "resourceId": 49,
            "resourceCategoryId": 0
          },
          {
            "resourceId": 254,  // 254 = use Resource Group
            "resourceCategoryId": 3 // Luxury Food Group
          }
        ]
      }
    ]
  }
}
  "techCategoryOrderIds": [
    0,
    6,
    4,
  ]
}