Pack JSON Files

Here is a template on the pack json

json

{
  "topic": "Category",
  "subcategory_of": "Parent Category",
  "packs": [
    {
      "pack_id": "pack_name with no space",
      "pack_name": "name of pack",
      "pack_description": "description of pack",
      "message": ["warn (red)/error (orange)/info (cyan)", "message for it"],
      "icon": "gif/apng/*",
      "priority": true,
      "conflict": ["packid of conflicting pack"],
      "compatibility": ["packid of compatible pack"]
    }
  ]
}

From the example above, there is a lot going on in the json file. Even though, the objects should be self-explanatory, I will still attempt to explain them line by line.

Topic: Basically names your category.

json

{
  "topic": "Category", 
  "subcategory_of": "Parent Category <can be left out if already parent>",

Subcategory of: The parent category. Exists for subcategories to mark that they are subcategories of a certain category.

json

  "topic": "Category",
  "subcategory_of": "Parent Category", 
  "packs": [

TIP

If the category is not defined as a subcategory, this will be skipped.

Pack ID: Your Pack's ID.

json

    {
      "pack_id": "pack_name with no space", 
      "pack_name": "name of pack",

NOTE

Most Pack IDs are simply Pack Names with no Special Characters and Spaces. You can keep to it or name it based on the Sub-Category.

Pack Name: Your Pack's Name.

json

      "pack_id": "pack_name with no space",
      "pack_name": "name of pack", 
      "pack_description": "description of pack",

Pack Description: Your Pack's Description.

json

      "pack_name": "name of pack",
      "pack_description": "description of pack", 
      "message": ["warn (red)/error (orange)/info (cyan)", "message for it"],

NOTE

The following are not compulsory.

Message: Provide extra info on a pack.

json

      "pack_description": "description of pack",
      "message": ["warn (red)/error (orange)/info (cyan)", "message for it"], 
      "icon": "gif/apng/*",

IMPORTANT

Only use ONE message type. Use either warn, error or info. You also need to provide a message for it.

Icon: Allows you to set a pack icon extension. Default is png, so you can set it to apng, gif or jpeg if you want.

json

      "message": ["warn (red)/error (orange)/info (cyan)", "message for it"],
      "icon": "gif/apng/*", 
      "priority": true,

TIP

You can use any image file extensions! You aren't limited to just gif or apng. However, make sure you do not add the period .

Priority: Sets the pack as the higher priority and overwrites conflicting textures.

json

      "icon": "gif/apng/*",
      "priority": true, 
      "conflict": ["packid of conflicting pack"],

TIP

Default is false, so you don't have to specify it.

Conflict: List of PackIDs of packs that conflict with the current one.

json

      "priority": true,
      "conflict": ["packid of conflicting pack"], 
      "compatibility": ["packid of compatible pack"]

Compatibility: List of PackIDs of packs that have custom compatibilities made for them

json

      "conflict": ["packid of conflicting pack"],
      "compatibility": ["packid of compatible pack"] 
    }

TIP

After creating a compatibility, make sure to run ./pys/folder_creator.py to create a respective folder for it.

Contributors

Pack JSON Files ​

Pack JSON Files