Skip to main content
Version: Next 🚧

config.yml reference

plugins/ProjectOne/config.yml
# Configuration version. Do not edit — used to migrate the file.
config-version: 1

enabled-worlds:
- world
- world_nether

storage:
type: sqlite # sqlite | mysql
mysql:
host: localhost
port: 3306
database: projectone
username: root
password: ''

debug: false

Keys​

enabled-worlds​

  • Type: list of world names
  • Default: [world, world_nether]

Worlds the plugin acts in. An empty list disables it everywhere, which is a useful way to turn the plugin off without removing the jar.

storage.type​

  • Type: sqlite | mysql
  • Default: sqlite

sqlite writes to plugins/ProjectOne/data/, and is right for a single server. Use mysql when several servers in a network must share data.

Switching storage does not migrate data

Changing storage.type starts from an empty database. Export first if you need to keep existing data.

storage.mysql.*​

Only read when storage.type is mysql. Leave the password empty in the file and set it through an environment variable if your host supports it — config.yml often ends up in pasted logs.

debug​

  • Type: boolean
  • Default: false

Verbose logging. Turn it on before reporting a bug and include the output; leave it off in normal operation as it is noisy.

Applying changes​

/projectone reload

Reloads config.yml and messages.yml. Storage settings need a full server restart — connection pools are created at startup.

Document defaults, not just names

Every key above lists a type and a default. A reference that only names keys sends server owners to your source code, which is where bug reports come from.