JoinLeaveLog configuration
The JoinLeaveLog 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/JoinLeaveLog/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.
- AutosaveSeconds number30
- AutosaveSeconds: how often the plugin saves playtime data to disk. 30 means every 30 seconds. A smaller number saves more often.
- ServerName text"My ARK Server"
- ServerName: your server name. It shows in the welcome message and the Discord footer.
Commands
Commands: the words players type in chat. Rename them or set one to "" to turn it off.
- OnlineCMD text"/online"
- show who is on and for how long.
- PlayedCMD text"/played"
- show your own total playtime and visit count.
Game
Game: what shows up in game.
- AnnounceJoinToAll togglefalse
- AnnounceJoinToAll: set to true to tell the whole server when a player joins. Most owners leave this false and keep joins in Discord to avoid chat spam.
- AnnounceLeaveToAll togglefalse
- AnnounceLeaveToAll: same idea, for when a player leaves.
- WelcomeBack toggletrue
- WelcomeBack: send a private hello to the player when they join. New players get a welcome line. Returning players get their total playtime and visit count.
- MilestoneHours list[10,50,100,500]
- MilestoneHours: total played hours that earn a shout out. When a player crosses one of these on their way out, the server and Discord call it out. Set it to an empty list [] to turn milestones off.
- AnnounceMilestones toggletrue
- AnnounceMilestones: set to false to keep milestones in Discord only, with no in game shout.
Permissions
Permissions: gate the staff view. Needs the Permissions plugin to do anything.
- Enabled toggletrue
- Enabled: set to false to skip Permissions checks.
- StaffOnlyOnline togglefalse
- StaffOnlyOnline: set to true so only players with the "JoinLeaveLog.Staff" node can use the /online command. Leave it false to let everyone see who is on.
Discord
Discord: post joins, leaves, and flags to a webhook. Off by default.
- Enabled togglefalse
- Enabled: turn Discord posting on. You must also set a WebhookURL.
- WebhookURL textempty
- WebhookURL: paste your Discord channel webhook URL here.
- AlertWebhookURL textempty
- AlertWebhookURL: a second webhook for odd events like a name change. Leave it empty to send those to the main WebhookURL.
- Username text"JoinLeaveLog"
- Username: the name the webhook posts under.
- ServerName text"My ARK Server"
- ServerName: shows in the embed footer. Handy when you run more than one server.
- LogJoins toggletrue
- LogJoins and LogLeaves: turn each event on or off for Discord.
- LogLeaves toggletrue
- AlertNameChange toggletrue
- AlertNameChange: when a player joins under a new name but the same account, post a flag to the alert webhook. Great for tracking a player who tries to hide.
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,
// AutosaveSeconds: how often the plugin saves playtime data to disk.
// 30 means every 30 seconds. A smaller number saves more often.
"AutosaveSeconds": 30,
// ServerName: your server name. It shows in the welcome message and the Discord footer.
"ServerName": "My ARK Server"
},
// Commands: the words players type in chat. Rename them or set one to "" to turn it off.
"Commands": {
"OnlineCMD": "/online", // show who is on and for how long.
"PlayedCMD": "/played" // show your own total playtime and visit count.
},
// Game: what shows up in game.
"Game": {
// AnnounceJoinToAll: set to true to tell the whole server when a player joins.
// Most owners leave this false and keep joins in Discord to avoid chat spam.
"AnnounceJoinToAll": false,
// AnnounceLeaveToAll: same idea, for when a player leaves.
"AnnounceLeaveToAll": false,
// WelcomeBack: send a private hello to the player when they join. New players get
// a welcome line. Returning players get their total playtime and visit count.
"WelcomeBack": true,
// MilestoneHours: total played hours that earn a shout out. When a player crosses
// one of these on their way out, the server and Discord call it out. Set it to an
// empty list [] to turn milestones off.
"MilestoneHours": [10, 50, 100, 500],
// AnnounceMilestones: set to false to keep milestones in Discord only, with no
// in game shout.
"AnnounceMilestones": true
},
// Permissions: gate the staff view. Needs the Permissions plugin to do anything.
"Permissions": {
// Enabled: set to false to skip Permissions checks.
"Enabled": true,
// StaffOnlyOnline: set to true so only players with the "JoinLeaveLog.Staff" node
// can use the /online command. Leave it false to let everyone see who is on.
"StaffOnlyOnline": false
},
// Discord: post joins, leaves, and flags to a webhook. Off by default.
"Discord": {
// Enabled: turn Discord posting on. You must also set a WebhookURL.
"Enabled": false,
// WebhookURL: paste your Discord channel webhook URL here.
"WebhookURL": "",
// AlertWebhookURL: a second webhook for odd events like a name change. Leave it
// empty to send those to the main WebhookURL.
"AlertWebhookURL": "",
// Username: the name the webhook posts under.
"Username": "JoinLeaveLog",
// ServerName: shows in the embed footer. Handy when you run more than one server.
"ServerName": "My ARK Server",
// LogJoins and LogLeaves: turn each event on or off for Discord.
"LogJoins": true,
"LogLeaves": true,
// AlertNameChange: when a player joins under a new name but the same account,
// post a flag to the alert webhook. Great for tracking a player who tries to hide.
"AlertNameChange": true
}
// A note on tracking: the /online list and the exact visit time work for players who
// joined after this plugin loaded. On a fresh server start that is everyone. If you
// hot reload the plugin while players are already on, they show up again once they
// rejoin. Total playtime is saved to disk, so it is not lost on a restart.
}