Hello there!

Thank you for your interest in RoyalCommands. This readme is designed to get you up and
running in as little time as possible. It also contains instructions for updating, should
you be updating from any previous version.

Please make sure you have all of the files listed in the tree below.

File Tree
---------
├── LICENSE
├── README.txt
├── RoyalCommands
│   └── config.yml
└── rCmds.jar

1 directory, 4 files

This readme is divided into sections which can be seen from the table of contents below.

Table of Contents
-----------------
A. First Install
 I.   Prerequisites
 II.  Moving Files
 III. Setting Up Config
 IV.  Restarting Server
 V.   Troubleshooting
B. Upgrading
 I.   Moving Files
 II.  Patching The Config
 III. Reconfiguring
 IV.  Restarting Server
 V.   Troubleshooting
C. Miscellany
 I.  Contact Methods
 II. Developer's Note (Donations)

A. First Install
 I. Prerequisites
  To run RoyalCommands, please make sure that you have Vault
  ( http://dev.bukkit.org/server-mods/vault ) installed on your CraftBukkit server.
  RoyalCommands cannot run without this plugin.

 II. Moving Files
  If rCmds.jar is already in your plugins directory, you can skip this section.
  
  You will need to move rCmds.jar into the plugins directory of your CraftBukkit
  installation. Afterwards, move the directory RoyalCommands into the same directory.

  LICENSE and this file (README.txt) do not need to be included in the plugins directory.

 III. Setting Up Config
  It is important that you read through every configuration option in
  RoyalCommands/config.yml, as you may be left vulnerable to exploits (players getting
  free items, bedrock, etc.) if you do not. Each option is explained in a comment above
  it. Comments start with an octothorp (hash sign - #).
  
  The configuration is split up into sections that look like the following:
  ###
  # Section name #
  ###
  All of the options below the section (and until the next section) will relate to the
  section name.
  
  Options that start with true or false can only be those - i.e. true or false.
  Most options cannot have their types changed ("Hello" cannot become 1).
  
 IV. Restart Server
  After you have installed RoyalCommands, you must restart your server.
  
  !!!
  DO NOT issue a /reload. The reload command is prone to breaking plugins and causing
  memory leaks. Always issue a /stop and restart your server.
  !!!
  
  If everything went well, you should see something along the lines of:
  [RoyalCommands] Enabling RoyalCommands <VERSION>
  [INFO] [RoyalCommands] RoyalCommands <VERSION> initiated.
  
  If that is the case, congratulations! You have successfully installed and configured
  RoyalCommands! If you have any other questions not answered by this guide, please
  look at C.I. - Contact Methods. I hope you have a wonderful experience.
  
  If you see a stack-trace instead, please look at A.V. - Troubleshooting.

 V. Troubleshooting
  If you see a stack-trace when you start your server, please make sure to read the rest
  of this section.
  
  First, make sure that the stack-trace is from RoyalCommands. Read through the first
  few lines - they should contain the name of the plugin the issue is originating from.
  If not, look through the lines that start with "org" or "com". If you find one that says
  "org.royaldev.royalcommands", it is a problem with RoyalCommands. However, if you do
  not find anything that points to RoyalCommands being the instigator, it probably wasn't.
  
  If it is a RoyalCommands problem, please see the following:
   - Make sure Vault is installed (see A.I. - Prerequisites).
   - Make sure the configuration is not missing options.
   - Make sure the configuration does not contain tabs (it can only have spaces).
   - Make sure RoyalCommands is up to date (did you download the correct one?).
   - Be sure that you only have one RoyalCommands jar in your plugins directory.
   - Remove all other plugins and try again. If the problem persists, it is a plugin
     conflict.

  If none of those solved your problem, please see C.I. - Contact Methods. Be sure to
  paste the stack-trace in a pastebin (a website that you can send to people with large
  amounts of text). Two examples of pastebins are http://pastebin.com and
  http://pastie.org.

B. Upgrading
 I. Moving Files
  I'd like to thank you for your continued interest in and use of RoyalCommands!
  
  First, you'll need to move rCmds.jar into your plugins directory. This is all that you
  need to move.

 II. Patching The Config
  If "new_configs.txt" does not exist, you can skip this section.
  
  If you're not on a Unix-based operating system (that's you, Windows users!), please
  just copy and paste the text from "new_configs.txt" to the end of "config.yml".
  
  If you're on a Unix-based operating system (Debian, CentOS, Fedora, RedHat, Ubuntu,
  Mac, etc.), you can either do what the Windows users must do, or you can do the
  following:
   - At a terminal, cd to where you extracted the rCmds.zip archive.
   - Copy "new_configs.txt" to "<PLUGINS DIRECTORY>/RoyalCommands/"
   - Enter "cat new_configs.txt >> config.yml"
  
  If all goes well, you have successfully patched your config to contain all the new
  options.
  
 III. Reconfiguring
  If "new_configs.txt" did not exist, you can skip this section as well.
  
  Open "config.yml" from "<PLUGINS FOLDER>/RoyalCommands" and find the new additions.
  They will be under three lines that look like the following:
  ###
  # Patch to <NEW VERSION> #
  ###
  
  Edit the options below those lines to your liking and save the config.
  
 IV. Restart Server
  After you have upgraded RoyalCommands, you must restart your server.
  
  !!!
  DO NOT issue a /reload. The reload command is prone to breaking plugins and causing
  memory leaks. Always issue a /stop and restart your server.
  !!!
  
  If everything went well, you should see something along the lines of:
  [RoyalCommands] Enabling RoyalCommands <NEW VERSION>
  [INFO] [RoyalCommands] RoyalCommands <NEW VERSION> initiated.
  
  If that is the case, congratulations! You have successfully upgraded and reconfigured
  RoyalCommands! If you have any other questions not answered by this guide, please
  look at C.I. - Contact Methods. I hope that you continue to use and enjoy RoyalDev
  products.
  
  If you see a stack-trace instead, please look at B.V. - Troubleshooting.

 V. Troubleshooting
  If you see a stack-trace when you start your server, please make sure to read the rest
  of this section.
  
  First, make sure that the stack-trace is from RoyalCommands. Read through the first
  few lines - they should contain the name of the plugin the issue is originating from.
  If not, look through the lines that start with "org" or "com". If you find one that says
  "org.royaldev.royalcommands", it is a problem with RoyalCommands. However, if you do
  not find anything that points to RoyalCommands being the instigator, it probably wasn't.
  
  If it is a RoyalCommands problem, please see the following:
   - Make sure Vault is installed (see A.I. - Prerequisites).
   - Make sure the configuration is not missing options.
   - Make sure the configuration does not contain tabs (it can only have spaces).
   - Make sure RoyalCommands is up to date (did you download the correct one?).
   - Be sure that you only have one RoyalCommands jar in your plugins directory.
   - Remove all other plugins and try again. If the problem persists, it is a plugin
     conflict.

  If none of those solved your problem, please see C.I. - Contact Methods. Be sure to
  paste the stack-trace in a pastebin (a website that you can send to people with large
  amounts of text). Two examples of pastebins are http://pastebin.com and
  http://pastie.org.

C. Miscellany
 I. Contact Methods
  You can contact me (jkcclemens) with and of the following methods:
   - Email: jkc.clemens@royaldev.org
   - IRC: I'm always on irc.royaldev.org - channel #bukkit
   - Skype: kyle.clemens (I'm rarely ever on)
   - Web: dev.royaldev.org/contact

 II. Developer's Note (Donations)
  I would like to thank you once again for using my products. Seeing people use and enjoy
  my work is what inspires me to continue developing plugins.
  
  However, I work very hard and for no pay. If you would like to help me pay the bills,
  buy me a beer, or if you're just feeling generous, you can donate to my PayPal:
  jkc.clemens@gmail.com
  
  I appreciate any and all donations, no matter what the amount. You would be helping a
  poor student out, and you would also be motivating me to keep up the good work.
  
  If you can't afford to donate, you can let me know I'm doing well by contacting me or
  by commenting on the project at Bukkit.
  
  Thank you.
  
You read the whole readme! Thank you for appreciating this work.
I hope RoyalCommands works very well for you.

Written by: Kyle Clemens (jkcclemens) - what a surprise
Did I make a mistake? Contact me!
# EOF
