📁 Main Configuration

On this page, you will find everything you need to know about the config.yml options of Phoenix Lobby

#Database

The plugin also supports databases. The available options are mysql and sqlite.

database:
  type: sqlite
  address: localhost
  name: phoenixlobby_db
  port: 3306
  username: phoenixuser
  password: phoenixpassword
  table-prefix: pl
  hikari:
    maximumPoolSize: 20
    minimumIdle: 5
    idleTimeout: 600000
    maxLifetime: 1800000
    connectionTimeout: 30000
    fetch-timeout: 5000
performance:
  internal-pool-size: 5

Set a different table-prefix on every server that shares the same database, so their tables do not mix.

The hikari block is the connection pool, and it only matters on MySQL. The defaults suit a normal lobby; raise maximumPoolSize only if you are running a very large network off one database.

performance.internal-pool-size is separate from that — it is the number of threads the plugin uses for its own background work, such as saving player data and looking addresses up. Leave it alone unless support asks you to change it.

#General Options

Option	Description
`product-license`	Your license key, written by the plugin, see Licensing
`notify-if-new-version`	Tells your admins when a new version is out
`language`	The language the plugin speaks, see Languages
`debug`	Prints extra information in the console
`bypass-required`	Requires `/plobby bypass` before an admin can build in the lobby
`proxy.register-lobby`	Registers this server as a lobby on the proxy
`npcs.render-radius`	The distance past which NPCs and their effects stop being drawn

#Worlds

This is the single most important option in the file. It decides which worlds the plugin treats as a lobby, and it covers every module at once — the scoreboard, the tablist, the hotbar items, the world protection and the inventory clearing.

worlds:
  should-use: DISABLED_WORLDS
  enabled: []
  disabled:
  - world_nether

With DISABLED_WORLDS, every world is a lobby except the ones you list under disabled. With ENABLED_WORLDS, only the worlds under enabled are.

Out of the box the plugin treats every world as a lobby. A server that holds more than the lobby world should switch to ENABLED_WORLDS and name its lobby, which is step one of the Multiverse setup.

The hotbar items have a worlds block of their own in lobby-items.yml, which only decides where the items are handed out. That one is narrower and separate from this.

#Messages Configuration

Every line the plugin can print lives in translations/translations.en.yml inside the PhoenixLobby folder — messages to players, command replies and the in-game editor alike.

To prevent a message from appearing, set it to '' (empty quotes).

Older versions kept this in messages.yml. On the first start after upgrading, your text is moved across on its own and the old file is renamed to old_messages.yml. See Where did my messages.yml go?

#MiniMessage

On top of the usual & colour codes, text accepts MiniMessage tags for gradients, hover text and clickable links. It has its own page: Rich Text (MiniMessage).

#Translations

The plugin can be run in another language, and the file above is the one you translate. How the language is picked, what falls back to English and how the %prefix% placeholder works are all on Languages & Translations.

Last updated 27 minutes ago