Icons

Across various features of Palladium you'll come across "icons". They are a generalized way to define a 16x16 texture that can be used anywhere (e.g. powers, abilities, etc.).
To define one, you have multiple easy ways to do so.

Inline Definitions

The most common types of icons can be defined in a single line for easy usage.

Item

To display an item you simply specify its ID:

"icon": "minecraft:apple"

Texture

To render a texture you need to specify the path to it, including the .png suffix:

"icon": "example:textures/icon/my_cool_icon.png"

Alternatively, if you have a dynamic texture set up, you can specify its ID too using a #:

"icon": "#example:my_dynamic_texture"

Sprites

Sprites are a more performant way of rendering textures, as they are all stitched together into one big texture file when the game reloads. They are placed in assets/<namespace>/textures/gui/sprites/<filename>.png.
So to use one as an icon, you need to specify its ID which results from its path. As an example, a sprite texture file located at assets/example/textures/gui/sprites/icon/my_cool_icon.png would be example:icon/my_cool_icon:

"icon": "example:icon/my_cool_icon"

Specific Definitions

To access more icon types you have to write out their definitions specifically, by declaring them by type. Below is a list of available types added by Palladium. In your palladium/documentation/palladium folder you can find a similiar that's auto-generated by the mod which can include icons that are added by other mods.

Compound

ID: palladium:compound

Fits multiple icons into one

Settings

Key	Type	Description	Required	Fallback
icons	Icon definition array	Array of icons that will be displayed		/

Example

{
  "type": "palladium:compound",
  "icons": [
    {
      "item": {
        "id": "minecraft:apple"
      },
      "type": "palladium:item"
    },
    {
      "sprite": "example:sprite",
      "type": "palladium:sprite"
    }
  ]
}

---

Experience

ID: palladium:experience

Displays an amount of experience points of levels

Settings

Key	Type	Description	Required	Fallback
amount	Integer (>= 0)	Amount of xp points or levels		/
level	Boolean	Whether or not this will be displayed as xp points or levels		true

---

Ingredient

ID: palladium:ingredient

An icon that will display all items of an ingredient by cycling through them

Settings

Key	Type	Description	Required	Fallback
ingredient	Ingredient / Item	The ingredient (check vanilla recipes for how to define ingredients)		/

Example 1

{
  "type": "palladium:ingredient",
  "ingredient": [
    "minecraft:apple",
    "minecraft:bread"
  ]
}

Example 2

{
  "type": "palladium:ingredient",
  "ingredient": "#minecraft:planks"
}

---

Item

ID: palladium:item

Displays an item

Settings

Key	Type	Description	Required	Fallback
item	Item / ItemStack	The item that will be displayed		/

Example

{
  "type": "palladium:item",
  "item": {
    "id": "minecraft:apple"
  }
}

---

Item in Slot

ID: palladium:item_in_slot

Renders an item that's currently in the slot of the player

Settings

Key	Type	Description	Required	Fallback
slot	mainhand offhand head chest legs feet body curios:head curios:necklace	The slot that will be have its item displayed		/

Example

{
  "type": "palladium:item_in_slot",
  "slot": "chest"
}

---

Sprite

ID: palladium:sprite

Renders a sprite as an icon (sprites are located under 'textures/gui/sprites/)

Settings

Key	Type	Description	Required	Fallback
sprite	Identifier	The ID of the sprite that will be rendered		/

Example

{
  "type": "palladium:sprite",
  "sprite": "example:my_cool_icon"
}

---

Textured

ID: palladium:texture

Render a texture as an icon

Settings

Key	Type	Description	Required	Fallback
texture	Texture Reference	Path to the texture, or a dynamic texture ID		/
tint	Color	A tint that will be given to rendered texture		/

Example 1

{
  "type": "palladium:texture",
  "texture": "example:textures/icon/my_cool_icon.png"
}

Example 2

{
  "type": "palladium:texture",
  "texture": "example:textures/icon/my_cool_icon.png",
  "tint": "#ff0000"
}

Example 3

{
  "type": "palladium:texture",
  "texture": "#example:my_dynamic_texture"
}

---