Want more features on Pastebin? Sign Up, it's FREE!

Configuration Example for the Bukkit Plugin HelpPages

By: ToastedJelly on May 30th, 2011  |  syntax: None  |  size: 4.51 KB  |  views: 908  |  expires: Never
download  |  raw  |  embed  |  report abuse  |  print
Text below is selected. Please press Ctrl+C to copy to your clipboard. (⌘+C on Mac)
  1. This is an extensive Example of a configuration File for the Bukkit plugin HelpPages
  2. The Admins and the normal users have one overview page, that they access with /help, whereas the Donators have two overview pages that they can access with /help( same as /help 1) and /help 2.
  3. In the overview pages I demonstrate Variables to greet the groupmember differently. Using Variables for the greeting isn't really necessary in this case as the overview help pages are different for every group anyway, so you could embedd the greeting in the page directly, but these can also be used if the used helppage would be the same, like for "/help home".
  4. For help topics that have just one page, we register the topic with a pagenumber 1 also, in case the user is used to always typing a pagenumber - /help home leads to the sam page as /help home 1
  5. The same selector doesn't need to go to the same page though, as one can see for /help monsterhunt, which shows different pages for admins and donators.
  6. Finally you see "/help easteregg" defined for Donators that isn't mentioned anywhere, so the donators would need to know about it or find it by accident. It's also not defined for the Admins, so they also would get an unknown page error when they try "/help easteregg", although if they have the right permissions set, they could use "/help easteregg @ Donators"
  7.  
  8. [[messages
  9. noconfig=&eConfiguration file not found.
  10. reloaded=&eHelp Pages reloaded.
  11. unknownpage=&eUnknown Help Page. Start with &c/help.
  12. nopermission=&cYou are not allowed to reload the help pages.
  13. ]]
  14. ###################### Groups ######################
  15. [[group Administrators,(OP)
  16.   greeting=Greetings
  17.    =>OverviewAdmin
  18.   1=>OverviewAdmin
  19.   home=>pageHome
  20.   home 1=>pageHome
  21.   warp=>pageWarp
  22.   warp 1=>pageWarp
  23.   monsterhunt=>pageMonsterhuntAdmin
  24.   monsterhunt 1=>pageMonsterhuntAdmin
  25.   we=>worldedit1
  26.   we 1=>worldedit1
  27.   we 2=>worldedit2
  28. ]]
  29. [[group Donators
  30.   greeting=All hail
  31.    =>OverviewDonator1
  32.   1=>OverviewDonator1
  33.   2=>OverviewDonator2
  34.   home=>pageHome
  35.   home 1=>pageHome
  36.   warp=>pageWarp
  37.   warp 1=>pageWarp
  38.   monsterhunt=>pageMonsterhunt
  39.   monsterhunt 1=>pageMonsterhunt
  40.   easteregg=>pageEgg
  41. ]]
  42. [[group *
  43.   greeting=Hi
  44.    =>OverviewUser
  45.   1=>OverviewUser
  46.   home=>pageHome
  47.   home 1=>pageHome
  48. ]]
  49. ###################### Overview Pages ######################
  50. [[page OverviewUser
  51. &4---------------- /help ----------------
  52.   {greeting} {displayname},
  53.   here are some basic cmds you can use:
  54.   ....
  55.   ....
  56.   You can also check this additional help pages out:
  57.   /help home
  58.   ...
  59. ]]
  60. [[page OverviewDonator1
  61. &4---------------- /help 1&c/2 &4----------------
  62.   {greeting} {displayname},
  63.   here are some basic cmds you can use:
  64.   ....
  65.   ....
  66.   You can also check this additional help pages out:
  67.   /help home
  68.   /help warp
  69. ]]
  70. [[page OverviewDonator2
  71. &4---------------- /help 2&c/2 &4----------------
  72.   more help pages you can check:
  73.   /help monsterhunt
  74.   ...
  75. ]]
  76. [[page OverviewAdmin
  77. &4---------------- /help ----------------
  78.   {greeting} {displayname},
  79.   You should know the basic cmds. For a reminder: /help @ *
  80.   You can also check this additional help pages out:
  81.   /help home
  82.   /help warp
  83.   /help monsterhunt
  84.   /help WE
  85. ]]
  86. ###################### Topic Help Pages ######################
  87. [[page pageHome
  88. &4---------------- /help home ----------------
  89.         /home
  90.         /home set
  91.         /home invite <username>
  92. ]]
  93. [[page pageWarp
  94. &4---------------- /help warp ----------------
  95.         /warp list
  96.         /warp create <name>
  97.         /warp invite <name> <username>
  98. ]]
  99. [[page pageMonsterhunt
  100. &4---------------- /help monsterhunt ----------------
  101.   The monsterhunt starts every night.
  102.   Use /hunt to register for the next hunt
  103.   /huntstatus - shows the current status of the hunt
  104.   /huntscore - shows your highscore
  105. ]]
  106. [[page pageMonsterhuntAdmin
  107. &4---------------- /help monsterhunt ----------------
  108.   The monsterhunt starts every night.
  109.   Use /hunt to register for the next hunt
  110.   /huntstatus - shows the current status of the hunt
  111.   /huntscore - shows your highscore
  112.   /huntstop <world> - stops the hunt for the specified world
  113.   /huntstart <world> - starts a hunt in the specified world
  114. ]]
  115. [[page worldedit1
  116. &4---------------- /help WE 1&c/2 &4----------------
  117.         WorldEdit cmds are:
  118.         //set <blockID>
  119.         //replace <whatID> <withWhatID>
  120.         ...
  121. ]]
  122. [[page worldedit2
  123. &4---------------- /help WE 2&c/2 &4----------------
  124.         more WorldEdit cmds:
  125.         /fixwater <radius>
  126.         /fixlava <radius>
  127.         ...
  128. ]]
  129. [[page pageEgg
  130.   You found a secret page.
  131.   Diamonds are waiting for you at 666/66/666
  132. ]]
clone this paste RAW Paste Data