Skip to content
NordBots.
Back to PlayerNotes

PlayerNotes configuration

The PlayerNotes config.json controls how the plugin runs on your Ark Survival Ascended server. Every setting is listed below with what it does and its default value.

Open the configuration editorPrefer clicking to typing? Build the file with sliders and toggles.

Where it lives

Drop the file on your server at ArkApi/Plugins/PlayerNotes/config.json then reload the plugin or restart the server. Keep a backup before large changes.

Every setting

General

Debug
togglefalse
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
text"/note"
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
number20
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
number200
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
toggletrue
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
toggletrue
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
textempty
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
text"PlayerNotes.Admin"
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
togglefalse
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
textempty
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
text"PlayerNotes"
TableName: the table the notes live in. Change it only if it clashes with another table.
Host
text"127.0.0.1"
The keys below matter only when UseMySQL is true. Host: the MySQL server address.
Port
number3306
Port: the MySQL port. 3306 is the normal one.
User
textempty
User and Password: the MySQL login.
Password
textempty
Database
textempty
Database: the MySQL database name to use.
MysqlSSLMode
number-1
MysqlSSLMode: leave it -1 for the default. Change it only if your host needs a set SSL mode.
MysqlTLSVersion
textempty
MysqlTLSVersion: leave it "" for the default. Set a TLS version only if your host needs one.

The full commented config

This is a reading copy with notes. It is not valid JSON, so do not load it. Use the editor or the plain config.json instead.

{
  // PlayerNotes help sheet. Every key from config.json is written out below with a note.
  // The notes make this a bad JSON file, so the server can not read it.
  // Your real changes belong in config.json.

  "General": {
    // 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.
    "Debug": false
  },

  // Commands: the word players type. Rename it if you like.
  "Commands": {
    // 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
    "NoteCMD": "/note"
  },

  // Notes: the limits.
  "Notes": {
    // 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).
    "MaxNotesPerPlayer": 20,

    // 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.
    "MaxNoteLength": 200,

    // 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.
    "AllowCoords": true
  },

  // Permissions: gate who can use notes. Needs Permissions.dll.
  "Permissions": {
    // 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.
    "Enabled": true,

    // 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).
    "UsePermission": "",

    // AdminPermission: kept for later. The admin wipe command runs from the trusted console now.
    "AdminPermission": "PlayerNotes.Admin"
  },

  // Database: where notes are saved. SQLite needs no setup. MySQL is for sharing across servers.
  "Database": {
    // 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.
    "UseMySQL": false,

    // 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.
    "SQLiteDatabasePath": "",

    // TableName: the table the notes live in. Change it only if it clashes with another table.
    "TableName": "PlayerNotes",

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

    // Port: the MySQL port. 3306 is the normal one.
    "Port": 3306,

    // User and Password: the MySQL login.
    "User": "",
    "Password": "",

    // Database: the MySQL database name to use.
    "Database": "",

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

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