Image packs

Image packs contain images used to display creatures with set region colors.

Image packs definition

To use image packs, they need to be defined in a file in the json folder in ASB. There is one official image pack file named imagePacks.json which will be overwritten on updates. To define custom image packs, the file needs to match the pattern imagePacks*.json, where * are any valid characters, e.g. imagePacks_custom.json.

For packs with a remote source only the "url" parameter is needed. For local packs, the url should be ommitted and the "folderName" property needs to be set, the other parameters are optional.

File structure

[
  {
    "url": "url to folder of image pack, ending with a slash",
    "name": "image pack name",
    "description": "",
    "creator": "",
    "folderName": "needs to be unique"
  },
  {
    "url": "..."
  }
]

Image pack manifest file

Each image pack needs a manifest file directly in the images folder named _manifest.json that contains all the images in that pack. It contains one object "files" that has key values for each available file. If the pack is local, the value can be empty. For packs with a source the value contains a hash of the file to make sure it's up to date. For reference see the official images pack.

Manifest file for packs with a source

{
  "files": {
    "!info.json": {
      "version": "1",
      "metadata": {
        "name": "image pack name",
        "description": "",
        "creator": ""
      }
    },
    "Argentavis_ASA.png": { "hash": "md5:278dae53344253b5552c695b93daec9a:98245" },
    "Argentavis_ASA_m.png": { "hash": "md5:278dae21b53633be572cc9cb9cdaec9a:68744" }
  }
}

Manifest file for local packs without a source

{
  "files": {
    "Argentavis_ASA.png": {},
    "Argentavis_ASA_m.png": {}
  }
}

Pack preference

The preference order of the image packs can be set in the app via Settings - Image Packs…. If some species should prefer images of other image packs, a custom preference file can be created in the json folder named preferImagePacks.json that contains key value pairs of a species name (or blueprint path) and the name of the image pack. E.g.

{
  "Argentavis": "my image pack"
}