ReportSystem configuration
The ReportSystem 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/ReportSystem/config.json then reload the plugin or restart the server. Keep a backup before large changes.
Every setting
General
- Debug togglefalse
- Debug: true adds extra ArkApi.log lines while you test. Keep it false day to day.
- AutosaveSeconds number30
- AutosaveSeconds: how often the plugin saves the report queue to disk, in seconds. 30 works well. Lower saves more often, higher saves less.
Commands
Commands: what players and staff type in chat. Change a word, or set it to "" to switch that one off.
- ReportCMD text"/report"
- report a player: /report <name> <what happened>
- TicketCMD text"/ticket"
- open a general ticket: /ticket <your message>
- MyReportsCMD text"/myreports"
- show a player their own reports and the status of each
- StaffListCMD text"/reports"
- staff only. Lists open reports in game. Needs the staff node.
Reports
Reports: the rules for filing and handling.
- CooldownSeconds number120
- CooldownSeconds: how long a player must wait between reports or tickets. This stops spam. 120 means one every two minutes. Set to 0 to turn the wait off.
- MinReasonLength number3
- MinReasonLength: the shortest reason or ticket message the plugin will take. This blocks empty or one letter reports. 3 means the reason must be at least three characters.
- LogCoords toggletrue
- LogCoords: set to true to save the map spot of the target and the reporter with the report. This helps staff find the trouble fast. Set to false to leave coords out.
- ThankReporter toggletrue
- ThankReporter: set to true to tell the player their report was sent. Set to false to stay quiet.
- NotifyReporterOnClose toggletrue
- NotifyReporterOnClose: set to true to tell the reporter, if they are online, when staff close their report. It is a nice touch that shows players their reports get read.
- KeepClosedDays number14
- KeepClosedDays: how long a closed report stays in the file before it is cleaned up. 14 means closed reports are kept for two weeks. Set to 0 to keep them forever.
- ListCount number15
- ListCount: how many rows the staff list and the console list show.
- EscalateAtReports number3
- EscalateAtReports: when this many open reports pile up on one player inside the window below, staff get a loud @here alert. 3 means three reports on the same player triggers it. Set to 0 to turn escalation off.
- EscalateWindowMinutes number30
- EscalateWindowMinutes: the time window for the count above, in minutes. 30 means the reports must land within half an hour of each other to trigger the alert.
Permissions
Permissions: gate the in game staff list. Needs Permissions.dll.
- Enabled toggletrue
- Enabled: set to true to check Permissions for the staff list. The console and RCON staff commands are always open, since they are already admin only.
- StaffPermission text"ReportSystem.Staff"
- StaffPermission: the permission node a player needs to use the in game /reports list. If Permissions is missing, the in game list is closed and staff use the console or RCON.
Discord
Discord: post reports and tickets to a staff channel through a webhook.
- Enabled togglefalse
- Enabled: true starts sending posts to Discord. False means reports stay in game only.
- WebhookURL textempty
- WebhookURL: the Discord webhook for the staff channel. Every report and ticket goes here.
- AlertWebhookURL textempty
- AlertWebhookURL: an extra webhook for the loud alerts (a player getting many reports). Leave it "" and those go to WebhookURL too.
- Username text"ReportSystem"
- Username: what name shows on the posts in Discord.
- ServerName text"My ARK Server"
- ServerName: the footer on each report post. Name your server here.
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.
{
// ReportSystem settings, with notes. The plugin never reads this copy.
// The notes break JSON, so make your changes in config.json, not here.
"General": {
// Debug: true adds extra ArkApi.log lines while you test. Keep it false day to day.
"Debug": false,
// AutosaveSeconds: how often the plugin saves the report queue to disk, in seconds.
// 30 works well. Lower saves more often, higher saves less.
"AutosaveSeconds": 30
},
// Commands: what players and staff type in chat. Change a word, or set it to "" to switch that one off.
"Commands": {
"ReportCMD": "/report", // report a player: /report <name> <what happened>
"TicketCMD": "/ticket", // open a general ticket: /ticket <your message>
"MyReportsCMD": "/myreports", // show a player their own reports and the status of each
"StaffListCMD": "/reports" // staff only. Lists open reports in game. Needs the staff node.
},
// Reports: the rules for filing and handling.
"Reports": {
// CooldownSeconds: how long a player must wait between reports or tickets. This stops spam.
// 120 means one every two minutes. Set to 0 to turn the wait off.
"CooldownSeconds": 120,
// MinReasonLength: the shortest reason or ticket message the plugin will take. This blocks
// empty or one letter reports. 3 means the reason must be at least three characters.
"MinReasonLength": 3,
// LogCoords: set to true to save the map spot of the target and the reporter with the report.
// This helps staff find the trouble fast. Set to false to leave coords out.
"LogCoords": true,
// ThankReporter: set to true to tell the player their report was sent. Set to false to stay quiet.
"ThankReporter": true,
// NotifyReporterOnClose: set to true to tell the reporter, if they are online, when staff
// close their report. It is a nice touch that shows players their reports get read.
"NotifyReporterOnClose": true,
// KeepClosedDays: how long a closed report stays in the file before it is cleaned up.
// 14 means closed reports are kept for two weeks. Set to 0 to keep them forever.
"KeepClosedDays": 14,
// ListCount: how many rows the staff list and the console list show.
"ListCount": 15,
// EscalateAtReports: when this many open reports pile up on one player inside the window
// below, staff get a loud @here alert. 3 means three reports on the same player triggers it.
// Set to 0 to turn escalation off.
"EscalateAtReports": 3,
// EscalateWindowMinutes: the time window for the count above, in minutes. 30 means the
// reports must land within half an hour of each other to trigger the alert.
"EscalateWindowMinutes": 30
},
// Permissions: gate the in game staff list. Needs Permissions.dll.
"Permissions": {
// Enabled: set to true to check Permissions for the staff list. The console and RCON
// staff commands are always open, since they are already admin only.
"Enabled": true,
// StaffPermission: the permission node a player needs to use the in game /reports list.
// If Permissions is missing, the in game list is closed and staff use the console or RCON.
"StaffPermission": "ReportSystem.Staff"
},
// Discord: post reports and tickets to a staff channel through a webhook.
"Discord": {
// Enabled: true starts sending posts to Discord. False means reports stay in game only.
"Enabled": false,
// WebhookURL: the Discord webhook for the staff channel. Every report and ticket goes here.
"WebhookURL": "",
// AlertWebhookURL: an extra webhook for the loud alerts (a player getting many reports).
// Leave it "" and those go to WebhookURL too.
"AlertWebhookURL": "",
// Username: what name shows on the posts in Discord.
"Username": "ReportSystem",
// ServerName: the footer on each report post. Name your server here.
"ServerName": "My ARK Server"
}
}