Skip to content

Configuration

Main configuration (config.yml)

Every key of sofyCore's config.yml explained, from the language and server name to tags, playtime and the module switches.

Default file

config.ymlYAML
config-version: 18
language: es
identity:
  display-name: sofyCore
  command-alias: sofycore
server:
  # Empty: generate server-xxxxxx once and save it here. Custom names are allowed.
  id: ''
  # Internal ownership token. Do not edit or copy it to another server.
  instance-id: ''
storage:
  persistence:
    provider: MONGODB # MONGODB, MYSQL, MARIADB, SQLITE
    mongodb:
      uri: mongodb://localhost:27017
      database: sofycore
    mysql:
      host: localhost
      port: 3306
      database: sofycore
      username: sofycore
      password: ''
      tls: false
    mariadb:
      host: localhost
      port: 3306
      database: sofycore
      username: sofycore
      password: ''
      tls: false
    sqlite:
      file: storage/sofycore.db
  redis:
    uri: redis://localhost:6379
    key-prefix: 'sofycore:'
  cache:
    ttl-seconds: 300
  pool:
    maximum-size: 8
    workers: 4
    queue-capacity: 256
    timeout-ms: 5000
    health-interval-seconds: 30
tags:
  max-visible-length: 32
playtime:
  command: playtime
  aliases: [pt]
  checkpoint-seconds: 300
modules:
  moderation:
    enabled: false
  ranks:
    enabled: false
  # ... one block per module, see "Module switches"

General keys

KeyDescription
languageen or es: language of the core messages
identity.command-aliasRoot command name. Requires a restart to change
server.idUnique server name in the network. Empty generates server- plus six hex characters
server.instance-idInternal token that identifies this installation. Never edit or copy it
tags.max-visible-lengthMaximum visible length of tags (32 by default). Applied on restart
playtime.command / aliasesName and aliases of /playtime. Requires a restart
playtime.checkpoint-secondsSeconds between durable playtime saves (60–3600, default 300)

Server name rules

Custom names may have 1–64 printable characters, including inner spaces and Unicode, without leading or trailing spaces. They are case-sensitive; quote them in YAML if they contain special characters. A name that is already taken disables the core without changing it. To generate a new name, leave server.id empty and restart.