Common Configuration
Every Bytemart plugin is configured through a config.json file located in the
plugin's own folder:
The keys below appear at the top level of that file and behave identically in every plugin. Individual plugin pages document only the keys that are unique to them and link back here for these shared ones.
💡 Validate your JSON. A single misplaced comma or quote will stop a plugin from loading. After every edit, run your config through a validator such as JSONLint. A load error code of
1114almost always means a JSON syntax error.
LicenseKey
Your Bytemart license key. Required. The plugin authenticates this key against the Bytemart licensing server on startup, and none of its features activate until authentication succeeds. Find your key on your Bytemart Dashboard.
| Field | Type | Default | Description |
|---|---|---|---|
LicenseKey |
string | — | The license key issued for your plugin. Keep it private. |
Verbose
Enables verbose plugin logging. When true, the plugin prints extra diagnostic
output to the server console — useful when troubleshooting, noisy otherwise. Leave
it false in normal operation.
| Field | Type | Default | Description |
|---|---|---|---|
Verbose |
boolean | false |
Enable verbose (debug-level) console logging. |
LogToFile
When true, the plugin mirrors everything it logs to a rotating log file inside
its own folder:
The file rotates automatically (roughly 5 MB per file, up to 3 files kept). Only that one plugin's output is written — the shared ArkApi/server log is never modified. This makes it easy to isolate a single plugin's activity when diagnosing an issue.
| Field | Type | Default | Description |
|---|---|---|---|
LogToFile |
boolean | false |
Mirror this plugin's logs to its own rotating .log file. |
Database
MySQL connection credentials. Plugins that persist data (leaderboards, cooldowns, transactions, …) connect to your MySQL/MariaDB server using these values and create the tables they need on first run. Point every plugin at the same database unless you have a specific reason to separate them.
| Field | Type | Default | Description |
|---|---|---|---|
MysqlHost |
string | localhost |
Hostname or IP of your MySQL/MariaDB server. |
MysqlPort |
number | 3306 |
Server port. |
MysqlUser |
string | — | Username with access to the database. |
MysqlPass |
string | — | Password for that user. |
MysqlDB |
string | — | Name of the database to use. It must already exist; the plugin creates its own tables inside it. |
⚠️ The database must exist. Plugins create their tables automatically, but they do not create the database itself. Create the schema named in
MysqlDBand grant the userSELECT,INSERT,UPDATE,DELETE, andCREATEpermissions on it before starting the server.