Bukkit

Please view the official wiki here

Please install the web portal before you install the plugin! See the Web portal documentation on how to install that.

Once the web portal has been successfully installed put DonatorExpress.jar into your plugins folder and start up your server.

Configuration Files

Before I get into the permissions and commands and such, all the configs requires a little bit of explanation.

config.yml

You can view the default config.yml here

You can view an example of it here

forumConfig.yml

This config is only used if you want to sync forum groups after someone does /donate confirm

For more info on the forum sync options, view this article

You can view the default here.

And an example of it here.

packages.yml

This you SHOULD NEVER TOUCH EVER. You will screw things up if you do. So please, don't touch it, unless you want to test fate, or you screwed up something so badly you have to edit it.

[packageName].yml

This .yml file is generated after you use the command /donate add [packageName]

An example of this can be viewed here.

Adding Packages/Managing Them

Adding/deleting packages couldn't be easier. You can either do this in-game or in the console.

To add a package, type /donate add [packageName] Note: You can also use this plugin to add item sets. Like giving someone a certain amount of diamond blocks, you could call the rank name, diamondblockset, or dbs. Call it what you want.

When you add a package, the plugin generates a new .yml file in DonatorExpress/packages. To view an example of what this should look like (with comments on how to fill it out yourself) go here.

To delete a rank, type in game or in console, /donate delete [packageName]. Then type /donate confirmdel to confirm that you wish to delete the package.

NOTE: THIS CAN NOT BE UNDONE. USE WITH CAUTION.

Expiry, Forum Group Sync options, and One Time Purchase options

Forum Group

For more info on the Forum Group Sync options, you can view this wiki page.

Expiry

You will see 4 options for Expiry

expire: false

expire-time: 0

expire-commands:

- manuadd %player default

expire-message: '&cYour package has expired. You have been deranked'

Its really self explanatory. Plus I included comments but there is some important notes to take note of. You have to decide if its a package that will expire before someone buys it. If you choose after, then you will have to manually derank them after the set amount of time.

Expire-time is in DAYS. Not weeks or months.

Expire-message is showed to the user once their package expires. The plugin checks every time a user logs in. So if you have pesky users not wanting to log off, kick them and tell them to relog.

One time purchase

This is used when the package is upgradable and can only be purchased once. Unless you delete a users config data.

There are 3 options for one time purchases

one-time-purchase: false

next-package: 'null'

next-package-price: 0

Again most of these are self explanatory and there are comments to help you. Note that the next-package HAS TO BE IN ALL LOWERCASE in order for it to work. If this is the final package, leave next-package at null.

Buying Packages

To buy a rank, tell your users to type /donate buy [packageName]. If the user does not know what the package name is, they can type /donate list to view all the current packages, as long as they have the permission donexpress.user. Note: This can not be executed in the console.

Upgrading

To upgrade, tell your users to type /donate upgrade [nextPackageName]. This will then upgrade them to the next package as defined by the [packageConfig].yml file. This will only work if you have properly set the options in the [packageName].yml file. Note that if you changed this rank to a one-time-purchase AFTER someone has purchased the package, this will not work.

Descriptions and rank listing

To add a description, just go into your [packageName].yml and edit the “description” field. One line in the config equals one line in Minecraft. Fully customizable. You can even use formatting codes.

Players can type /donate list to view all the current ranks and /donate info [packageName] to view the description.

Other Commands

If one of your members has forgotten how many tokens they have, they can type /donate check to view them. Alternatively, an admin can type /donate checkvc [username] to view anyone's virtual currency amount. donexpress.admin.checkvc is used this. Note: This can not be executed in the console, but, /donate checkvc can.

To add or set a users virtual currency, an admin can type /donate addvc [username] [amount]. This will take the amount the user already has and add to it. The permission node for this is donexpress.admin.addvc. To set a users VC, an admin can type /donate setvc [username] [amount]. This will set a users VC instead of adding to it. The permission node is donexpress.admin.setvc.

To check to see if there is an update, make sure that update-check is set to true, and you will receive an in-game notification when you log in, if there is an update or not.

To reload the config, type /donate reload. The permission node for this is donexpress.admin.reload. Note that most changes to the configs require you to reload your server.

Signs

To view the documentation on signs, please visit the Sign documentation.

Commands and Permissions

Commands

/donate add [packageName] Adds a package

/donate delete [packageName] Deletes a package

/donate confirmdel Confirms a deletion of the package. This can NOT be undone. Be careful.

/donate list Lists all the available packages

/donate info Returns the description of the package

/donate check Mainly used by a regular player. Returns the amount of virtual currency that the player has. Can only be ran by a Player and not by console

/donate checkvc [player] Mainly used by an admin/mod. Returns the amount of virtual currency that the player has.

/donate addvc [player] [amount] Adds virtual currency to the selected player.

/donate removevc [player] [amount] Removes virtual currency from the selected player.

/donate setvc [player] [amount] Edits the amount of virtual currency for the selected player. This will change the the virtual currency amount instead of adding to it.

/donate buy [packageName] Buys the selected package if the player has enough virtual currency. The player will need to type /donate confirm to confirm that they want that package.

/donate confirm Confirms the buy. Console commands are executed here. Adds the date, rank, total tokens and username to a table called Purchases in the database.

/donate cancel Cancels the purchase/package deletion.

/donate upgrade Upgrades the package as defined in the packageConfig.yml

/donate recent Displays the last 5 purchases.

/donate reload Reloads the config

/donate about Displays information about the plugin.

/donate help Displays all the available commands.

Permissions

donexpress.*: Gives access to all commands

donexpress.admin.*: Access to all admin commands

donexpress.admin.add: Adds a package to the config

donexpress.admin.delete: Deletes a package from the config

donexpress.admin.checkvc: Checks the amount of virtual currency that a player has

donexpress.admin.addvc: Adds virtual currency to a specified user

donexpress.admin.removevc: Removes virtual currency from a specified user

donexpress.admin.setvc: Sets a users amount of tokens instead of adding them

donexpress.admin.recent: Checks the last 5 purchases

donexpress.admin.update: Lets the user know about an update, assuming its enabled in the config

donexpress.admin.signplace: Allows the user with proper permission to place signs to allow users to buy and sell virtual currency as well as buy packages

donexpress.admin.signremove: Allows the user to remove a sign with [DE] on it

donexpress.user: Any commands that a user would use

Questions?

Have a question, bug, something not working for you? Well we can help. Simply contact us here and we will be happy to assist you. No registration required.