ModUI: Difference between revisions

From The Colonists
Jump to navigation Jump to search
swap resourceCategoriesDict to globalStorageUISpec
No edit summary
Line 18: Line 18:
| globalStorageUISpec
| globalStorageUISpec
| category<br>entries
| category<br>entries
| Defines order and grouping of resources in lower left menu
| Defines [[ResourceCatModIds|'''grouping''']], [[Resource_Categories|'''categorisation''']], and order of [[Resource|resources]] show in the bottom left menu
|-
|-
| '''OBSOLETE'''
| '''OBSOLETE'''
Line 29: Line 29:
|-
|-
|}
|}
* note itemCategory is used when itemTypeId=254 to refer to a [[Resource_Categories|category]] (e.g. "Food", "Luxury Food", "Fuel"), otherwise itemCategory=0.<br>
* note resourceCategoryId is used when resourceId=254 to refer to a [[Resource_Categories|category]] (e.g. "Food", "Luxury Food", "Fuel"), otherwise resourceCategoryId=0.<br>
* note globalStorageUISpec superceded resourceCategoriesDict. Left in for history.<br>
* note globalStorageUISpec superceded resourceCategoriesDict. Left in for history.<br>
=Example JSON=
=Example JSON=
Line 39: Line 39:
     38
     38
   ],
   ],
  "resourceCategoriesDict": {
{
    "0": [
  "globalStorageUISpec": {
      {
     "groupSpecs": [
        "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,
         "category": 0,
         "itemTypeId": 254, // 254 for item category
         "entries": [
        "itemCategory": 2 // item category 2 = simple food
          {
            "resourceId": 43,
            "resourceCategoryId": 0
          },
          {
            "resourceId": 45,
            "resourceCategoryId": 0
          },
          {
            "resourceId": 46,
            "resourceCategoryId": 0
          }
        ]
       },
       },
       {
       {
         "id": 24,
         "category": 2,
         "itemTypeId": 254, // 254 for item category
         "entries": [
        "itemCategory": 4 // item category 4 = alcohol
          {
            "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": [
   "techCategoryOrderIds": [
     0,
     0,

Revision as of 18:15, 11 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)
techCategoryOrderIds Tech category Defines order of research category panels in research window
globalStorageUISpec category
entries
Defines grouping, categorisation, and order of resources show in the bottom left menu
OBSOLETE OBSOLETE OBSOLETE
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
  • 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,
  ]
}