EASYRULES is a simple plugin with no Permissions and one easy command /rules. By using txt file rather than a yaml, server admins can make changes to the txt file upload and see the changes immediately. No need to reload or restart.
There is just one simple command /rules
Within the folder /plugins/rules is the rules.txt file. There 2 settings you can adjust.
- Joinmessage, which will broadcast a quick message to all users when they join
- Prefix, this is what will appear before all messages.
- Both of these settings support Color.
Categories are added by creating a tag, like so [towns] The main category is ironically [main] and is the default /rules category show when you enter /rules
Here is an example WITHOUT color
[main]List of pages: (usage: /rules <page 1-X> ) [main]Page 1: General - Main rules of this server. [main]Page 2: Building - Do's and Dont's. ~~~~~General rules of the server. - No griefing / stealing ~~~~~Rules about building - Realistic building, no floating buildings etc.
Doing /rules will show the main section
[main]List of pages: (usage: /rules <page 1-X> ) [main]Page 1: General - Main rules of this server. [main]Page 2: Building - Do's and Dont's.
Doing /rules 1 will show the General Section I created.
~~~~~General rules of the server. - No griefing / stealing
You are NOT limited to using Numbers for your categories. You can use Words as well, and they DO NOT have to me in the [main] category to work.
For instance, if you use TOWNY, you might want to allow each town to have their own set of rules. I have a town called WhiteWater and a town named terra firma.
If a player does /rules terrafirma this is what why will see
[terrafirma]~~~~~~ Terra Firma Town Rules\\ [terrafirma]- &eOnly the Best Builders may join this town.\\ [terrafirma]- &2You can build anywhere you like, just dont destroy &cANYTHING\\ [terrafirma]- &eThere is no spawn point, so make sure you set a home.\\ [terrafirma]!!!! &4Do Not Spawn Items for Building &f(if you are a mod)\\
[whitewater] No cobblestone or dirt houses. Try best to stay away from building completely plank houses or 1 material houses. \\ [whitewater] No greifing or annoying other players of the town.\\ [whitewater] &2Vote, &eVote &rand &cVote. Vote for the server as much as possible, I will like you more.\\ [whitewater] Listen to rule 1 and 2\\
- &n Underline
- &l Bold text
- &m Strike-through
- &k Same as &k
- &o Italics
When to use &f and &r
If you make a rule that uses a color and a font edit together and you want to keep the font edit, but not the color, then you should use &f
&6 &l THIS TEXT will be gold and bold.&f NOW it will be bold and white.
You can use &r to turn off the font edits
&6 &l THIS TEXT will be gold and bold.&r NOW it will be JUST white.
An example Without colors
[main]List of pages: (usage: /rules <page 1-X>) [main]Page 1: General - Main rules of this server. [main]Page 2: Building - Do's and Dont's.
An example With colors
[main]List of pages: &c(usage: &b/rules <page 1-X> &c) [main]Page &b1: &bGeneral - &6Main rules of this server. [main]Page &b2: &bBuilding - &6Do's and Dont's.
You do not need to reload the plugin for changes to the rules.txt file to take place.
Edit the file, upload the file and it will APPEAR!
Using With CommandBook V2.0
If you want to use this with Commandbook, you will need to disable the rules function in Commandbook.
components: disabled: - stored-messages
Stored-messages is where Commandbook rules are enabled. So if you disable it, you can use EasyRules instead.
Version 2.0 has a new file called info. This is used for basic server info. The ingame command is /faq to make sure there are no conflicts with commandbook or essentials
Here is an example, which also shows the new characters. Please note that you CAN combine color and font codes.
- Standardize Colors
- YOU WILL HAVE TO UPDATE YOUR RULES FILE IF YOU USE THIS VERSION V2.0
- text wrap works correctly
- added new font codes
- added info.txt and /faq command