Skip to content

Installation


Requirements

ThingVersion / Notes
Server softwarePaper 1.21+ (Paper is required — it uses Paper APIs). Tested on 1.21.4–1.21.11.
JavaJava 21 or newer.
packeteventsRequired. Powers the spectator camera freeze that makes the cursor menu work.
ItemsAdderStrongly recommended. Provides the button images, cursor image, crate icons, and reward models (glyphs). Without it the menu shows empty boxes (□).
VaultRequired only if a crate costs MONEY. Also needs an economy plugin (e.g. EssentialsX Economy).
Nexo / OraxenOptional. Alternative custom-item providers for rewards/icons.
BetterModel / ModelEngineOptional. For a 3D model animation before cards appear.

All optional plugins are loaded by reflection — if they are missing, CradGacha still starts.

Step 1 — Install the dependencies

Put these in your plugins/ folder first and start the server once so they generate their files:

  • packetevents (required)
  • ItemsAdder (recommended)
  • Vault + an economy plugin (only if you use MONEY cost)

Step 2 — Install CradGacha

  1. Download or build CradGacha-1.0.0.jar.
    • To build from source: run ./gradlew build and find the jar in build/libs/.
  2. Copy the jar into your server's plugins/ folder.

Step 3 — Restart the server

Use a full restart, not just /reload:

  • In your server console, type stop, then start the server again.
  • Or use your host panel's Restart button.

On startup you should see a log line like:

[CradGacha] CradGacha enabled! Loaded 3 crate(s).
[CradGacha] Integrations -> ItemsAdder: found | ... | packetevents: found

Step 4 — Verify

In game (as an operator), run:

/gacha doctor

Every line should show a green ✓. If something shows a red ✗, the message tells you how to fix it. See Troubleshooting for details.

Then open the menu:

/gacha

A note on the resource pack

The button/cursor images and reward models come from ItemsAdder. After you add or change any images, run ItemsAdder's commands so it rebuilds the pack:

/iazip
/iareload

If you use Nexo or Oraxen items (e.g. as rewards or cost), rebuild their pack with that plugin's own command after adding/changing items:

/nexo reload pack      # Nexo  (or /nexo reload for everything)
/oraxen reload pack    # Oraxen (or /oraxen reload all)

Players must accept the server resource pack when they join, or the menu will show as empty boxes (□). CradGacha warns a player who declined the pack.


Next: First Setup →