diff --git a/Modules.md b/Modules.md new file mode 100644 index 0000000..8b9eb8c --- /dev/null +++ b/Modules.md @@ -0,0 +1,91 @@ +If you add a new file, please update this list! + +----- + +If you want the server to load a file (*module*) on startup, add it to the `modules` list in `main.py`. + + +* `files/` + + > All config / storage files go here + +* `plugin.yml` + + > The plugin.yml file required for bukkit plugins + +* `main.py` + + > The only file loaded by PyPluginLoader, loads all other modules + > Contains a few methods that **need to be cleaned up** + +* `helpers.py` + + > Library that adds a bunch of re-usable methods which are used in nearly all other modules + +* `adminchat.py` + + > Adds chat for staff using `/ac ` + +* `chatgroups.py` + + > Adds group-chat with `/chatgroup` and `/cgt` to toggle normal chat into group mode + +* `lagchunks.py` + + > Plugin to locate laggy chunks. `/lc ` lists chunks with more than `n` entities + +* `mysqlhack.py` + + > A library that makes use of the so called ClassPathHack for jython to allow proper loading of `mysql-connector.jar` at runtime. import only, no methods. + +* `plotter.py` + + > Start of a custom plot-plugin like PlotMe, on hold because the PlotMe developer continued to develop PlotMe + +* `reports.py` + + > The `/report ` and `/rp` plugin + +* `saylol.py` + + > Remake of sheep's old SayLol plugin, originally written as a standalone plugin in Java + +* `skullclick.py` + + > Shows the owner of a skull when right-clicked + +* `webtoken.py` + + > Adds `/token`, reads and writes from the database to generate *pronouncable* (and thus memorable) registration-tokens for the website + +* `spawnplayer.py` + + > Code that was used once to create [this](http://www.reddit.com/r/Minecraft/comments/28le52/screenshot_of_all_players_that_joined_my_server/) awesome [screenshot](http://i.imgur.com/v4wg5kl.png) + +* `tilehelper.py` + + > A plugin that automatically tiles (stacks) blocks inside a selected region in configurable directions. + +* `mentio.py` + + > Adds `/listen`, highlights chat and plays a sound when your name was mentioned + +* `cycler.py` + + > Adds `/cycler`, swaps the hotbar with inventory when player changes slot from right->left or left->right + +* `motd.py` + + > Adds `/getmotd` & `/setmotd` to update the motd on the fly (no reboot). + +* `abot.py` + + > AnswerBot. Hides stupid questions from chat and tells the sender about `/faq` or the like + +* `damnspam.py` + + > Adds `/damnspam`, creates timeout for buttons/levers to mitigate button spam. + +* `forcefield.py` + + > Adds '/forcefield', creates forcefield for players who want it. \ No newline at end of file