Configuration

Index The config.yml is divided into 3 sections:

• General
• Optimization
• World

General

---

prefix: '&8[&3WorldSystem&8] &6'

You can change the prefix that is displayed before each message from this plugin.

worldfolder: 'plugins/WorldSystem/Worlds'

Sometimes you don't want the worlds to be saved in your plugins folder. This option allows you to change that.

language: en

Here you can select a language. The plugin already offers the following languages:

• de Deutsch
• en English
• es Español
• fi Suomen kieli
• fr Français
• hu Magyar nyelv
• ja 日本語 (Nihongo)
• nl Nederlands
• pl Polski
• ru Русский язык (Russkiĭ âzyk)
• zh 汉语; 漢語 (Hànyǔ)

You can also create your own language by creating a mylang.yml and moving it to the other language files in plugins/WorldSystem/languages/.
After setting your messages, you can set language: mylang.

need_confirm: true

If a confirmation is needed before auto-update.

Important

The plugin auto updater is broken, so this has no effect.

contact_authserver: true

Whether WorldSystem should contact the Mojang auth server.
If set to false, some unknown player names will not be displayed in the gui or in /ws info.

spawn:
  gamemode: 2
  spawnpoint:
    use_last_location: true
    world: world
    x: 0
    y: 20
    z: 0
    yaw: 0
    pitch: 0

Location to which the player is teleported when leaving a WorldSystem world.
This is usually a lobby or a hub. The gamemode has the following options:

• 0 Survival
• 1 Creative
• 2 Adventure
• 3 Spectator

request_expires: 20

Time in seconds until a request expires.

Optimization

---

Caution

Please look into our FAQ first, before you continue with optimization!

load_worlds_async: false

If WorldSystem should load the worlds async if possible (FAWE installed)

unloadingtime: 20

When nobody is on a world time until it get unloaded

delete_after: -1

Time in days after a not used world will be deleted Set to -1 to disable

lagsystem:
  period_in_seconds: 10
  entities_per_world: 350
  garbagecollector: 
    use: false
    period_in_minutes: 5

The lag system helps to reduce lags.

• period_in_seconds sets how will often be checked for entities in seconds
• entities_per_world sets maximal allowed entities per world
• garbagecollectorsets how often will be unused ram be cleared

database:
  type: sqlite
  worlds_table_name: worlds_positions
  players_table_name: player_positions
  players_uuids: players_uuids

  sqlite_settings:
    file: 'plugins/WorldSystem/repository.db'

  mysql_settings:
    host: 127.0.0.1
    port: 3306
    username: root
    password: YOUR_PASSWORD_HERE
    database: databaseName

You can use the database option to save player positions.
First, you need to specify the database type, that you want to use.
You can choose between mysql and sqlite.

Important

You need to create a database first to use the MySQL database type.

Now you need to set the names for the tables in the database:

• The worlds_table_name: name is for player positions in WorldSystem worlds
• The players_table_name: name is for player positions in normal worlds
• The players_uuids: name is for the player UUIDs cache

sqlite_settings:
  file: 'plugins/WorldSystem/repository.db'

Under that point, you can set the file location and name of your SQLite.

mysql_settings:

Under that point, you can configure your MySQL connection if you have one.

World

---

survival: false

If survival is set to true nobody can teleport or change their gamemode in a WorldSystem world.
Players that have the permission: ws.gamemode or/and ws.tp.* set to true will not be affected.

spawn_teleportation: true

Players will be teleported to the spawn on join if set to true

worldspawn:
  use_last_location: true
  use: false
  spawnpoint:
    x: 0
    y: 20
    z: 0
    yaw: 0
    pitch: 0

Sets the default spawn point if a player joins a WorldSystem world

Warning

use_last_location option might not work, we are already on the way to fix that

worldtemplates:

Well, to set up simple world templates go here

generator:
  seed: 0
  environment: NORMAL 
  type: NORMAL 
  generator: ''

Important

The generator option is part of the world template feature

Option to generate customized worlds for random world generation instead of world copies

seed: 0 

With that, you can set a specific world seed that should be used.
To disable it, you can set it to 0.

environment: NORMAL

Here you can set what dimension that world should be.
Available options are:

• NORMAL - Overworld
• NETHER - Nether
• THE_END- End

type: NORMAL

Type of the world generator:

• NORMAL > Default world
• FLAT > Flat world
• AMPLIFIED > Amplified world
• LARGE_BIOMES > World with large biomes

generator: ''

Put in here the name of a generator, if you have a generator plugin installed (like voidgen or iris)