Getting Started

Getting Started

📋 Requirements

• Server Platform: PaperMC 1.20.4 or higher (1.21+ recommended).
• Java: Java 21.
• Dependencies:
  • PacketEvents (Required for cross-version BlockDisplay rendering and interactive blueprints).
  • PlaceholderAPI (Optional, for variable support in messages).

---

🛠️ Installation

1. Download the latest MultiBlockEngine-Core.jar.
2. (Optional) Download any official addons you want, like mbe-wiring.jar or mbe-energy.jar.
3. Place all jars in your server's plugins folder.
4. Restart the server.
5. A default example example_portal.yml will be generated in plugins/MultiBlockEngine/multiblocks/.

---

🏗️ Your First Multiblock

Create a new file simple_tower.yml in the plugins/MultiBlockEngine/multiblocks/ folder:

id: simple_tower
version: "1.0"
display_name: "&eSimple Tower"

controller: DIAMOND_BLOCK

pattern:
  - offset: [0, -1, 0]
    match: GOLD_BLOCK
  - offset: [0, 1, 0]
    match: EMERALD_BLOCK

actions:
  on_interact:
    - type: message
      value: "&aYou touched the tower!"

Testing in-game:

1. Reload the plugin using the new Cloud command architecture: /mbe reload.
2. Build the structure in-game:
   • Gold Block (Bottom)
   • Diamond Block (Center/Controller)
   • Emerald Block (Top)
3. Right-click the Diamond Block with the configured assembly tool (or empty hand, depending on your config) to assemble the instance!