Example Configurations

Example Configurations

This page provides complete configuration examples for setting up the Relic system on your server using Filament behaviours.

File Structure

config/
└── relic/
    └── config.json (Main mod configuration)

data/
└── <namespace>/
    └── filament/
        └── item/
            ├── relic_catalysts/
            │   ├── common_catalyst.json
            │   ├── rare_catalyst.json
            │   ├── epic_catalyst.json
            │   └── legendary_catalyst.json
            ├── identification_lens.json
            ├── inscriptions/
            │   ├── keen_edge.json
            │   ├── vampiric_strike.json
            │   ├── vein_miner.json
            │   └── ...
            └── ...

Filament Integration

Relic uses Filament for all content. Catalysts, identification lenses, inscriptions, and relic templates are all Filament item behaviours in data packs. Only core mod settings (renown sources, socket unlocks, etc.) are in the config file.

---

Main Configuration

File: config/relic/config.json

This is the core configuration file that controls the entire Relic system.

Full Config

{
  "enabled": true,
  "debug_mode": false,

  "renown_sources": {
    "block_break": {
      "enabled": true,
      "base_renown": 1,
      "multipliers": {
        "c:ores": 3.0,
        "c:rare_ores": 5.0,
        "minecraft:ancient_debris": 10.0
      }
    },
    "entity_kill": {
      "enabled": true,
      "base_renown": 5,
      "multipliers": {
        "minecraft:player": 20.0,
        "minecraft:ender_dragon": 500.0,
        "minecraft:wither": 300.0,
        "cobblemon:legendary": 100.0
      }
    },
    "crop_harvest": {
      "enabled": true,
      "base_renown": 2
    },
    "fishing_catch": {
      "enabled": true,
      "base_renown": 3,
      "treasure_multiplier": 5.0
    },
    "player_damage_taken": {
      "enabled": true,
      "renown_per_heart": 2
    }
  },

  "essence_capacity": {
    "wooden": 5,
    "stone": 8,
    "iron": 12,
    "golden": 10,
    "diamond": 15,
    "netherite": 20,
    "custom": {
      "cobblemon:masterball": 25
    }
  },

  "socket_unlocks": [
    { "level": 5, "sockets": 1 },
    { "level": 15, "sockets": 2 },
    { "level": 30, "sockets": 3 },
    { "level": 50, "sockets": 4 },
    { "level": 75, "sockets": 5 }
  ],

  "level_curve": {
    "type": "exponential",
    "base_renown": 100,
    "exponent": 1.15,
    "max_level": 100
  },

  "inscription_management": {
    "removal_cost_type": "none",
    "swap_cooldown_seconds": 0,
    "destroy_on_removal": false
  },

  "relic_properties": {
    "allow_trading": true,
    "reset_on_trade": false,
    "bind_on_awaken": false,
    "invulnerable": false,
    "lose_renown_on_death": false,
    "death_renown_penalty_percent": 0
  },

  "gui": {
    "show_renown_bar": true,
    "show_level_up_particles": true,
    "socket_unlock_sound": "minecraft:block.anvil.use"
  }
}

Explained

Key Sections

Relic Catalyst

• item: What item is used to awaken a relic
• consume_on_use: Whether the catalyst is consumed
• cooldown_seconds: Cooldown between awakenings

Renown Sources Configure how different actions grant Renown (XP):

• Base values for common actions
• Multipliers for special blocks/entities
• Enable/disable individual sources

Essence Capacity Maximum essence each material tier can hold:

• Vanilla materials (wooden → netherite)
• Custom items (like Cobblemon items)

Socket Unlocks Define at which levels sockets unlock:

• level: Relic level required
• sockets: Total sockets at this level

Level Curve

• type: “linear” or “exponential”
• base_renown: Starting renown requirement
• exponent: Growth rate (exponential only)
• max_level: Level cap

Inscription Management

• removal_cost_type: “none”, “currency”, “item”
• swap_cooldown_seconds: Time between changes
• destroy_on_removal: Lose inscription when removed

Relic Properties

• Trading, binding, death penalties
• Invulnerability settings

---

Inscription Behaviours

Inscriptions are defined as Filament behaviours in data packs. Each inscription is a separate JSON file under data/<namespace>/filament/relic/inscriptions/.

Combat Inscriptions

Keen Edge (Basic Damage)

File: data/myserver/filament/item/inscriptions/keen_edge.json

{
  "type": "relic:inscription",
  "data": {
    "name": "Keen Edge",
    "description": "Sharpens the blade, increasing damage",
    "essence_cost": 2,
    "category": "combat",
    "tier": "common",
    "compatible_items": ["sword", "axe"],
    "effects": {
      "attribute_modifiers": [
        {
          "attribute": "generic.attack_damage",
          "value": 2.0,
          "operation": "ADD"
        }
      ]
    }
  }
}

Vampiric Strike (Lifesteal)

File: data/myserver/filament/item/inscriptions/vampiric_strike.json

{
  "type": "relic:inscription",
  "data": {
    "name": "Vampiric Strike",
    "description": "Heal for 20% of damage dealt",
    "essence_cost": 5,
    "category": "combat",
    "tier": "rare",
    "compatible_items": ["sword", "axe"],
    "effects": {
      "on_entity_hit": {
        "conditions": ["return true;"],
        "scripts": [
          "q.player.heal(q.damage.dealt * 0.2);"
        ],
        "particles": {
          "type": "minecraft:heart",
          "count": 3,
          "spread": [0.3, 0.3, 0.3]
        }
      }
    }
  }
}

Flamestrike (Fire Proc)

File: data/myserver/filament/item/inscriptions/flamestrike.json

{
  "type": "relic:inscription",
  "data": {
    "name": "Flamestrike",
    "description": "25% chance to ignite enemies on hit",
    "essence_cost": 4,
    "category": "combat",
    "tier": "uncommon",
    "compatible_items": ["sword"],
    "effects": {
      "on_entity_hit": {
        "conditions": ["return math.random() < 0.25;"],
        "scripts": [
          "q.target.set_on_fire(5);"
        ],
        "commands": [
          "/particle minecraft:flame ~ ~1 ~ 0.3 0.3 0.3 0.1 20"
        ]
      }
    }
  }
}

Chain Lightning (Legendary AoE)

File: data/myserver/filament/item/inscriptions/chain_lightning.json

{
  "type": "relic:inscription",
  "data": {
    "name": "Chain Lightning",
    "description": "Critical hits chain lightning to nearby enemies",
    "essence_cost": 8,
    "category": "combat",
    "tier": "legendary",
    "compatible_items": ["sword"],
    "unlock_requirement": {
      "relic_level": 50
    },
    "effects": {
      "on_entity_hit": {
        "conditions": [
          "return q.attack.is_critical;"
        ],
        "scripts": [
          "q.entity.chain_damage_nearby(5.0, 3.0, 5);"
        ],
        "commands": [
          "/particle minecraft:electric_spark ~ ~1 ~ 2 1 2 0.5 50"
        ]
      }
    }
  }
}

Efficiency Inscriptions

Swift Mining (Speed Boost)

File: data/myserver/filament/relic/inscriptions/swift_mining.json

{
  "type": "relic:inscription",
  "data": {
    "name": "Swift Mining",
    "description": "Increases mining speed",
    "essence_cost": 3,
    "category": "efficiency",
    "tier": "common",
    "compatible_items": ["pickaxe", "shovel", "axe"],
    "effects": {
      "attribute_modifiers": [
        {
          "attribute": "player.block_break_speed",
          "value": 0.25,
          "operation": "MULTIPLY"
        }
      ]
    }
  }
}

Vein Miner (Ore Veins)

File: data/myserver/filament/item/inscriptions/vein_miner.json

{
  "type": "relic:inscription",
  "data": {
    "name": "Vein Miner",
    "description": "Automatically mines ore veins",
    "essence_cost": 6,
    "category": "efficiency",
    "tier": "epic",
    "compatible_items": ["pickaxe"],
    "effects": {
      "on_block_break": {
        "conditions": ["q.block.has_tag('c:ores');"],
        "scripts": [
          "q.block.break_connected_same_type(16, true);"
        ]
      }
    }
  }
}

Auto-Smelt

File: data/myserver/filament/item/inscriptions/auto_smelt.json

{
  "type": "relic:inscription",
  "data": {
    "name": "Auto-Smelt",
    "description": "Automatically smelts broken blocks",
    "essence_cost": 4,
    "category": "efficiency",
    "tier": "rare",
    "compatible_items": ["pickaxe"],
    "effects": {
      "on_block_break": {
        "conditions": ["return q.block.has_smelting_recipe();"],
        "scripts": [
          "q.block.drop_smelted_result();"
        ],
        "particles": {
          "type": "minecraft:flame",
          "count": 5,
          "spread": [0.5, 0.5, 0.5]
        }
      }
    }
  }
}

Utility Inscriptions

Fortune Glyph

File: data/myserver/filament/item/inscriptions/fortune_glyph.json

{
  "type": "relic:inscription",
  "data": {
    "name": "Fortune Glyph",
    "description": "Increases drop multiplier",
    "essence_cost": 5,
    "category": "utility",
    "tier": "rare",
    "compatible_items": ["pickaxe", "axe", "shovel"],
    "effects": {
      "enchantment_boost": {
        "enchantment": "minecraft:fortune",
        "levels": 1
      }
    }
  }
}

Magnetic Pull

File: data/myserver/filament/item/inscriptions/magnetic_pull.json

{
  "type": "relic:inscription",
  "data": {
    "name": "Magnetic Pull",
    "description": "Attracts nearby items",
    "essence_cost": 3,
    "category": "utility",
    "tier": "uncommon",
    "compatible_items": ["all"],
    "effects": {
      "passive": {
        "tick_rate": 20,
        "scripts": [
          "q.player.attract_items_nearby(8.0);"
        ]
      }
    }
  }
}

Extended Reach

File: data/myserver/filament/item/inscriptions/extended_reach.json

{
  "type": "relic:inscription",
  "data": {
    "name": "Extended Reach",
    "description": "Increases block reach distance",
    "essence_cost": 4,
    "category": "utility",
    "tier": "uncommon",
    "compatible_items": ["all"],
    "effects": {
      "attribute_modifiers": [
        {
          "attribute": "player.block_interaction_range",
          "value": 2.0,
          "operation": "ADD"
        }
      ]
    }
  }
}

---

Catalyst Behaviours

Relic Catalysts are Filament behaviours that define catalyst types with stat ranges and modifiers.

Common Catalyst

File: data/myserver/filament/item/relic_catalysts/common_catalyst.json

{
  "type": "relic:catalyst",
  "data": {
    "base_item": "minecraft:echo_shard",
    "name_unidentified": "<gray>Mysterious Relic Catalyst",
    "name_format": "<white>{name} Relic Catalyst",
    "lore_unidentified": [
      "<gray>Right-click with an Identification Lens",
      "<gray>to reveal its properties"
    ],

    "essence_range": {
      "min": 10,
      "max": 15
    },

    "modifiers": {
      "inscription_boost": {
        "chance": 0.0,
        "options": []
      },
      "pre_installed": {
        "chance": 0.0,
        "options": []
      },
      "bonus_sockets": {
        "chance": 0.0,
        "amount": 0
      },
      "renown_multiplier": {
        "chance": 0.0,
        "range": [1.0, 1.0]
      }
    }
  }
}

Rare Catalyst

File: data/myserver/filament/item/relic_catalysts/rare_catalyst.json

{
  "type": "relic:catalyst",
  "data": {
    "base_item": "minecraft:echo_shard",
    "name_unidentified": "<gray>Mysterious Relic Catalyst",
    "name_format": "<aqua>{name} Relic Catalyst",
    "lore_unidentified": [
      "<gray>Right-click with an Identification Lens",
      "<gray>to reveal its properties"
    ],

    "essence_range": {
      "min": 15,
      "max": 20
    },

    "modifiers": {
      "inscription_boost": {
        "chance": 0.20,
        "options": [
          {
            "category": "mining",
            "reduction": 1,
            "weight": 1
          },
          {
            "category": "combat",
            "reduction": 1,
            "weight": 1
          }
        ]
      },
      "pre_installed": {
        "chance": 0.05,
        "options": [
          {
            "inscription": "swift_mining",
            "weight": 1
          }
        ]
      },
      "bonus_sockets": {
        "chance": 0.0,
        "amount": 0
      },
      "renown_multiplier": {
        "chance": 0.10,
        "range": [1.1, 1.15]
      }
    }
  }
}

Epic Catalyst

File: data/myserver/filament/item/relic_catalysts/epic_catalyst.json

{
  "type": "relic:catalyst",
  "data": {
    "base_item": "minecraft:echo_shard",
    "name_unidentified": "<gray>Mysterious Relic Catalyst",
    "name_format": "<light_purple>{name} Relic Catalyst",

    "essence_range": {
      "min": 18,
      "max": 25
    },

    "modifiers": {
      "inscription_boost": {
        "chance": 0.50,
        "options": [
          {
            "category": "mining",
            "reduction": 2,
            "weight": 1
          },
          {
            "category": "combat",
            "reduction": 2,
            "weight": 1
          },
          {
            "category": "utility",
            "reduction": 1,
            "weight": 1
          }
        ],
        "max_modifiers": 2
      },
      "pre_installed": {
        "chance": 0.10,
        "options": [
          {
            "inscription": "swift_mining",
            "weight": 2
          },
          {
            "inscription": "fortune_glyph",
            "weight": 1
          }
        ]
      },
      "bonus_sockets": {
        "chance": 0.05,
        "amount": 1
      },
      "renown_multiplier": {
        "chance": 0.20,
        "range": [1.15, 1.25]
      }
    }
  }
}

Legendary Catalyst

File: data/myserver/filament/item/relic_catalysts/legendary_catalyst.json

{
  "type": "relic:catalyst",
  "data": {
    "base_item": "minecraft:nether_star",
    "name_unidentified": "<gray>Mysterious Legendary Catalyst",
    "name_format": "<gold>{name} Relic Catalyst",

    "essence_range": {
      "min": 22,
      "max": 30
    },

    "modifiers": {
      "inscription_boost": {
        "chance": 1.0,
        "options": [
          {
            "category": "mining",
            "reduction": 3,
            "weight": 1
          },
          {
            "category": "combat",
            "reduction": 3,
            "weight": 1
          },
          {
            "category": "utility",
            "reduction": 2,
            "weight": 1
          }
        ],
        "min_modifiers": 2,
        "max_modifiers": 3
      },
      "pre_installed": {
        "chance": 0.25,
        "options": [
          {
            "inscription": "vein_miner",
            "weight": 1
          },
          {
            "inscription": "fortune_glyph",
            "weight": 1
          },
          {
            "inscription": "chain_lightning",
            "weight": 1
          }
        ]
      },
      "bonus_sockets": {
        "chance": 0.15,
        "amount": 1
      },
      "renown_multiplier": {
        "chance": 0.50,
        "range": [1.25, 1.5]
      }
    }
  }
}

---

Identification Lens

File: data/myserver/filament/item/identification_lens.json

The Identification Lens reveals hidden stats on catalysts and relics.

{
  "type": "relic:identification_lens",
  "data": {
    "base_item": "minecraft:spyglass",
    "name": "<aqua>Identification Lens",
    "lore": [
      "<gray>Right-click a catalyst or relic",
      "<gray>to reveal its hidden properties",
      "",
      "<yellow>Consumed on use"
    ],
    "consume_on_use": true,
    "particle_effect": {
      "type": "minecraft:enchant",
      "count": 20
    },
    "sound": "minecraft:block.enchantment_table.use"
  }
}

Behavior:

• Right-click while holding an unidentified catalyst → Reveals stats, updates name/lore
• Right-click while holding an awakened relic → Shows catalyst roll that created it
• Consumed on use
• Cannot identify already-identified catalysts

---

Relic Behaviours

Pre-configured relics can be defined as Filament behaviours. These can be given to players or used as templates.

Excavator’s Legacy (Legendary Pickaxe)

File: data/myserver/filament/relic/relics/excavators_legacy.json

{
  "type": "relic:relic_template",
  "data": {
    "base_item": "minecraft:netherite_pickaxe",
    "name": "Excavator's Legacy",
    "lore": [
      "§7A tool wielded by legendary miners",
      "§7of ages past.",
      "",
      "§6Legendary Relic"
    ],
    "essence_capacity": 25,
    "starting_level": 1,
    "starting_renown": 0,
    "starting_inscriptions": [
      "swift_mining",
      "fortune_glyph"
    ],
    "max_level": 100,
    "custom_model_data": 1000
  }
}

Blade of the Fallen (Legendary Sword)

File: data/myserver/filament/relic/relics/blade_of_the_fallen.json

{
  "type": "relic:relic_template",
  "data": {
    "base_item": "minecraft:netherite_sword",
    "name": "Blade of the Fallen",
    "lore": [
      "§7Forged from the essence of",
      "§7a thousand battles.",
      "",
      "§6Legendary Relic"
    ],
    "essence_capacity": 30,
    "starting_level": 10,
    "starting_renown": 5000,
    "starting_inscriptions": [
      "keen_edge",
      "vampiric_strike",
      "flamestrike"
    ],
    "locked_inscriptions": true,
    "max_level": 100,
    "custom_model_data": 1001
  }
}

Farmer’s Blessing (Uncommon Hoe)

File: data/myserver/filament/relic/relics/farmers_blessing.json

{
  "type": "relic:relic_template",
  "data": {
    "base_item": "minecraft:netherite_hoe",
    "name": "Farmer's Blessing",
    "lore": [
      "§7Blessed by ancient harvest spirits",
      "",
      "§aUncommon Relic"
    ],
    "essence_capacity": 15,
    "starting_level": 5,
    "starting_inscriptions": [
      "auto_replant",
      "crop_fortune"
    ],
    "max_level": 50,
    "custom_model_data": 1002
  }
}

---

Quick Start Configurations

Minimal Setup (Testing)

A minimal configuration for testing the system:

{
  "enabled": true,
  "relic_catalyst": {
    "item": "minecraft:stick",
    "consume_on_use": false
  },
  "renown_sources": {
    "block_break": {
      "enabled": true,
      "base_renown": 10
    }
  },
  "essence_capacity": {
    "wooden": 20,
    "stone": 20,
    "iron": 20,
    "diamond": 20,
    "netherite": 20
  },
  "socket_unlocks": [
    { "level": 1, "sockets": 5 }
  ],
  "level_curve": {
    "type": "linear",
    "base_renown": 100
  }
}

Hardcore Server Setup

Stricter progression for hardcore servers:

{
  "enabled": true,
  "relic_catalyst": {
    "item": "minecraft:nether_star",
    "consume_on_use": true,
    "cooldown_seconds": 86400
  },
  "renown_sources": {
    "block_break": {
      "enabled": true,
      "base_renown": 1,
      "multipliers": {
        "c:ores": 2.0
      }
    },
    "entity_kill": {
      "enabled": true,
      "base_renown": 3
    }
  },
  "essence_capacity": {
    "netherite": 15
  },
  "socket_unlocks": [
    { "level": 10, "sockets": 1 },
    { "level": 30, "sockets": 2 },
    { "level": 60, "sockets": 3 },
    { "level": 100, "sockets": 4 }
  ],
  "level_curve": {
    "type": "exponential",
    "base_renown": 200,
    "exponent": 1.25,
    "max_level": 100
  },
  "inscription_management": {
    "removal_cost_type": "currency",
    "removal_cost_amount": 10000,
    "destroy_on_removal": true
  },
  "relic_properties": {
    "allow_trading": false,
    "bind_on_awaken": true,
    "lose_renown_on_death": true,
    "death_renown_penalty_percent": 25
  }
}

RPG Server Setup

Balanced for RPG-style progression:

{
  "enabled": true,
  "relic_catalyst": {
    "item": "minecraft:echo_shard",
    "consume_on_use": true
  },
  "renown_sources": {
    "block_break": {
      "enabled": true,
      "base_renown": 2,
      "multipliers": {
        "c:ores": 5.0,
        "minecraft:ancient_debris": 20.0
      }
    },
    "entity_kill": {
      "enabled": true,
      "base_renown": 10,
      "multipliers": {
        "minecraft:ender_dragon": 1000.0,
        "minecraft:wither": 500.0,
        "cobblemon:legendary": 200.0
      }
    }
  },
  "socket_unlocks": [
    { "level": 5, "sockets": 1 },
    { "level": 15, "sockets": 2 },
    { "level": 30, "sockets": 3 },
    { "level": 50, "sockets": 4 }
  ],
  "level_curve": {
    "type": "exponential",
    "base_renown": 100,
    "exponent": 1.15,
    "max_level": 100
  },
  "inscription_management": {
    "removal_cost_type": "item",
    "removal_cost_item": "minecraft:lapis_lazuli",
    "removal_cost_amount": 16,
    "destroy_on_removal": false
  },
  "relic_properties": {
    "allow_trading": true,
    "reset_on_trade": true,
    "invulnerable": true
  }
}

---

Integration Examples

Journey Integration

Unlock inscriptions through Journey tasks:

{
  "id": "legendary_strike",
  "name": "Legendary Strike",
  "description": "Unlocked by defeating the Elite Four",
  "essence_cost": 10,
  "category": "combat",
  "tier": "legendary",
  "unlock_requirement": {
    "type": "journey_task",
    "task_id": "elite_four_complete"
  },
  "effects": {
    "attribute_modifiers": [
      {
        "attribute": "generic.attack_damage",
        "value": 5.0,
        "operation": "ADD"
      }
    ]
  }
}

---

Command Reference

Admin Commands

# Give a relic catalyst
/give @p minecraft:nether_star{relic_catalyst:true}

# Give a pre-configured legendary relic
/relic give @p excavators_legacy

# Set a player's relic level
/relic level set @p 50

# Add renown to held relic
/relic renown add @p 1000

# Give inscription scroll to player
/relic inscription give @p keen_edge

# Reload configurations
/relic reload

Player Commands

# Open inscription GUI
/relic gui

# View relic stats
/relic stats

# View available inscriptions
/relic inscriptions

---

Performance Tuning

For large servers, optimize performance with these settings:

{
  "performance": {
    "max_relics_per_player": 5,
    "cache_relic_data": true,
    "async_renown_calculation": true,
    "batch_renown_updates": true,
    "update_interval_ticks": 20,
    "disable_particles_below_tps": 15
  },

  "limits": {
    "max_script_execution_time_ms": 100,
    "max_chain_targets": 5,
    "max_vein_mine_blocks": 24
  }
}