Example Pack File Structure

The documentation has examples scattered across each section. You can use this page to see where files go, what they could contain, etc. more easily.

assets

catharsis

misc_items.json

{
  "textures": {
    "skyblock:misc/pets/bat": "ewogICJ0aW1lc3RhbXAiIDogMTYwMjAzOTYxNzA5MSwKICAicHJvZmlsZUlkIiA6ICJlZDUzZGQ4MTRmOWQ0YTNjYjRlYjY1MWRjYmE3N2U2NiIsCiAgInByb2ZpbGVOYW1lIiA6ICIwMTAwMDExMDAxMDAwMDExIiwKICAic2lnbmF0dXJlUmVxdWlyZWQiIDogdHJ1ZSwKICAidGV4dHVyZXMiIDogewogICAgIlNLSU4iIDogewogICAgICAidXJsIiA6ICJodHRwOi8vdGV4dHVyZXMubWluZWNyYWZ0Lm5ldC90ZXh0dXJlLzM3N2FkZThhZmIyNTcwODZmYjE4NjFkYTQzYzhhZTQ2OGI4ZWIwNTc4ZmFkYTg0MzAzODU4NTE3YmExNzIxN2UiCiAgICB9CiAgfQp9",
    "skyblock:misc/coin/iron": [
      "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNTM4MDcxNzIxY2M1YjRjZDQwNmNlNDMxYTEzZjg2MDgzYTg5NzNlMTA2NGQyZjg4OTc4Njk5MzBlZTZlNTIzNyJ9fX0=",
      "ewogICJ0aW1lc3RhbXAiIDogMTcxOTYwMDMwOTQ4MywKICAicHJvZmlsZUlkIiA6ICI1OTgyOWY1ZGY3MmM0ZmFlOTBmOGVhYmM0MjFjMzJkYiIsCiAgInByb2ZpbGVOYW1lIiA6ICJQZXBwZXJEcmlua2VyIiwKICAic2lnbmF0dXJlUmVxdWlyZWQiIDogdHJ1ZSwKICAidGV4dHVyZXMiIDogewogICAgIlNLSU4iIDogewogICAgICAidXJsIiA6ICJodHRwOi8vdGV4dHVyZXMubWluZWNyYWZ0Lm5ldC90ZXh0dXJlLzE2YjkwZjRmYTNlYzEwNmJmZWYyMWYzYjc1ZjU0MWExOGU0NzU3Njc0ZjdkNTgyNTBmYTdlNzQ5NTJmMDg3ZGMiLAogICAgICAibWV0YWRhdGEiIDogewogICAgICAgICJtb2RlbCIgOiAic2xpbSIKICAgICAgfQogICAgfQogIH0KfQ=="
    ]
  }
}

misc_items.json

tooltip.json

{
  "type": "minecraft:select",
  "property": "catharsis:data_type",
  "data_type": "rarity",
  "cases": [
    {
      "when": "uncommon",
      "model": {
        "type": "catharsis:texture",
        "texture": "your_name_space:uncommon"
      }
    }
  ]
}

tooltip.json

minecraft

catharsis

block_replacements

cyan_terracotta.json

{
  "type": "conditional",
  "definition": {
    "type": "redirect",
    "virtual_state": "furfsky:mithril_tier0"
  },
  "condition": {
    "type": "relative",
    "offset": "0:-1:0",
    "condition": {
      "type": "id",
      "block": [
        "minecraft:grass_block",
        "minecraft:dirt"
      ]
    }
  }
}

cyan_terracotta.json

dirt.json

{
  "type": "per_area",
  "entries": {
    "your_name_space:simple": {
      "type": "redirect",
      "virtual_state": "your_name_space:diamond"
    }
  }
}

dirt.json

oak_leaves.json

{
  "type": "redirect",
  "virtual_state": "your_name_space:gold"
}

oak_leaves.json

oak_log.json

{
  "type": "random",
  "min": 0,
  "max": 20,
  "threshold": 15,
  "definition": {
    "type": "redirect",
    "virtual_state": "your_name_space:diamond"
  },
  "fallback": {
    "type": "redirect",
    "virtual_state": "your_name_space:gold"
  }
}

oak_log.json

redstone_block.json

{
  "type": "select",
  "definitions": [
    {
      "type": "conditional",
      "definition": {
        "type": "redirect",
        "virtual_state": "furfsky:gold"
      },
      "condition": {
        "type": "relative",
        "offset": "0:-1:0",
        "condition": {
          "type": "id",
          "block": "minecraft:netherrack"
        }
      }
    },
    {
      "type": "conditional",
      "definition": {
        "type": "redirect",
        "virtual_state": "furfsky:emerald"
      },
      "condition": {
        "type": "relative",
        "offset": "0:-1:0",
        "condition": {
          "type": "id",
          "block": "minecraft:deepslate"
        }
      }
    }
  ]
}

redstone_block.json

stone.json

{
  "type": "per_area",
  "entries": {
    "your_name_space:test": {
      "type": "random",
      "min": 0,
      "max": 20,
      "threshold": 15,
      "definition": {
        "type": "redirect",
        "virtual_state": "your_name_space:diamond"
      },
      "fallback": {
        "type": "redirect",
        "virtual_state": "your_name_space:gold"
      }
    }
  }
}

stone.json

equipment

diamond_.json

{
  "layers": {
    "horse_body": [
      {
        "texture": "minecraft:diamond"
      }
    ],
    "humanoid": [
      {
        "texture": "minecraft:iron_armor"
      }
    ],
    "humanoid_leggings": [
      {
        "texture": "minecraft:iron_armor"
      }
    ]
  }
}

diamond_.json

iron_armor.png

textures

entity

equipment_

humanoid

iron_armor.png

humanoid_leggings

iron_armor.png

skyblock

catharsis

armors

model.json

{
  "model": {
    "type": "catharsis:model",
    "model":"your_name_space:geo_models/iron_armor.geo.json",
    "layers": [
      "your_name_space:textures/iron_armor.png"
    ]
  },
  "part_visibility": {
    "head": false
  }
}

model.json

texture.json

{
  "model": {
    "type": "catharsis:texture",
    "layers": [
      "minecraft:textures/entity/equipment/humanoid_leggings/diamond.png"
    ]
  },
  "part_visibility": {
    "head": false
  }
}

texture.json

items

astraea.json

{
  "model": {
    "type": "minecraft:condition",
    "property": "catharsis:in_area",
    "area": "your_name_space:simple",
    "on_true": {
      "type": "minecraft:model",
      "model": "minecraft:block/green_wool"
    },
    "on_false": {
      "type": "minecraft:model",
      "model": "minecraft:block/red_wool"
    }
  }
}

astraea.json

your_name_space

catharsis

areas

always.json

{
  "type": "always"
}

always.json

multiple.json

{
  "type": "multiple",
  "boxes": [
    {
      "min": "-51:180:-134",
      "max": "-13:210:-96"
    },
    {
      "min": "42:180:-135",
      "max": "80:210:-97"
    }
  ],
  "islands": "dwarven_mines",
  "min_size": 16
}

multiple.json

on_island.json

{
  "type": "on_island",
  "islands": [
    "mining_1",
    "mining_2"
  ]
}

on_island.json

per_island.json

{
  "type": "per_island",
  "entries": [
    {
      "islands": "dwarven_mines",
      "type": "multiple",
      "boxes": [
        {
          "min": "-51:180:-134",
          "max": "-13:210:-96"
        },
        {
          "min": "42:180:-135",
          "max": "80:210:-97"
        }
      ]
    },
    {
      "islands": "mining_2",
      "type": "always"
    },
    {
      "islands": "mining_1",
      "type": "on_island"
    }
  ]
}

per_island.json

simple.json

{
  "type": "simple",
  "box": {
    "min": "-42:51:-183",
    "max": "-4:87:-145"
  },
  "islands": "hub"
}

simple.json

entity_definitions

graveyard_zombie.json

{
  "target": {
    "type": "all",
    "conditions": [
      {
        "type": "attribute",
        "attribute": "minecraft:max_health",
        "value": 100
      }
    ]
  },
  "type": "minecraft:zombie"
}

graveyard_zombie.json

timespans

is_day.json

{
  "type": "simple",
  "begin": 0,
  "end": 12000
}

is_day.json

is_night.json

{
  "type": "simple",
  "begin": 12000,
  "end": 24000
}

is_night.json

virtual_block_states

diamond.json

{
  "variants": {
    "": {
      "model": "minecraft:block/diamond_block"
    }
  },
  "overrides": {
    "minecraft:bedrock": {
      "variants": {
        "": {
          "model": "minecraft:block/gold_block"
        }
      }
    }
  },
  "blend": "translucent",
  "sounds": {
    "place_sound": "minecraft:block.chorus_flower.grow"
  }
}

diamond.json

emerald.json

{
  "variants": {
    "": {
      "model": "minecraft:block/emerald_block"
    }
  }
}

emerald.json

gold.json

{
  "variants": {
    "": {
      "model": "minecraft:block/gold_block"
    }
  }
}

gold.json

geo_models

iron_armor.geo.json

{
	"format_version": "1.21.0",
	"minecraft:geometry": [
		{
			"description": {
				"identifier": "geometry.steve",
				"texture_width": 64,
				"texture_height": 64,
				"visible_bounds_width": 6,
				"visible_bounds_height": 6,
				"visible_bounds_offset": [0, 2, 0]
			},
			"bones": [
				{
					"name": "left_leg",
					"pivot": [2, 12, 0],
					"cubes": [
						{
							"origin": [-0.1, 0, -2],
							"size": [4, 12, 4],
							"inflate": 0.275,
							"uv": {
								"north": {"uv": [52, 52], "uv_size": [4, 12]},
								"east": {"uv": [48, 52], "uv_size": [4, 12]},
								"south": {"uv": [60, 52], "uv_size": [4, 12]},
								"west": {"uv": [56, 52], "uv_size": [4, 12]},
								"up": {"uv": [52, 48], "uv_size": [4, 4]},
								"down": {"uv": [56, 52], "uv_size": [4, -4]}
							}
						},
						{
							"origin": [-0.5, 4.5, -2.5],
							"size": [5, 8, 5],
							"inflate": -0.2,
							"uv": {
								"north": {"uv": [54, 5], "uv_size": [-5, 8]},
								"east": {"uv": [59, 5], "uv_size": [-5, 8]},
								"south": {"uv": [64, 5], "uv_size": [-5, 8]},
								"west": {"uv": [49, 5], "uv_size": [-5, 8]},
								"up": {"uv": [54, 0], "uv_size": [-5, 5]},
								"down": {"uv": [59, 5], "uv_size": [-5, -5]}
							}
						}
					]
				},
				{
					"name": "right_leg",
					"pivot": [-2, 12, 0],
					"cubes": [
						{
							"origin": [-4.5, 4.5, -2.5],
							"size": [5, 8, 5],
							"inflate": -0.2,
							"uv": {
								"north": {"uv": [49, 5], "uv_size": [5, 8]},
								"east": {"uv": [44, 5], "uv_size": [5, 8]},
								"south": {"uv": [59, 5], "uv_size": [5, 8]},
								"west": {"uv": [54, 5], "uv_size": [5, 8]},
								"up": {"uv": [49, 0], "uv_size": [5, 5]},
								"down": {"uv": [54, 5], "uv_size": [5, -5]}
							}
						},
						{
							"origin": [-3.9, 0, -2],
							"size": [4, 12, 4],
							"inflate": 0.275,
							"uv": {
								"north": {"uv": [56, 52], "uv_size": [-4, 12]},
								"east": {"uv": [60, 52], "uv_size": [-4, 12]},
								"south": {"uv": [64, 52], "uv_size": [-4, 12]},
								"west": {"uv": [52, 52], "uv_size": [-4, 12]},
								"up": {"uv": [56, 48], "uv_size": [-4, 4]},
								"down": {"uv": [60, 52], "uv_size": [-4, -4]}
							}
						}
					]
				},
				{
					"name": "left_arm",
					"pivot": [5, 4, 0],
					"cubes": [
						{
							"origin": [4, 18.5, -2.5],
							"size": [5, 6, 5],
							"inflate": 0.1,
							"uv": {
								"north": {"uv": [30, 52], "uv_size": [-5, 6]},
								"east": {"uv": [35, 52], "uv_size": [-5, 6]},
								"south": {"uv": [38, 52], "uv_size": [-5, 6]},
								"west": {"uv": [25, 52], "uv_size": [-5, 6]},
								"up": {"uv": [30, 47], "uv_size": [-5, 5]},
								"down": {"uv": [35, 52], "uv_size": [-5, -5]}
							}
						}
					]
				},
				{
					"name": "right_arm",
					"pivot": [-5, 4, 0],
					"cubes": [
						{
							"origin": [-9, 18.5, -2.5],
							"size": [5, 6, 5],
							"inflate": 0.1,
							"uv": {
								"north": {"uv": [6, 52], "uv_size": [5, 6]},
								"east": {"uv": [0, 52], "uv_size": [5, 6]},
								"south": {"uv": [14, 52], "uv_size": [5, 6]},
								"west": {"uv": [10, 52], "uv_size": [5, 6]},
								"up": {"uv": [5, 47], "uv_size": [5, 5]},
								"down": {"uv": [10, 52], "uv_size": [5, -5]}
							}
						}
					]
				},
				{
					"name": "body",
					"pivot": [0, 0, 0],
					"cubes": [
						{
							"origin": [-4, 12, -2],
							"size": [8, 12, 4],
							"inflate": 0.35,
							"uv": {
								"north": {"uv": [44, 17], "uv_size": [8, 12]},
								"east": {"uv": [40, 17], "uv_size": [4, 12]},
								"south": {"uv": [56, 17], "uv_size": [8, 12]},
								"west": {"uv": [52, 17], "uv_size": [4, 12]},
								"up": {"uv": [44, 13], "uv_size": [8, 4]},
								"down": {"uv": [52, 17], "uv_size": [8, -4]}
							}
						},
						{
							"origin": [-4.5, 10.5, -2.5],
							"size": [9, 14, 5],
							"inflate": -0.1,
							"uv": {
								"north": {"uv": [5, 33], "uv_size": [9, 14]},
								"east": {"uv": [0, 33], "uv_size": [5, 14]},
								"south": {"uv": [19, 33], "uv_size": [9, 14]},
								"west": {"uv": [14, 33], "uv_size": [5, 14]},
								"up": {"uv": [5, 28], "uv_size": [9, 5]},
								"down": {"uv": [14, 33], "uv_size": [9, -5]}
							}
						}
					]
				},
				{
					"name": "head",
					"pivot": [0, 0, 0],
					"cubes": [
						{
							"origin": [-4, 23.5, -4],
							"size": [8, 9, 8],
							"inflate": 0.6,
							"uv": {
								"north": {"uv": [8, 8], "uv_size": [8, 9]},
								"east": {"uv": [0, 8], "uv_size": [8, 9]},
								"south": {"uv": [24, 8], "uv_size": [8, 9]},
								"west": {"uv": [16, 8], "uv_size": [8, 9]},
								"up": {"uv": [8, 0], "uv_size": [8, 8]},
								"down": {"uv": [16, 8], "uv_size": [8, -8]}
							}
						},
						{
							"origin": [-4.5, 28.6, -4.5],
							"size": [9, 2, 9],
							"inflate": 0.4,
							"uv": {
								"north": {"uv": [9, 26], "uv_size": [9, 2]},
								"east": {"uv": [0, 26], "uv_size": [9, 2]},
								"south": {"uv": [27, 26], "uv_size": [9, 2]},
								"west": {"uv": [18, 26], "uv_size": [9, 2]},
								"up": {"uv": [9, 17], "uv_size": [9, 9]},
								"down": {"uv": [18, 26], "uv_size": [9, -9]}
							}
						}
					]
				},
				{
					"name": "bone",
					"parent": "head",
					"pivot": [0, 0, 0],
					"rotation": [7.5, 0, 0],
					"cubes": [
						{
							"origin": [0, 28.2247, -0.5054],
							"size": [0, 21, 8],
							"inflate": 1,
							"pivot": [0, 32.7247, 3.4946],
							"rotation": [-45, 0, 0],
							"uv": {
								"north": {"uv": [13, 37], "uv_size": [0, 21]},
								"east": {"uv": [5, 37], "uv_size": [8, 21]},
								"south": {"uv": [21, 37], "uv_size": [0, 21]},
								"west": {"uv": [13, 37], "uv_size": [8, 21]},
								"up": {"uv": [13, 29], "uv_size": [0, 8]},
								"down": {"uv": [13, 37], "uv_size": [0, -8]}
							}
						}
					]
				}
			]
		}
	]
}

iron_armor.geo.json

textures

iron_armor.png

iron_leggings.png

pack.mcmeta

{
    "pack": {
        "pack_format": 46,
        "min_format": 46,
        "max_format": 69,
        "supported_formats": {
            "min_inclusive": 46,
            "max_inclusive": 69
        },
        "description": "Catharsis example pack"
    },
    "catharsis:pack/v1": {
        "id": "example_pack",
        "version": "1.0.0",
        "dependencies": {
            "catharsis": ">=1.0.0-beta.5"
        },
        "config": [
            {
                "type": "tab",
                "title": "Interesting Tab Title",
                "options": [
                    {
                        "type": "dropdown",
                        "id": "dropdown_example",
                        "title": "Example Dropdown Title",
                        "description": "An example dropdown description.",
                        "options": [
                            {
                                "value": "a",
                                "text": "Option A",
                                "default": true
                            },
                            {
                                "value": "b",
                                "text": "Option B"
                            },
                            {
                                "value": "c",
                                "text": "Option C"
                            }
                        ]
                    }
                ]
            },
            {
                "type": "separator",
                "title": "Separator Example",
                "description": "Can even have a description!"
            },
            {
                "type": "boolean",
                "id": "boolean_example",
                "title": "Example Boolean Title",
                "description": {
                    "text": "",
                    "extra": [
                        {
                            "text": "Can even have color, ",
                            "color": "red"
                        },
                        {
                            "text": "or not."
                        }
                    ]
                },
                "default": true
            }
        ]
    },
    "fabric:overlays": {
        "entries": [
            {
                "directory": "example_boolean_overlay",
                "condition": {
                    "condition": "catharsis:config",
                    "pack": "example_pack",
                    "id": "boolean_example"
                }
            },
            {
                "directory": "example_dropdown_a_overlay",
                "condition": {
                    "condition": "fabric:not",
                    "value": {
                        "condition": "catharsis:config",
                        "pack": "example_pack",
                        "id": "dropdown_example",
                        "value": "a"
                    }
                }
            },
            {
                "directory": "example_dropdown_b_overlay",
                "condition": {
                    "condition": "catharsis:config",
                    "pack": "example_pack",
                    "id": "dropdown_example",
                    "value": "b"
                }
            },
            {
                "directory": "example_dropdown_c_overlay",
                "condition": {
                    "condition": "catharsis:config",
                    "pack": "example_pack",
                    "id": "dropdown_example",
                    "value": "c"
                }
            }
        ]
    }
}

pack.mcmeta