The Info module simply attempts to provide information to the player, in the form of either a Message Of The Day (MOTD), or a series of info pages.
Nucleus creates a file at config/nucleus/motd.txt
that will be displayed on join to anyone with the nucleus.motd.login
permission, or if they run /motd
(with the nucleus.motd.base
permission). The text file supports Minecraft colour codes
prefixed with an ampersand (&
), and will convert URLs automatically where it sees them.
To update the file, simply edit the file, Nucleus will pick up the updated contents automatically. If you want a different (or no) title for the MOTD,
this can be changed in the main.conf
file, see info.motd-title
.
The MOTD supports links and placeholder tokens, see this page to see how tokens and links can be created.
Nucleus creates a folder at config/nucleus/info
, and drops two files into it, color.txt
and info.txt
. These form two
sections in /info
. To create an additional sections, create a new text file (with the extension .txt
) and save it in the
same folder. Upon /nucleus reload
or a server restart, the contents of the file will be available for reading - the filename
(minus .txt
) will appear in the /info
list.
Editing an existing .txt
file does not require the use of /nucleus reload
.
When creating additional chapters, note the following:
#
and add the title
to that line. The title can be no longer than 50 characters.nucleus.info.base
.The following are incompatibilities that may occur with this module, along with how to resolve the problem. For the full mod/plugin incompatibility list, see the compatibility page.
No plugin incompatibilities have been reported.
Aliases:
/info
, /einfo
Usage: /info [-l|--list <l>] [<section>]
Default Role: USER
Basic Command Permission: nucleus.info.base
Permissions
nucleus.info.list
- Default Role: ADMIN nucleus.info.base
- Default Role: USER
This command is an equivalent to the following command(s) in Essentials:
/info
, /ifo
, /news
, /about
, /inform
Aliases:
/motd
Usage: /motd
Default Role: USER
Basic Command Permission: nucleus.motd.base
Permissions
nucleus.motd.base
- Default Role: USER
This command is an equivalent to the following command(s) in Essentials:
/motd
Permission | Suggested Role | Description |
---|---|---|
nucleus.info.base | USER | Allows the user to run the command /info |
nucleus.info.list | ADMIN | If granted, the player can run /info -l to see all the available info sections. |
nucleus.motd.base | USER | Allows the user to run the command /motd |
nucleus.motd.login | USER | If granted, the user will see the MOTD when joining the server. |
info { # If "use-default-info-section" is true, this section is displayed when a player runs "/info", not the section list. default-info-section=info # If true, when a player runs "/info", the section specified in "default-info-section" will be used, that is, /info will work the same as /info <default-section>. # The list of sections can still be viewed by running "/info -l", if the user has the "nucleus.info.list" permission. If false, or the section does not exist, this list is shown, regardless of this permission. use-default-info-section=false } motd { # The amount of time to wait (in seconds) before sending the MOTD to a player who has just logged in. motd-login-delay=0.5 # The title to show at the top of each MOTD page. Colour codes are supported. If blank, this hides the title completely. motd-title=MOTD # If true, show players the MOTD as defined in "motd.txt" when they log onto the server. show-motd-on-join=true # If false, this disables the pagination system for the MOTD. Set this to false if you have one page, do not want a title, and do not want the << >> marks to appear, otherwise, it is recommended to set this to true. use-pagination=true }