Skip to content
NordBots.
Back to AutoBroadcast

AutoBroadcast configuration editor

Set everything with sliders and toggles, then export your config.json. Your progress saves in this browser as you go. See the docs for what each setting does.

Ready to edit

Templates

Save the current settings as a named template, then load it any time. Stored in this browser.

No templates yet.

General

Debug

Debug: set to true to write extra lines to ArkApi.log. Turn it on when something is not working and you want to see why. Leave it false for normal play.

ServerName

ServerName: your server name. It shows up when a message uses the {server} tag. If you also set ServerName in the Discord block, that one wins for embeds.

Commands

Commands: the words people type in chat.

ListChat

ListChat: the chat command that shows the list of broadcasts and if each is on. Only admins can use it (see the Permissions block). Set it to "" to turn it off.

Messages

Messages: your list of broadcasts. Each one has its own text, its own timing, and its own targets. You can have as many as you want. Add or remove blocks in the [ ] list. Every message needs a Name and a Schedule.

Database

Database: the plugin saves a row every time a message goes out. You get a full history of what was sent and when. This works with SQLite (a local file, no setup) or MySQL (a shared database).

UseMySQL

UseMySQL: false uses a local SQLite file. Set it to true to use MySQL and fill in the Host, User, Password, and Database below.

LogSends

LogSends: set to false to skip saving any log rows. Broadcasts still run.

Host

Host, Port, User, Password, Database: only needed when UseMySQL is true.

Port

User

Password

Database

TableName

TableName: the base name for the log table. The plugin adds "_log" to it, so the table is "AutoBroadcast_log" by default.

SQLiteDatabasePath

SQLiteDatabasePath: leave it empty to keep the file next to the plugin. Or set a full path to put the file somewhere else.

Permissions

Permissions: gate the admin commands. When Permissions.dll is installed and this is on, only players with the node below can use /broadcasts. The console and RCON commands are always for server operators.

Enabled

Enabled: set to false to skip Permissions checks.

AdminPermission

AdminPermission: the permission node a player needs to use the admin commands.

Discord

Discord: the webhook that gets embeds. Off by default. Every message that has "Discord": { "Enabled": true } posts here.

Enabled

Enabled: turn Discord posting on. You must also set a WebhookURL.

WebhookURL

WebhookURL: paste your Discord channel webhook URL here.

AlertWebhookURL

AlertWebhookURL: a second webhook for odd events. Leave it empty to send everything to the main WebhookURL.

Username

Username: the name the webhook posts under.

ServerName

ServerName: shows in the embed footer. Handy when you run more than one server.