Skip to content

3 ‐ Wiki Configuration ‐ Skyllia

Euphyllia edited this page Oct 7, 2024 · 2 revisions

Wiki Configuration - Skyllia

config.toml

config-version

  • Description: Indicates the version of the configuration used.
  • Value: 3

verbose

  • Description: Enables or disables verbose mode.
  • Value: false

island-starter

island-starter.[schem-type]

  • Description: Configuration for the starting island schematic. The key example-schem is used to reference this configuration in island.create.default-schem-key.
island-starter.[schem-type].worlds.[world_name]
  • schematic: Path to the schematic file.
  • height: Height of the island schematic (e.g., 64.0).

Example configuration:

[island-starter.example-schem.worlds.sky-overworld]
    schematic = "./schematics/default.schem"
    height = 64.0

settings

settings.global

settings.global.cache
  • update-timer-seconds: Cache update frequency in seconds (e.g., 60).

settings.player

settings.player.island.teleport
  • change-gamemode: Allows changing the game mode when teleporting to an island (true).
settings.player.island.delete
  • clear-inventory: Clears the player's inventory when their island is deleted (true).
  • clear-enderchest: Clears the contents of the player's Ender chest (true).
  • clear-experience: Resets the player's experience points (true).
settings.player.island.kicked
  • clear-inventory: Clears the player's inventory when they are kicked from their island (true).
  • clear-enderchest: Clears the contents of the player's Ender chest (true).
  • clear-experience: Resets the player's experience points (true).
settings.player.island.leave
  • clear-inventory: Clears the player's inventory when they leave their island (true).
  • clear-enderchest: Clears the contents of the player's Ender chest (true).
  • clear-experience: Resets the player's experience points (true).
settings.player.join.teleport
  • own-island: Teleports the player to their own island when joining (true).
  • spawn-not-island: Teleports the player to the spawn if the island doesn't exist (true).

worlds

  • Description: Defines world configurations for islands.

Example world configuration:

[worlds.sky-overworld]
    environment = "NORMAL"

    [worlds.sky-overworld.portal-nether]
        enabled = true
        direction = "sky-overworld"

    [worlds.sky-overworld.portal-end]
        enabled = true
        direction = "sky-overworld"

[worlds.sky-nether]
    environment = "NETHER"

    [worlds.sky-nether.portal-nether]
        enabled = true
        direction = "sky-overworld"

    [worlds.sky-nether.portal-end]
        enabled = true
        direction = "sky-overworld"

[worlds.sky-end]
    environment = "THE_END"

    [worlds.sky-end.portal-nether]
        enabled = true
        direction = "sky-nether"

    [worlds.sky-end.portal-end]
        enabled = true
        direction = "sky-overworld"

sgbd

sgbd.mariadb

  • hostname: Database server address (127.0.0.1).
  • password: Database password (azerty123@).
  • database: Name of the database (skyllia).
  • port: Database server port (3306).
  • version: Version of the database configuration (4).
  • maxPool: Maximum number of connections in the pool (5).
  • username: Username (admin).
  • useSSL: Whether to use SSL (false).
  • timeOut: Maximum operation timeout (500).

island

island.create

  • default-schem-key: Default schematic key for island creation (example-schem).

island-settings

island-settings.[schem-type]

  • size: Size of the island (e.g., 50.0).
  • name: Name of the island type (e.g., example).
  • max-members: Maximum number of members per island (e.g., 3).

Example configuration:

[island-settings.example]
    size = 50.0
    name = "example"
    max-members = 3

config

  • max-island: Maximum number of islands that can be created on the server (500000).

  • region-distance-per-island: Region distance per island. Important: The value -1 must be changed, or the server will not start.

    • Folia recommendation: If you are using Folia, it is recommended to set this value to 5 to ensure one island per tick. This assumes you have set in paper-global.yml:
      • threaded-regions.grid-exponent to 1.
  • suppress-warning-nether-end-world-enabled: Disable the warning about enabling Vanilla Nether and End worlds (false).

config.optimization

  • delete-chunk-perimeter-island: Allows deleting the island based on its size at the time of deletion, rather than clearing the entire surrounding region (false).