Installing the Plugin

Learn how to Authorise and Install the Donation Store Minecraft Plugin

Introduction


This guide will give you a quick idea on how to install the Donation Store plugin on your game server. Right now we support Minecraft servers (with plans to support more in the future) through 4 main server versions.

  • Bukkit
  • BungeeCord
  • Velocity
  • Sponge

Source Code


Unlike the original versions, the Donation Store plugins are now open source. You can view the source code below. This plugin is a "reference" plugin, so if you want to add new features or make a custom version of the plugin, fork the repo and use it as a reference. If you want to add something to the plugin, please do open a pull request and we will review it!

View the code on GitHub

Getting a Server


To install the plugin, you will need a Minecraft server. If you want to get started and get up and running quickly, you can get a server from ElixirNode (who are our partners). You can get x discount and avail of their one click install of the Donation Store plugin

Get 50% Off ElixirNode Servers. Use code donationstore for 50% off your first month with ElixirNode

Connecting the Plugin


Drag and drop the plugin into your relevant plugins folder and restart your server. Once complete you need to connect it to your webstore. To do so, simply run the following command from your console

ds connect SECRET_KEY https://store.donationstore.io/api

Replace the given example URL with your store's URL. Please include the /api

Plugin Commands


Once setup, you can use the following commands in game

Command Permission Node Description
/ds code donationstore.code Gets a virtual currency claim code
/ds balance donationstore.balance Gets a users virtual currency balances
/ds currency donationstore.currency Gives a user a given currency

Thats it. Donation Store will now poll your webstore's API every couple of minutes to execute purchased packages.

Configure the Plugin


The Donation Store plugin can be configured to change the queue delay time. The queue delay time is the time, in seconds, that Donation Store will wait before checking if there are any new purchases on your webstore. By default it is set to 180 seconds (3 minutes). This means that Donation Store will try to look for new purchases from your webstore every 3 minutes.

You can change this value in the relevant configuration file belonging to each Donation Store plugin installation.


Have Questions? Open a Support Ticket

View Common Issues on the Knowledgebase

Video Guides on YouTube

Other clients and Donation Store developers hang out on our Discord server, where you can ask for support in #ds-chat, or if you are a Client and you don't uet have your Client role on Discord, let us know and we can add it. Once added you get access to our private Client's support channel.