Install the plugin and connect your server

The plugin delivers what players buy. It runs on your Minecraft server, asks Minecraftstore.io every few seconds which commands to run, runs them in the console and reports back. This page shows how to install it and link it to your store.

What you need

• A server running Paper or Spigot, Minecraft 1.18 or newer
• Java 17 or newer
• Access to the plugins folder and the console of your server

Folia is not supported.

Your server does not need an open port. The plugin makes the connection, and the platform never connects to your server.

Download the plugin

1. In the sidebar, under Game, open Servers.
2. Click Download plugin. You get a file named like Minecraftstore-1.2.0.jar.
3. Put the jar in the plugins folder of your server.
4. Start the server once. The plugin makes plugins/Minecraftstore/config.yml.

Until it has a token, the plugin writes a line in the console saying there is no token yet.

Create a token

1. On the Servers page, click Connect a server.
2. Give the server a Name, like Survival or Lobby. The name is for you, and shows when you pick where a command runs.
3. Click Create token.

A window shows the token as a command for your server console:

mcs token mcs_...

Click Copy and keep it somewhere safe until it is on your server. You see the token only this once. We keep a fingerprint of it, not the token itself.

Keep the token secret. Anyone who has it can receive the deliveries of your store.

Set the token on your server

Paste the copied command in your server console and press Enter:

mcs token mcs_...

The plugin saves the token in plugins/Minecraftstore/config.yml and connects at once. Type it in the console rather than in the game chat: a command from the chat is written to the server log.

The command needs plugin version 1.3.0 or newer. With an older version, or if you prefer the file, open plugins/Minecraftstore/config.yml, paste the token and run mcs reload:

token: "mcs_..."

You do not set an address for the API: the plugin knows it.

Check the connection

Back on the Servers page, each server shows one of these:

Status	What it means
Waiting for the plugin	The plugin has never checked in with this token.
Online	The plugin checked in during the last 5 minutes.
Offline	The plugin checked in before, but not in the last 5 minutes.
Disabled	You disabled the server. Its token is refused.

The row also shows when the server was last seen and which plugin version it runs.

In the game or the console, /mcs status shows the store and server name the plugin is connected to, when it last talked to the platform and how many orders it delivered since it started.

These admin commands need the minecraftstore.admin permission. Operators have it.

Command	What it does
/mcs status	Shows the connection, the last contact and any last problem
/mcs token <token>	Saves a new token and connects with it
/mcs reload	Reads config.yml again, for example after a new token
/mcs refresh	Fetches the shop menu again after you changed products

The best test is a real purchase: buy something cheap in your own store and watch the order. See How delivery works.

Lost the token

Open the menu next to the server on the Servers page and choose New token. The current token stops working right away. Until you put the new one in the config and run /mcs reload, the server gets no deliveries. Paid orders wait in the queue and are not lost.

A wrong or replaced token stops the plugin with a message in the console. Paste the current token and reload.

The in-game store

The plugin also gives players a shop in the game. /buy opens a chest menu with your categories and products, in the same order as on your store, with their price and description. Each product shows the menu item you picked for it in the product form.

Clicking a product sends the player a link in chat to the checkout of your store, with the product and their name already filled in. Paying always happens on your store, never in the game. Bedrock players who join through Floodgate get the address as text, because they cannot click links in chat.

Pay with a phone

From plugin version 1.4.0, the checkout can also be a QR code on a map. Java players click [Show QR code] under the link; Bedrock players get the map at once. The player holds the map, points their phone camera at it and pays on the phone. /buy qr shows the last code again.

The map stays in the player's own inventory: it cannot be dropped, put in a chest or hung in an item frame, and it disappears once the player has paid, after 5 minutes, or when the player leaves. Turn it off or change the texts under menu.qr-map in config.yml.

• Hidden products are not in the menu. Sold out and not yet available products are shown, but cannot be bought.
• Before your store takes payments, the menu says the store is not open yet.
• The menu is fetched again every 5 minutes. Run /mcs refresh to see a change at once.
• Everyone may use /buy, through the minecraftstore.buy permission.

Everything players see is set in config.yml under menu: the command name, titles, items, texts and colours. Set menu.enabled: false to turn the menu off. A change to the command name needs a server restart.

Purchase announcements

The plugin announces each new purchase in chat. Change the text or turn it off under announcements in config.yml. With PlaceholderAPI installed, placeholders like %minecraftstore_top_buyer% work in scoreboards and tab lists. The full list is in config.yml.

Updating the plugin

When a newer version is out, the plugin says so in the console, and from version 1.4.0 operators get a message with a download link when they join. Download the new jar from the Servers page, replace the old one in plugins and restart the server. Your config.yml stays.

More than one server

Connect each server with its own name and token. See Multiple servers.