Skip to content

Configuration

Innectic edited this page Nov 9, 2026 · 1 revision

Configuration

File: plugins/Dimensify/config.yml.

storage: sqlite
connection:
  host: localhost
  port: 3306
  database: dimensify
  username: dimensify
  password: change-me
  file: dimensify.db

send_players_to_default_world_on_login: false
permission_restrict_dimensions: false
default_dimension_restriction: true

preload_worlds: false
world_preload: []

inventories:
  enabled: false
  separate:
    - inventory
    - ender-chest
    - experience
    - health
    - hunger
    - potion-effects

The password above is an example; use your database credentials for MySQL.

Storage

Backend Configuration
SQLite storage: sqlite; connection.file names the database file inside the plugin folder
MySQL storage: mysql; configure host, port, database, username and password
Flat file storage: flatfile; registry and named portals use storage.yml

Create the MySQL database before starting the plugin. SQLite is the default. Spigot loads the declared SQLite and MySQL drivers through the plugin library loader.

Changing the backend or connection settings requires a server restart. Choosing another backend does not copy data between backends.

Login and access

send_players_to_default_world_on_login sends joining players to the world selected with /dimensify default <world>. It does not choose the death-respawn world.

permission_restrict_dimensions enables allow-list style world entry when default_dimension_restriction is false. The latter controls entry when no world allow rule exists. Explicit world-deny rules take priority. See World Access.

Startup loading

Registered worlds use their autoload property in worlds.yml:

/dimensify modify survival autoload true

Newly created/imported worlds and worlds captured from the running server start with autoload enabled. preload_worlds and world_preload are used when migrating old registry entries without existing world settings. After migration, change the per-world property rather than the old preload list.

World settings

plugins/Dimensify/worlds.yml stores generation options, properties, dimension links and anchors for every backend. An excerpt:

worlds:
  survival:
    type: DEFAULT
    environment: NORMAL
    seed: '42'
    structures: true
    autoload: true
    difficulty: HARD
    pvp: true
    inventory-group: survival
    nether: survival_nether
    end: survival_the_end
    gamerules:
      keep_inventory: 'false'

Use commands to register or unregister worlds. Edit properties in place rather than replacing the whole file with this excerpt. Commands save their changes automatically.

Reloading

/dimensify reload
/dimensify cache purge

reload reloads configuration, world settings and backend caches, then applies properties to loaded worlds. cache purge reloads only backend caches.

Malformed YAML and invalid world properties are rejected. A running clone must finish before reloading. Inventory enablement and separated fields require no players online; group changes require affected worlds to be empty. See Inventory Groups.

Files

Location inside the plugin folder Purpose
config.yml Global settings and connection configuration
worlds.yml Per-world options, properties, links and anchors
dimensify.db Default SQLite registry and portals database
storage.yml Flat-file registry and portals, when selected
players/<uuid>.yml Inventory-group player snapshots
backups/ Original world folders from deletion and regeneration

See Backups and Recovery and Upgrading to v1.1.0.

Clone this wiki locally