Module: Note - Module ID: note

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.

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

Aliases: checknotes notes

Root command aliases: /nchecknotes

Usage: /checknotes <subject>

Default Role: MOD

Basic Command Permission: nucleus.checknotes.base

Permissions

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

Aliases: clearnotes removeallnotes

Root command aliases: /nclearnotes

Usage: /clearnotes <subject>

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

Root command aliases: /nnote

Usage: /note <user> <message…>

Default Role: MOD

Basic Command Permission: nucleus.note.base

Permissions

  • nucleus.note.base - Default Role: MOD
    Allows the user to run the command /note
  • nucleus.note.notify - Default Role: MOD
    Notifies the user about notes when they occur.
/removenote
Module: note
Allows the user to delete a specific note attached to a player.

Aliases: removenote deletenote delnote

Root command aliases: /nremovenote

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 MOD Allows the user to run the command /checknotes
nucleus.clearnotes.base ADMIN Allows the user to run the command /clearnotes
nucleus.note.base MOD Allows the user to run the command /note
nucleus.note.notify MOD Notifies the user about notes when they occur.
nucleus.note.showonlogin MOD 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