Getting Started

Quick Start

Get BloodlineCrates running on your Paper server in under five minutes.

Installation

BloodlineCrates requires a Paper 1.21 server. Drop the jar into your plugins folder and let it generate its config on first start.

Download the jar

Grab the latest release jar from the GitHub repository.

Place in plugins/

Copy the jar into your server's plugins/ directory.

Start the server once

Boot the server. BloodlineCrates will generate its default config and example crate file.

Stop and verify files

Stop the server and confirm these files exist.

Generated files

plugins/BloodlineCrates/config.yml
plugins/BloodlineCrates/crates/example.yml

First Run

Start the server again. Once it's online, run these commands to get the plugin fully initialized:

In-game console / chat

/bc reload
/bc editor

/bc reload vs /bc reloadcrates

/bc reload refreshes managers and the plugin config. /bc reloadcrates only refreshes crate files and reapplies cooldown definitions — useful during crate iteration without a full restart.

Test the Example Crate

BloodlineCrates ships with a working example crate. Use these commands to test the full opening flow right away:

Test the example crate

# Give yourself 5 keys for the example crate
/bc givekey example <yourname> 5

# Preview the crate without consuming a key
/bc preview example

# Open the crate
/bc open example

No placement needed for testing

The /bc open and /bc preview commands work without placing a crate block in the world — ideal for rapid iteration.

Build from Source

If you want to build the plugin yourself from the source repository, use the Gradle wrapper:

Build

./gradlew.bat build

The output jar will be at:

build/libs/

Deprecation warnings

The current build passes cleanly with 2 pre-existing deprecation warnings in GUIManager and BroadcastManager. These do not affect functionality.

← Overview Next: Create Crates →