CustomHelpPages

CustomHelpPages

Ever wanted to create your own list of help pages?

This is a lightweight plugin allows you to simply manage/replace the help command with a more customizable solution.

Features:

• Auto modulating help pages (calculates how many pages you will have based on the amount of messages)
• Ability to set different lists for each group
• Ability to make custom pages
• Adjust messages per page
• Edit page header & footer text

Instructions:

1. Drop into plugins folder
2. Start your server so the config file generates
3. Configure as you please. Lots of comments in the config.

Commands:

• /help [page] - Display help pages.
• /help view <list> [page] - Display a specified list.
• /help reload - Reload the configuration.

Permissions:

• help.help (To be able use the plugin)
• help.group.<list>
• help.page.<list>
• help.view (To be able to view any groups' lists)
• help.reload

Config:

# Made by Agazed.
# Visit me @ agazed.net!
 
# ---------- GROUP LISTS ---------- #
# You can assign different groups different lists with "help.group.<list>
 
groups:
 
  # This is the default list. People who have access to this list either have multiple list permissions or no list permissions.
  default:
    # How many help messages do you want on one page?
    messages-per-page: 8
    # Do you want to display the top header message?
    display-header: true
    #Shall the header be displayed on the last page?
    show-header-on-last-page: true
    # Top header message. Available vars: %CURRENTPAGE, %TOTALPAGES, %NEXTPAGE, %LIST.
    header: '&7Page: %CURRENTPAGE/%TOTALPAGES'
    # Do you want to display the bottom footer message?
    display-footer: true
    #Shall the footer be displayed on the last page?
    show-footer-on-last-page: false
    # Bottom footer message. Available vars: %CURRENTPAGE, %TOTALPAGES, %NEXTPAGE, %LIST.
    footer: '&7Type /help %NEXTPAGE to get to the next page'
    messages:
    - 'A message'
    - 'Another message'
    - '&2Colored message!'
    - 'The list goes on...'
 
  # Example: To grant access to this list, grant the permission "help.group.test".
  test:
    messages-per-page: 8
    display-header: true
    show-header-on-last-page: true
    header: '&7Page: %CURRENTPAGE/%TOTALPAGES'
    display-footer: true
    show-footer-on-last-page: false
    footer: '&7Type /help %NEXTPAGE to get to the next page'
    messages:
    - 'Test list!'
 
# ---------- PAGE LISTS ---------- #
 
pages:
 
  # Custom page. Access with /help cool. Permission is "help.page.cool".
  cool:
    messages-per-page: 8
    display-header: true
    show-header-on-last-page: true
    header: '&7Page: %CURRENTPAGE/%TOTALPAGES'
    display-footer: true
    show-footer-on-last-page: false
    footer: '&7Type /help %LIST %NEXTPAGE to get to the next page'
    messages:
    - 'Sick bruh.'

Video:

• No video :( If anyone would like to make one please tell me so I can put it on here!

TODO:

• Nothing! Post suggestions below. I'm open to anything!

Metrics:

Source Code on GitHub