Skip to content
DarkBladeDev Docs

Installation and First Steps

This guide walks administrators through installing CraftingEngine on Minecraft servers running Paper, Purpur, or compatible 1.20+ server software.

1. System & Server Requirements

Before installing CraftingEngine, ensure your server environment meets the following specifications:

  • Java Runtime: Java 21 or higher (LTS).
  • Server Platform: Paper, Purpur, or compatible forks running Minecraft 1.20.4 through 1.21.x (tested on 1.21.4).
  • Networking / Packet Engine: PacketEvents v2.14.0+ (required for virtual ghost previews and client-side packet animations).
  • Optional Integrations:
    • Custom Item Plugins: ItemsAdder, Oraxen, MMOItems, ExecutableItems, MythicMobs.
    • Placeholders & Variables: PlaceholderAPI.
    • Economy: Vault.

2. Installation Steps

  1. Download the Jar: Obtain the latest CraftingEngine-2.9.0.jar release.
  2. Deploy to Server: Place the JAR into your server’s plugins/ directory.
  3. Ensure PacketEvents: If not already present, install PacketEvents into plugins/.
  4. Start the Server: Launch your Minecraft server. CraftingEngine will generate its default directory tree:
plugins/CraftingEngine/
├── config.yml              # Global settings, ticker rate, and language
├── capabilities/           # Modular station capability definitions
├── lang/                   # Language bundles (en_US.yml, es_ES.yml)
├── menus/                  # 9xN GUI matrix templates (browser & progress)
├── presets/
│   ├── holograms/          # Floating TextDisplay presets
│   └── placements/         # 3D Display Entity placement presets
├── processes/              # Process blueprints & recipes
└── stations/               # Workstation definitions (single-block & multiblocks)
  1. Verify Startup Logs: Confirm that the console indicates successful initialization:
[CraftingEngine] Initializing CraftingEngine...
[CraftingEngine] Loaded 10 capability definition(s).
[CraftingEngine] Loaded 3 workstation definition(s).
[CraftingEngine] Loaded 2 GUI menu template(s).
[CraftingEngine] Loaded 5 process definition(s).
[CraftingEngine] CraftingEngine successfully enabled & ticking (interval: 1 tick(s)).

3. First Verification Commands

Once in-game or via the console, run the status and version commands:

Ventana de terminal
/cfe version
/cfe status

The output will confirm:

  • Engine and API versions (v2.9.0).
  • Count of loaded capabilities, stations, blueprints, menus, and presets.
  • Scheduler ticker state (RUNNING at 20 TPS).

4. Exploring Default Workstations & Blueprints

CraftingEngine generates pre-built workstations and blueprints to showcase its capabilities:

  1. Single-Block Station (stations/blacksmith_anvil.yml):
    • Standard anvil block providing forging and heating capabilities.
    • Right-clicking opens the process browser GUI (menus/process_browser.yml).
  2. 3D Multiblock Station (stations/example_runic_forge.yml):
    • 3D voxel structure featuring an anvil core surrounded by stone bricks, magma blocks, lava sources, iron bars, and soul lanterns.
    • Supports 4-way cardinal rotation and PacketEvents virtual ghost previews.
  3. Interactive Manual Crafting (processes/manual_iron_blade.yml):
    • Place 2 hot iron ingots on an anvil and strike the anvil 5 times with a pickaxe or hammer.
    • Watch the 3D model transform and progress bars update in real time.

5. Hot-Reloading

CraftingEngine supports full live reloading without restarting your server or interrupting ongoing player crafts. Make changes to any configuration, station, or blueprint, then execute:

Ventana de terminal
/cfe reload all

You can also reload individual subsystems:

  • /cfe reload config - Global settings and language.
  • /cfe reload processes - Blueprints and recipe logic.
  • /cfe reload stations - Single-block and multiblock structures.
  • /cfe reload menus - 9xN inventory matrix layouts.

Next Steps