Plugins / CrateForge

Soft Dependencies

Soft Dependencies

CrateForge integrates with several popular plugins to enhance crate appearances and functionality. All of these are optional — CrateForge works perfectly without any of them.

Overview

ItemsAdder

ItemsAdder allows you to use custom item models (from a resource pack) for crate keys and prize items.

How It Integrates

When ItemsAdder is installed, you can reference custom items by their ItemsAdder namespace in crate and key configs:

# keys/legendary_key.yml — Using an ItemsAdder item
material: TRIPWIRE_HOOK        # Fallback material
itemsadder-item: "mypack:legendary_key"   # ItemsAdder namespace:id
glow: true

# crates/legendary.yml — ItemsAdder item as a prize
prizes:
  - id: custom_sword
    display-name: "<red>Dragon Slayer"
    material: DIAMOND_SWORD    # Fallback
    itemsadder-item: "mypack:dragon_slayer"
    weight: 5
    rarity: LEGENDARY
    rewards:
      - type: ITEM

Setup

1. Install ItemsAdder 3.6+
2. Define your custom items in ItemsAdder's config
3. Reference them in CrateForge configs using itemsadder-item: "namespace:id"

Note: If ItemsAdder is not installed, CrateForge will fall back to the material field automatically.

Oraxen

Oraxen is an alternative to ItemsAdder for custom item models. CrateForge supports both — you can use either one (or both simultaneously).

How It Integrates

# keys/legendary_key.yml — Using an Oraxen item
material: TRIPWIRE_HOOK
oraxen-item: "legendary_key"   # Oraxen item ID
glow: true

# crates/legendary.yml — Oraxen prize item
prizes:
  - id: custom_helmet
    display-name: "<gold>Dragon Helmet"
    material: DIAMOND_HELMET
    oraxen-item: "dragon_helmet"
    weight: 2
    rarity: LEGENDARY
    rewards:
      - type: ITEM

Setup

1. Install Oraxen 1.x
2. Define your custom items in Oraxen
3. Reference them with oraxen-item: "item_id"

Tip: If both ItemsAdder and Oraxen are installed, itemsadder-item takes priority over oraxen-item. Use whichever system your server uses.

ModelEngine

ModelEngine allows CrateForge to display animated 3D models on physical crates placed in the world.

How It Integrates

Instead of a static block, placed crates can display a fully animated 3D model (e.g., a spinning treasure chest with a particle halo).

# config.yml — ModelEngine configuration
model-engine:
  enabled: true
  default-model: "crate_default"   # ModelEngine model ID used for crates without a custom model

Per-crate model override:

# crates/legendary.yml
model-engine-model: "legendary_crate"   # Overrides the default model for this crate

Setup

1. Install ModelEngine R4+
2. Create or import a crate model in ModelEngine
3. Enable ModelEngine integration in config.yml
4. Optionally set per-crate models

Note: Without ModelEngine, crates are displayed as their configured material (e.g., CHEST). ModelEngine is purely cosmetic.

DecentHolograms

DecentHolograms adds floating text above placed crates, displaying the crate name and optionally other information.

How It Integrates

When a crate is placed with /cf set, CrateForge automatically creates a hologram above it showing: - Crate display name (with MiniMessage formatting) - Required key (optional) - Prize count (optional)

# config.yml — Hologram configuration
holograms:
  enabled: true
  backend: DECENT_HOLOGRAMS   # or CMI
  lines:
    - "{crate_name}"
    - "<gray>Right-click with key to open"
  offset-y: 1.5               # Height above the crate block

Setup

1. Install DecentHolograms 2.8+
2. Set holograms.backend: DECENT_HOLOGRAMS in config.yml
3. Holograms appear automatically when crates are placed

CMI

CMI is an all-in-one server management plugin that includes its own hologram system. CrateForge can use CMI holograms as an alternative to DecentHolograms.

How It Integrates

# config.yml — Use CMI as hologram backend
holograms:
  enabled: true
  backend: CMI
  lines:
    - "{crate_name}"
    - "<gray>Right-click with key to open"
  offset-y: 1.5

Setup

1. Install CMI 9.x with hologram support enabled
2. Set holograms.backend: CMI in config.yml

Note: You can only have one hologram backend active at a time. If both DecentHolograms and CMI are installed, the backend setting determines which is used.

Dependency Detection

CrateForge automatically detects which soft dependencies are installed on startup:

[CrateForge] ItemsAdder: FOUND ✓
[CrateForge] Oraxen: NOT FOUND (optional)
[CrateForge] ModelEngine: FOUND ✓
[CrateForge] DecentHolograms: FOUND ✓
[CrateForge] CMI: NOT FOUND (optional)

Only detected integrations will be activated.

Navigation

Home | Crate Format | Key Format | Installation