Welcome to the new docs site for Nucleus v2! Still on Nucleus v1? Visit the old site here.

Note Module

Introduction

The notes module allows for notes to be added to other users to keep track of information. Users with permission can add notes to users and the added notes can then be checked using the /checknotes command.

Players will never see notes about them.

Adding and reading player notes

The /note <player> <note> command adds a note to a player, which can be read using the /checknotes <player> command.

Removing notes

To remove a note, the /checknotes command provides a link to do so. Otherwise, after getting a note’s ID, you can use that as a the index to the /removenote <user> <index> command.

To delete all of a user’s notes, use the /clearnotes <user> command.

Configuration options

show-login - If true, users with the permission nucleus.note.showonlogin will be shown a user’s notes when they login.

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.

/checknotes
Module: note
Allows the user to check a player's notes.

Aliases: /checknotes, /notes

Usage: /checknotes <user>

Default Role: staff

Basic Command Permission: nucleus.note.base

Permissions

  • nucleus.note.base - Default Role: staff
    Allows the user to run the command /note
/clearnotes
Module: note
Allows the user to clear a player's notes.

Aliases: /clearnotes, /removeallnotes

Usage: /clearnotes <user>

Default Role: admin

Basic Command Permission: nucleus.clearnotes.base

Permissions

  • nucleus.clearnotes.base - Default Role: admin
    Allows the user to run the command /clearnotes
/note
Module: note
Allows the user to add a note to a player.

Aliases: /note, /addnote

Usage: /note <user> <message…>

Default Role: staff

Basic Command Permission: nucleus.note.notify.base

Permissions

  • nucleus.note.notify - Default Role: staff
    Notifies the user about notes when they occur.
  • nucleus.note.showonlogin - Default Role: staff
    Allows user to see other users notes when they login.
/removenote
Module: note
Allows the user to delete a specific note attached to a player.

Aliases: /removenote, /deletenote, /delnote

Usage: /removenote <user> <ID>

Default Role: admin

Basic Command Permission: nucleus.removenote.base

Permissions

  • nucleus.removenote.base - Default Role: admin
    Allows the user to run the command /removenote
Permission Suggested Role Description
nucleus.checknotes.base staff Allows the user to run the command /checknotes
nucleus.clearnotes.base admin Allows the user to run the command /clearnotes
nucleus.note.base staff Allows the user to run the command /note
nucleus.note.notify staff Notifies the user about notes when they occur.
nucleus.note.showonlogin staff Allows user to see other users notes when they login.
nucleus.removenote.base admin Allows the user to run the command /removenote
The following configuration is the default for this module:
                            # If true, users with the permission nucleus.note.showonlogin will be shown a users notes when they login. If false, they will not.
show-login=true

                        
Search

Downloading search database, this won't take long...