Symbols

Symbols are located in the signs/symbols folder of your pack.

To add a symbol, simply put your texture file in the signs/symbols folder.

By default, your symbol will not have a category (and show up under "Uncategorized"). It will also not adapt to the background color of the road sign for that, we need to add a symbol definition to your symbol.

Symbol Definition

If you haven't already, it is recommended to check out the Texture Pipeline page, as it explains how the texture pipeline works in ClickSigns. And also the Colors page, as it explains how colors work for your textures.

To add a symbol definition, create a json file with the same name as your symbol file, but replace .png with .symbol.json.

A static texture definition can define a texture pipeline for that symbol. Since the base image of the texture is the symbol itself, we only need to define the texture processors that will be applied to the symbol.

{
  "texture": {
    "processors": [
      {
        "type": "replaceColor",
        "to": "foreground"
      }
    ]
  }
}

Adding a Category

To create a new category, all you need is a folder and a _category.json file inside that folder. All symbols in that folder (but not its subdirectories) will then belong to that category.

And then give a name to your category in the _category.json file:

{
  "name": "My Category"
}

You can also define a default symbol definition inside of _category.json, so that you don't need to create a .symbol.json file for every symbol in that category.

{
  "name": "My Category",
  "default": { 
    "texture": {
      "processors": [
        {
          "type": "replaceColor",
          "to": "foreground"
        }
      ]
    }
  }
}

References

Symbol Definition (.symbol.json)

Category Definition (_category.json)

Texture Pipeline

Texture Processors