HystoreWiki

3 min readView as Markdown

Install the plugin

The plugin connects your server to the store. It delivers purchases, handles VIP in game and brings announcements and /loja into the server. This section only shows in Minecraft and Hytale stores.

The same Minecraft plugin runs from version 1.8.8 to the newest one, on Spigot, Paper and Folia.

Plugin > How it works: the download, what the plugin does and how to install it
Plugin > How it works: the download, what the plugin does and how to install it

Step by step

You will need access to the server files, usually through your host's panel.

1. Create the server on the store

  1. In Store > Servers, click New Server.
  2. Give it a name, like Survival. The photo is optional.
  3. Click Create Server.
The new server window
The new server window

2. Copy the token

After creating it, the screen shows the token, the password that links the plugin to this server. Copy it now: it shows only once, in this window. Lost it? Open the server and use Regenerate Token to get another one.

The server token right after creating it
The server token right after creating it

3. Download and install the plugin

  1. In Plugin > How it works, click Download the plugin.
  2. Put the file in the server's plugins folder.
  3. Start the server once. The plugin creates the file plugins/Hystore/config.yml.

4. Paste the token

Open plugins/Hystore/config.yml and paste the token in the token field:

plugins/Hystore/config.ymlYAML
token: "PASTE_YOUR_TOKEN_HERE"

On Hytale, the file is config.json, in the plugin's folder, with the same fields.

5. Reload and check

  1. In the server console, type /hystorereload, or restart the server.
  2. In Store > Servers, check the Last plugin connection. If it shows just now, it worked.
The server list with each one's last connection
The server list with each one's last connection

Configuration file options

After changing the file, use /hystorereload or restart the server.

Option Default What it does
token The server password
poll-interval-seconds 30 How many seconds between each search for deliveries
require-online true true: the delivery waits for the player to be online. false: it runs right away, even offline
notify-player true Tells the player when they get a delivery
auto-update true Downloads new versions on its own
vip.language auto VIP language: auto uses each player's game language. Or set pt, en or es
vip.announce-activation true Announces in the chat when someone activates a VIP
vip.warn-every-hours 6 With the VIP close to ending, warns every so many hours
debug false Writes more details to the console

Updates

Install it once. When a new version comes out, the plugin downloads it on its own, checks the Hystore signature and the new version applies on the next server restart. In Plugin > What's new you see what changed in each version.

What's new in the plugin, version by version
What's new in the plugin, version by version

Check the server

In Store > Servers > View Details, the On the server card shows what the plugin reported: its version, whether it is outdated, the server software and the enabled plugins. There is a warning when LuckPerms is missing, which the product VIP may use.

Continue in Linking and commands.