Installing and configuring MineSync Store

MineSync Store allows your players to purchase in-game ranks via user upgrades on your XenForo forum.

Requirements

In addition to the requirements for MineSync, you must also have the following installed for MineSync Store to work:

• MineSync for XF2.
  • XenForo version 3.3 or higher.
  • Server version S2.2 or higher.
• Vault-compatible permissions plugin that also supports setting ranks on offline players. (many permissions plugins will support this. We have tested with LuckPerms).

Installation

XenForo: Install the XenForo add-on for MineSync Store as normal.

Server: MineSync Store uses the same server JAR as MineSync, and does not require an extra plugin. Simply update your server JARs to version S2.2 or higher and start the server. Once you start the server, your config.yml file will be updated with a new key called "enable-store". Edit the config.yml file change the value of this key to "true".

Configuration

MineSync Store is built to require minimal configuration, and uses the normal MineSync groups configuration (see the "Adding Ranks" section in the Setting up MineSync for the first time article). This creates a link between an in-game rank in Minecraft, and a group in XenForo, so that MineSync knows which in-game group to add when a user is upgraded on the forums.

Once you've setup your server's ranks as described there, simply create a user upgrade in XenForo and configure it to add the XF group associated with the MineSync group. Now, when a user purchases this user upgrade their in-game rank will automatically be updated. The update will happen either when they next log in, or within 5 minutes if they are already logged in.

Example configuration

The screenshots below show an example configuration of a "VIP" rank. The first screenshot is a MineSync group configuration for the "VIP" group, which matches together the XF group titled "VIP" and the in-game rank with name "vip". The second screenshot shows a user upgrade which adds the XF group "VIP" on purchase. Now, when a user purchases "VIP" they are automatically upgraded both on the forums and in-game.

MineSync group:

User upgrade:

Notes

If the user upgrade is expiring or recurring (eg must be renewed every 1 month), or is charged back, then MineSync will automatically downgrade the user in-game when the upgrade expires.

Note: MineSync can only update the in-game rank of a player if it knows their username, meaning the player must link their account using MineSync for the upgrade to process. If the player purchases a rank without being linked this is not a problem; MineSync will update their in-game rank as soon as. they link, even if this is after they purchase the upgrade.