Bukkit

WorldRules

Description

This plugin was created for my public server and is being released because it seems like there is no other way to do this. Essentially it will add a /rules command that is specific to the world the player is currently in allowing you to define rules that are only effective in a specific world. The config file allows you to defined global rules (shown in all worlds), world specific rules and set if you want the rules to be shown when a player enters a world or not.

Bug Reports / Suggestions

If you find a bug, encounter a problem or have a suggestion, please fill out a ticket via the Tickets link above. I do not have the time to read through the comments section, any comment that fits the previous three categories will be ignored.

Commands

/rules - This command shows the rules to the player, they must have the permission worldrules.rules.show which will default to true for all players.

/worldrules reload - This command will reload the rules from the config file, it requires the permission worldrules.rules.reload which defaults to ops only.

Config File

The config file will be generated on the first run of the server with the plugin installed, it is fairly self explanatory and will look a bit like this

settings:
  rules-on-enter: true
  header-colour: DARK_GREEN
  rule-colour: GREEN
global-rules:
- Don't be evil
world-rules:
  world:
  - Don't do bad things
  world_nether:
  - Don't break blaze spawners

The world-rules setting contains a section for each world on the server, under each of these sections you can add rules that only apply to that world. Leaving a section blanks means that only the global-rules will apply. The global-rules section contains a list of rules that will be shown in all of the worlds on the server. Finally the rules-on-enter setting controls whether the rules should be shown when a player enters a world or not and the two colour settings allow you to change the colours used in the rules message.

Contributing

Contributions to the project are very much welcome, if you have a feature that you want implemented and know a nice way to do it then consider forking the repo and submitting a pull request. These will be accepted as long as the following simple guidelines are followed.

• Do not edit the structure of the pom.xml file, feel free to add a dependency if you need it but the formatting and structure should not be changed.
• If you are exposing a new API method, add a JavaDoc comment to it, but don't over-comment internal code.
• Follow the existing code style, don't antagonise over every space though !

All dependencies that are used are now available from a public Maven repo, so you don't have to worry about building several other projects just to add a simple change any more.

Source Code

Available on GitHub

Dev Builds

Changes Since Last Release

Download

Development builds of this project can be acquired at the provided continuous integration server. These builds have not been approved by the BukkitDev staff. Use them at your own risk.

http://bukkit.jacekk.co.uk:8000/job/WorldRules/

Download Stats