NewbieShield configuration
The NewbieShield 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/NewbieShield/config.json then reload the plugin or restart the server. Keep a backup before large changes.
Every setting
General
- Debug togglefalse
- Debug: set to true to write extra lines to ArkApi.log. Leave it false for normal play.
Commands
Commands: the word players type.
- StatusCMD text"/protection"
- StatusCMD: a player uses this to see how long their shield lasts.
Shield
Shield: the rules.
- Hours number24
- Hours: how long the shield lasts after a player's first ever join, in hours. 24 gives a new player one safe day. The clock starts on the first join and does not reset when they log in again. Set to 0 to turn new shields off (old shields still count down).
- ProtectStructures toggletrue
- ProtectStructures: set to true so a protected player's base can not be raided either, not just their body. Set to false to protect only the player and let their build be hit.
- DropOnAttack toggletrue
- DropOnAttack: set to true so the shield ends the instant the new player attacks another player or hits an enemy base. This stops a new player from fighting while safe. Keep it true.
Permissions
Permissions: only needed for the admin remove command. Needs Permissions.dll.
- Enabled toggletrue
- Enabled: set to true to load Permissions. The admin remove command runs from the trusted console with or without it.
- AdminPermission text"NewbieShield.Admin"
- AdminPermission: kept for later. The remove command runs from the console now.
Discord
Discord: optional log when a shield starts or ends.
- Enabled togglefalse
- Enabled: set to true to send Discord posts. Leave false to keep it in game.
- WebhookURL textempty
- WebhookURL: the Discord webhook for the channel.
- Username text"NewbieShield"
- Username: the name the webhook posts under.
- ServerName text"My ARK Server"
- ServerName: shown in the footer. Set it to your server name.
Database
Database: where shields are saved, so they survive a restart. This is needed. SQLite has zero setup. MySQL can share across servers.
- UseMySQL togglefalse
- UseMySQL: false for a local SQLite file, true for a MySQL server.
- SQLiteDatabasePath textempty
- SQLiteDatabasePath: only used when UseMySQL is false. Leave "" to keep the file next to the plugin as NewbieShield.db.
- TableName text"NewbieShield"
- TableName: the table the shields live in.
- Host text"127.0.0.1"
- The rest are only used when UseMySQL is true.
- Port number3306
- User textempty
- Password textempty
- Database textempty
- MysqlSSLMode number-1
- MysqlTLSVersion textempty
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.
{
// This file explains every setting in config.json.
// It has notes in it, so it is NOT valid JSON. Do not load this file.
// Edit config.json instead. This file is just here to help you.
"General": {
// Debug: set to true to write extra lines to ArkApi.log. Leave it false for normal play.
"Debug": false
},
// Commands: the word players type.
"Commands": {
// StatusCMD: a player uses this to see how long their shield lasts.
"StatusCMD": "/protection"
},
// Shield: the rules.
"Shield": {
// Hours: how long the shield lasts after a player's first ever join, in hours. 24 gives a new
// player one safe day. The clock starts on the first join and does not reset when they log in
// again. Set to 0 to turn new shields off (old shields still count down).
"Hours": 24,
// ProtectStructures: set to true so a protected player's base can not be raided either, not
// just their body. Set to false to protect only the player and let their build be hit.
"ProtectStructures": true,
// DropOnAttack: set to true so the shield ends the instant the new player attacks another
// player or hits an enemy base. This stops a new player from fighting while safe. Keep it true.
"DropOnAttack": true
},
// Permissions: only needed for the admin remove command. Needs Permissions.dll.
"Permissions": {
// Enabled: set to true to load Permissions. The admin remove command runs from the trusted
// console with or without it.
"Enabled": true,
// AdminPermission: kept for later. The remove command runs from the console now.
"AdminPermission": "NewbieShield.Admin"
},
// Discord: optional log when a shield starts or ends.
"Discord": {
// Enabled: set to true to send Discord posts. Leave false to keep it in game.
"Enabled": false,
// WebhookURL: the Discord webhook for the channel.
"WebhookURL": "",
// Username: the name the webhook posts under.
"Username": "NewbieShield",
// ServerName: shown in the footer. Set it to your server name.
"ServerName": "My ARK Server"
},
// Database: where shields are saved, so they survive a restart. This is needed. SQLite has zero
// setup. MySQL can share across servers.
"Database": {
// UseMySQL: false for a local SQLite file, true for a MySQL server.
"UseMySQL": false,
// SQLiteDatabasePath: only used when UseMySQL is false. Leave "" to keep the file next to the
// plugin as NewbieShield.db.
"SQLiteDatabasePath": "",
// TableName: the table the shields live in.
"TableName": "NewbieShield",
// The rest are only used when UseMySQL is true.
"Host": "127.0.0.1",
"Port": 3306,
"User": "",
"Password": "",
"Database": "",
"MysqlSSLMode": -1,
"MysqlTLSVersion": ""
}
}