Configuration overview
Everything lives in plugins/Voxen/. The files are split by topic so you rarely have to
touch more than one at a time.
| File | What it controls |
|---|---|
config.yml |
server name, language, quick chat, item sharing, nicknames, command names |
storage.yml |
player data storage: SQLite or MySQL/MariaDB |
integrations.yml |
plugin hooks and the cross-server transport |
channels/*.yml |
one file per chat channel |
modules/mentions.yml |
@name mentions |
modules/moderation.yml |
cooldowns, anti-repeat, word filter, link filter, chat log |
modules/private-messages.yml |
private message formats and social spy |
modules/reports.yml |
/report, the staff queue and its dialog screens |
modules/system-messages.yml |
join, quit, death and advancement messages |
modules/helpop.yml |
/helpop, and whether it broadcasts or opens tickets |
modules/web.yml |
the built-in web panel, its accounts and permissions |
modules/party.yml |
party size and invite expiry |
modules/emotes.yml |
:heart: style shortcodes |
modules/minimessage-tags.yml |
which formatting tags players may use |
messages/*.yml |
translations, one file per language |
What is on out of the box
Section titled “What is on out of the box”A fresh install is a chat formatter and almost nothing else. Four things are live from the first start:
- the
globalchannel with itsformat, and the MiniMessage tag permissions that decide what players may type into it chat-delivery: player, so messages stay signed and vanilla chat reporting keeps working- the
[x]delete button in front of every message for staff withvoxen.mod.delete - the update checker, which logs once on startup when a newer release is out
Everything else starts off, including the parts a chat plugin is usually expected to bring. Turn on what you want:
| Feature | Where | Turn it on with |
|---|---|---|
quick prefixes like !hello |
config.yml |
quick-chat: true |
<item> and armour tags |
config.yml |
item-share.enabled: true |
/nick |
config.yml |
nicknames.enabled: true |
/msg, /r, social spy |
modules/private-messages.yml |
enabled: true |
@name mentions |
modules/mentions.yml |
enabled: true |
:heart: emotes |
modules/emotes.yml |
enabled: true |
| word filter, link filter, anti-flood, anti-repeat, slowmode | modules/moderation.yml |
enabled: true under each one |
/voxen inspect, warnings, notes, join alerts, the wrench button |
modules/moderator-tools.yml |
the switch under each one |
staff, world and server channels |
channels/*.yml |
enabled: true |
local and party channels |
channels/*.yml |
enabled: true |
modules/reports.yml |
enabled: true, then /report appears after a restart |
|
modules/helpop.yml |
enabled: true, then /helpop appears after a restart |
|
modules/mail.yml |
enabled: true, then /mail appears after a restart |
|
modules/party.yml |
enabled: true plus channels/party.yml |
|
modules/system-messages.yml |
enabled: true, then Voxen writes join and quit lines |
|
modules/web.yml |
enabled: true and an account |
|
modules/ai-moderation.yml |
enabled: true and an endpoint |
The reasoning is the same for every row: most servers already have some of this from another
plugin, and nobody should have to discover a feature by finding it fighting something they
installed on purpose. Leaving it all off keeps the commands, the database tables and the
config surface out of your way until you ask for them. Every switch takes effect with
/voxen reload, except the ones that register a command, which need a restart.
Reloading
Section titled “Reloading”/voxen reloadRereads every file above and applies it immediately. Two things are excluded:
- Command names under
commands:register once at startup, so renaming needs a restart. - The MiniPlaceholders and PlaceholderAPI expansions register once at startup, so a reload does not re-register them.
Updating the plugin
Section titled “Updating the plugin”New settings and messages are merged into your existing files on startup. Your values and your comments survive; only genuinely new keys are appended.