Skip to content
Dashboard
Browse & search guides
All guides

Game server & delivery

Install the Paper plugin, check contact status and test delivery.

Install Craftly for Paper0% read

Install Craftly for Paper

  1. Use a Paper server on Minecraft 1.16.5 or newer, running Java 11 or newer (Java 11 to 21 are supported; newer Minecraft versions need newer Java themselves). Download craftly-paper.jar from Dashboard → Game server.
  2. Put the jar in the server’s plugins folder and start the server once.
  3. Edit plugins/Craftly/config.yml. Copy your private plugin key from Game server into the secret field. The plugin connects directly to craftly.one.
  4. Run /craftly reload, then /craftly status. Use /craftly check to request an immediate delivery check.
secret: "<your plugin key>"

The plugin is linked to https://craftly.one and has no configurable service URL. Keep the plugin key private. Regenerating it stops deliveries until the server configuration is updated. From version 0.4.0 the plugin checks craftly.one for a newer version on start and every 6 hours, and prints the new version and its download link in the console (and in /craftly status). To update, replace craftly-paper.jar and restart the server. Set check-updates: false in config.yml to turn the check off.

Read the connection indicator

The dashboard refreshes this status every 30 seconds while visible. This measures authenticated contact with Craftly, not the game server’s player-count ping. An invalid plugin key does not update it.

StatusMeaning
ConnectedAn authenticated plugin request reached this store within the last two minutes.
No recent contactThe store has received a valid request before, but not in the last two minutes.
Waiting for first contactNo request with the current key has reached the store yet.

Send a test payment

Test payments move no money and do not count toward revenue or the community goal. They test game delivery, separately from Stripe test mode and PayPal sandbox.

  1. Create a package with at least one delivery action.
  2. In Game server → Send a test payment, choose the package and quantity, Java or Bedrock, and your own Minecraft username or gamertag.
  3. Send the test, then check the game server. Join if an action requires the player to be online.
  4. Check the delivery queue and payment details to confirm the result.

Delivery behavior

The plugin polls for paid, queued orders. It replaces the buyer placeholder, runs ready commands and acknowledges completed orders. Player commands use the player’s permissions; console commands use the server’s.

Keep plugins/Craftly/commands.txt and delivered.txt across restarts. They record completed work. A server crash between command dispatch and checkpoint persistence can still repeat a command, so prefer commands that are safe to retry. Use the current plugin (0.3.0) for per-action execution and player commands.

Bedrock purchases use the configured bedrock-prefix, with a dot as the default. Match it to your server’s player naming configuration. Craftly’s delivery plugin currently targets Paper; proxy networks and other server platforms are not supplied.