Skip to content

Configuration

Configuration overview

How sofyCore organizes its configuration files, what lives in YAML and what lives in the database, and how per-module reloads work.

Where settings live

LocationContents
config.ymlLanguage, command alias, server name, storage, tags, playtime and module switches
Module YAML filesLocal behavior of each module (chat.yml, ranks.yml, staff.yml, menus.yml, scoreboard.yml...)
lang/Every message, in English and Spanish, fully editable
DatabaseNetwork-wide data: ranks, sanctions, moderation settings, boss bars, VIP shop templates, tags
RedisShared cache, presence and network announcements

Some modules have no YAML: moderation settings and boss bars are stored in the database and edited with commands, so they are the same on every server.

Reloading

Reload a single module with /sofycore module <module> reload. The reload:

  1. removes the module's service from the API and cancels its tasks;
  2. reads config.yml from disk and, if the module is enabled, its own YAML;
  3. restarts only that module; the others keep their state in memory.

If the file is invalid, the module stays off and the console shows the reason. Fixing the file and running the same reload again tries to start it.

Command alias

identity.command-alias in config.yml sets the root command name (default sofycore). Changing it requires a restart.