Bukkit

McCity Help

Summary

McCity Help allows you to create help for your server.

Main features

• Create a subsections with unlimited nesting.
• Support for Permissions (Tested on bPermissions plugin)
• Can work without permissions plugin (but can't use native bukit permissions)
• Assign Permissions for single articles
• Colored text
• Splitting the long text (list) on page
• Search

Planned

1. Improve search algorithm (make binary search tree)
2. In game editing (partially implemented)
3. More comfortable navigation
   • Ability to create "favorites". (For a list of articles, where you can place any article or section for easy access.)
   • The ability to "send" to the article. (example, type I write "/sendtopic fromgate", he writes "/readropic" and he opened it)

Known bugs

• None

Usage

• /help - go to top and print list of topics (subfolders)
• /help [topic_name\subfolder_name] - print topic or print list of topics (subfolders) in %subfolder_name%
• /help [topic_name] [page_number]- print topic's page (usable for long topics)
• /help back - open previous topic\subfoldier
• /help find [topic or tag] - find and show first founded topic (If it is found by name) or list of topics (If it is found by tag)
• /adminhelp new [topic_name] - create new topic with name "topic_name"
• /adminhelp addstring [text] - add ne line of text into topic
• /adminhelp permission [permission] - enter permission for this topic (default mccityhelp.user).
• /adminhelp save [path] - path for save the article. Article will not be available until you restart the plugin.
• /adminhelp reload - reload help's topics\subfolders
  Examples

Permissions

• mccityhelp.admin - /adminhelp command (if no any permissions plugin this can do only operator)
• mccityhelp.user - ./help command and it's default permission for articles (if no any permissions plugin this can do any player)

Triva

Do not forget to write reviews and comments. And do not forget to mention the bugs, if you find it.