SpoutRewards

{ Insert Logo Here }

What is SpoutRewards

SpoutRewards is a plugin that encourages the use of the Spoutcraft client through positive reinforcement. By giving users who spend an allotted percentage of their time on Spoutcraft a reward, you help reinforce its use without putting a hard ban on your server.

Due to the improvements that Spoutcraft brings to the plugin world (and general server/client improvements) this is a great way to help improve the quality of your server.

Setting up SpoutRewards

Setting up SpoutRewards is a simple process. Just place the plugin file into the plugins folder and run the server once. This will create a config.yml file that you can edit as you please.

The file is fully commented and will explain each and every function and how to use it.

Steps to use a basic setup of SpoutRewards

1. Start the server with the plugin in the plugins folder
2. Open the config.yml files created
3. Choose a percentage of spout time/total time required to receive a reward
4. Choose a reward (all major economies supported)
5. Chose a time period to check for time usage and give rewards
6. Done!

How it works

As players play SpoutRewards records the amount of time they play on each client (the default and spoutcraft). After the chosen interval the chosen reward will be given out to the players who are online (with excess items falling on the ground). Players offline will receive their reward (if they qualify for it) when they next log on. After the rewards are given the timers reset for each player and recording will recommence.

If the reward time is missed (because the server is offline) the next reward will be given when the server starts up and the subsequent reward will be scheduled the "time period" layer. (i.e. if it's set to 3 hours the next reward will be given 3 hours after server start).

Permissions

There is one permission node (using the built in bukkit system). This is "SpoutRewards.admin" (may or may not be case sensitive... i don't know)

Players with this node (or ops if no permissions system is found) can use the command "/SpoutRewards" to have options to reward certain players. At the moment this is an incomplete system and you can only reward the following groups:

• Everyone
• Just You
• Those who qualify for reward This reward will be changeable in the future but as of now it is the default reward.

Note: To access "/SpoutRewards" the SpoutCraft client is needed

Problems

Missing Config Options

If you find you are missing any config items (as you will if new ones are added after an update). You will have to delete the config file for the new one to create itself with the new options. Until then internal defaults will be used instead.

Source Code

Source code will be available soon