Skip to content
NordBots.
Back to PlayerNotes

PlayerNotes configuration editor

Set everything with sliders and toggles, then export your config.json. Your progress saves in this browser as you go. See the docs for what each setting does.

Ready to edit

Templates

Save the current settings as a named template, then load it any time. Stored in this browser.

No templates yet.

General

Debug

Debug: flip to true if you want the log to show more detail while you sort out a problem. Turn it back off when you are done.

Commands

Commands: the word players type. Rename it if you like.

NoteCMD

NoteCMD: the base command. Players use it like: /note add <text> save a note /note here <label> save your current spot with a label /note list show your notes with numbers /note delete <n> remove note number n /note clear remove all your notes

Notes

Notes: the limits.

MaxNotesPerPlayer

MaxNotesPerPlayer: the most notes one player can keep. This stops the table from growing forever. 20 is plenty. Set to 0 for no limit (not advised).

MaxNoteLength

MaxNoteLength: the longest a single note can be, in characters. Text past this is cut off. 200 is a good size. Set to 0 for no limit.

AllowCoords

AllowCoords: set to true to allow /note here, which saves the player's current map spot. Set to false to turn that off and keep notes as plain text only.

Permissions

Permissions: gate who can use notes. Needs Permissions.dll.

Enabled

Enabled: true tells the plugin to ask Permissions who is allowed. When it is off, or when Permissions.dll is not loaded, every player gets to use notes.

UsePermission

UsePermission: leave it "" so everyone can use notes. Set a node here to limit notes to players who have it (for example a VIP only feature).

AdminPermission

AdminPermission: kept for later. The admin wipe command runs from the trusted console now.

Database

Database: where notes are saved. SQLite needs no setup. MySQL is for sharing across servers.

UseMySQL

UseMySQL: set to false for SQLite (a local file, zero setup, great for one server). Set to true to use a MySQL server instead, which lets many servers share one notes table.

SQLiteDatabasePath

SQLiteDatabasePath: only used when UseMySQL is false. Leave it "" to keep the file next to the plugin as PlayerNotes.db. Set a full path to put it somewhere else.

TableName

TableName: the table the notes live in. Change it only if it clashes with another table.

Host

The keys below matter only when UseMySQL is true. Host: the MySQL server address.

Port

Port: the MySQL port. 3306 is the normal one.

User

User and Password: the MySQL login.

Password

Database

Database: the MySQL database name to use.

MysqlSSLMode

MysqlSSLMode: leave it -1 for the default. Change it only if your host needs a set SSL mode.

MysqlTLSVersion

MysqlTLSVersion: leave it "" for the default. Set a TLS version only if your host needs one.