Bukkit

Tutorial - Example Setup

Here is a quick example to help you understand how to use all the commands that this plugin comes with (I know there's a lot)!

Let's say I have four groups:

king - members: Boots01
duchess - members: ailwyn
guard - members: sauder10, llamafish
citizen - members: Perichor, serinatta, Simune, EnzoCosta, Impracticality

The King wants to tax the Duchess, and the Duchess wants to tax her guards and citizens. First we need to set the world (let's call our world 5duchies - it needs to be the name of your world's folder):

/cashflow setworld 5duchies

- now we can search for offline players.

Next, we can create the King's tax and make sure it will be applied to the right group:

/tax create duchesstax 20 48 Boots01

- This tax is called duchesstax, it is a flat rate of $20 every time it is paid, and it gets paid every 48 hours. The receiver is Boots01, the King, although if he left that field blank, it would go to no one.

/tax apply group duchesstax duchess

- This command applies the duchesstax to the group duchess. This is useful if Boots01 wants to add more duchess' to the duchess group later.

/cashflow enable

- This will start the timer that lets taxes be paid. The tax will not run right away, it must go one interval before being paid. The timer persists through server stops and restarts.

Now that the Duchess is being paid, she needs to tax her own citizens so she can pay the King. Provided she has the cashflow.* node she can do the following:

/tax create citizentax 20% 36 ailwyn

- This tax is called citizentax, it is a percent tax of 20% of each player's balance every time it is paid, and it gets paid every 36 hours. The money from the tax goes straight to ailwyn.

/tax apply group citizentax citizen,guard

- Ailwyn has now applied her tax to both the citizen group and the guard group. Note that there are no spaces between the group names.

/cashflow restart

- Because the first tax is already being paid out, ailwyn must restart the taxes, not enable them or they will be paid twice! Note that restarting doesn't mess up the timing on your taxes and salaries, it just stops duplicate taxes and salaries.

Because the guards are hard at work defending her lands, Duchess Ailwyn decides she should pay them:

/salary create guardsalary 10 24 ailwyn

- Ailwyn has created a new salary called guardsalary that pays $10 every 24 hours and comes out of ailwyn's pocket.

/salary apply group guardsalary guard

- Now this tax is being applied to the guard group, so they'll get paid.

/cashflow restart

- Remember not to enable, just restart!

informs ailwyn that he is going on vacation for three weeks and won't be online to collect money to pay his taxes. Ailwyn, being the nice duchess she is, decides to exempt Simune for his vacation:

/tax addexception citizentax Simune

- Now Simune won't have to pay tax.

/cashflow restart

- Gotta do it every time.

When Simune comes back, Ailwyn needs to remember to do the following:

/tax removeexception citizentax Simune

- Simune is a taxpayer once again.

/cashflow restart

- And again.

Duchess Ailwyn wants to hire Perichor and serinatta as guards for a little while, but she doesn't want to hire them as full time employees. Instead of adding them to the guard group, she adds them to the payroll separately:

/salary apply player citizentax Perichor,serinatta

- These players don't get added to the guard group, so they can stay as citizens, but they get paid along with the guards. Remember not to put spaces between the players' names.

/cashflow restart

- Seriously, don't forget this.

This is just one example of how you can use taxes and salaries to regulate your economy and entice your players to come online to gather money. Please let me know if this helped you or if you need more assistance, I'd be glad to help. :)