For the complete documentation index, see llms.txt. This page is also available as Markdown.

๐Ÿ“œConfiguration

config.yml

config.yml
# Tracks which configuration migrations have been applied. Do not edit by hand;
# lowering it will re-run migrations against your files.
config-version: 1

# H2 and MariaDB are the only supported
database:
  type: "H2"
  mariadb:
    host: "localhost"
    port: 3306
    database: "island"
    username: "root"
    password: ""

lang: en-US

# How the strings in lang/*.yml and the item names below are written.
#   LEGACY       - "&a" colour codes (the default, and what the shipped files use)
#   MINIMESSAGE  - "<green>tags</green>"
# Switching this does not convert your files; pick the one they are written in.
text-format: LEGACY

# From central block to central block
# 1000 blocks means maximum 500 blocks from center to edge
island-distance: 1000

# If true, on login the player will be teleported to the island if the spawn is not enabled
island-join-on-first-login: true

# Teleport the player to their island when they fall in the void
island-teleport-on-fall: true

# Determines how many members can be on an island based on owner permission
# If you want to have unlimited members, set it to -1
# Permission: oneblock.max.<role>
# LUCKPERMS NEEDED
custom-max-players:
  default: 8
  vip: 12
  mvp: 16
  admin: -1

# If level < level-formula then the island will level up
#
# islandCoreBroken (Island core blocks broken)
# level (Island current level)
# phaseOrdinal (1 = First Phase, 2 = Second Phase, 3 = Third Phase)
level-formula: "floor(3.55 * log(islandCoreBroken + 211) - 18)"

world-protection:
  # "Spawn worlds"
  blacklist:
    - "world"

spawn:
  enabled: true
  # Spawn location
  world: "world"
  x: 0
  y: 100
  z: 0
  yaw: 0
  pitch: 0

reset:
  cost: 1000
  phase: Dungeon

world-border:
  base-size: 127
  max-size: 127

tops:
  # How often the rankings are rebuilt, in ticks. The rebuild is skipped
  # entirely when nothing has changed since the last one.
  refresh-interval: 200
  # How many islands each ranking holds. /is top pages through this many, and
  # %oneblock_top_<n>% is only answered up to it.
  top-size: 10

  # Standing hologram leaderboards, using whichever hologram plugin is
  # installed. Remove or empty this section for none.
  #
  #   type:  level, value or blocks
  #   lines: how many places to show, capped by top-size above
  #
  # holograms:
  #   spawn-level:
  #     type: level
  #     lines: 10
  #     world: world
  #     x: 0.5
  #     y: 70.0
  #     z: 0.5

hologram:
  enabled: true
  # Unlock hologram when player reaches this number of blocks
  unlock-at: 50000
  update-interval: 5

gui:
  title: "&8Island"
  items:
    no-member:
      material: "GRAY_STAINED_GLASS_PANE"
      displayName: "&7Available Slot"
      lore: [ ]
      left-action:
        command: ""
      right-action:
        command: ""
    member:
      material: "PLAYER_HEAD"
      displayName: "&b&l%player%"
      lore:
        - ""
        - "&7Role: &d%prefix%"
        - ""
        - "&7Left-click to &cBan"
        - "&7Right-click to &cKick"
      left-action:
        command: "is ban %target%"
      right-action:
        command: "is kick %target%"
    no-visitor:
      material: "YELLOW_STAINED_GLASS_PANE"
      displayName: "&eNo Visitors"
      lore: [ ]
      left-action:
        command: ""
      right-action:
        command: ""
    visitor:
      material: "PLAYER_HEAD"
      displayName: "&a&l%player%"
      lore:
        - ""
        - "&7Left-click to &cBan"
      left-action:
        command: "is ban %target%"
      right-action:
        command: ""
    info:
      material: "EXPERIENCE_BOTTLE"
      displayName: "&b&lInfo"
      lore:
        - ""
        - "&eOwner: &a%owner%"
        - "&eMembers: &b%members%"
        - "&eBans: &b%bans%"
        - ""
        - "&eBlocks Broken: &b%core-broken%"
        - "&eTotal Blocks Broken: &b%total-core-broken%"
        - "&eLevel: &b%level%"
        - ""
        - "&ePhase: &b%phase%"
        - "&eNext Phase: &b%nextPhase%"
        - "&ePhase Progress: &r%progress% &e(&b%percent%%&e)"
        - ""
        - "&eIsland Size: &b%size%"
      left-action:
        command: ""
      right-action:
        command: ""
    toggle:
      # When the island is open, this will be the item
      open:
        material: "BARRIER"
        displayName: "&c&lClose"
        lore: [ ]
        left-action:
          command: "is close"
        right-action:
          command: "is close"
      close:
        material: "BARRIER"
        displayName: "&a&lOpen"
        lore: [ ]
        left-action:
          command: "is open"
        right-action:
          command: "is open"

# What each role on an island may do, before the island changes anything itself.
#
# Islands store only the settings they have explicitly changed through
# /is flags, so editing a default here reaches every island that has never
# touched that setting.
#
# BUILD, BREAK, CONTAINERS and FLY are per role. PVP, MOB_SPAWNING,
# VISITOR_ACCESS and REDSTONE are one switch for the whole island -- PvP cannot
# be on for moderators and off for visitors, because it takes two people -- and
# only their OWNER line is read.
island-flags:
  defaults:
    BUILD:
      OWNER: true
      MODERATOR: true
      TRUSTED: true
      VISITOR: false
    BREAK:
      OWNER: true
      MODERATOR: true
      TRUSTED: true
      VISITOR: false
    CONTAINERS:
      OWNER: true
      MODERATOR: true
      TRUSTED: true
      VISITOR: false
    FLY:
      OWNER: true
      MODERATOR: true
      TRUSTED: true
      VISITOR: false
    PVP:
      OWNER: false
    MOB_SPAWNING:
      OWNER: true
    VISITOR_ACCESS:
      OWNER: true
    REDSTONE:
      OWNER: true

Text format

text-format decides how every string in lang/*.yml and every item name above is read: LEGACY for &a colour codes (the default, and what the shipped files use) or MINIMESSAGE for <green>tags</green>. Switching does not convert your files โ€” pick the one they are written in.

Hologram leaderboards

tops.holograms holds any number of standing leaderboards, drawn with whichever hologram plugin is installed. Each entry takes a type (level, value or blocks), a lines count (capped by tops.top-size) and a world / x / y / z position. Remove or empty the section for none.

Island flags

island-flags.defaults is what each role may do before an island changes anything itself. Islands store only the settings they have explicitly changed through /is flags, so editing a default here reaches every island that never touched that setting.

BUILD, BREAK, CONTAINERS and FLY are per role. PVP, MOB_SPAWNING, VISITOR_ACCESS and REDSTONE are one switch for the whole island โ€” PvP cannot be on for moderators and off for visitors, because it takes two people โ€” and only their OWNER line is read.

worth.yml

Sell prices for /is shop and block worth for island value. The two lists are separate on purpose: sell prices are economy balance and get tuned, while block worth is a ranking weight and wants to stay stable. Anything not listed is worth nothing โ€” unsellable, and ignored by island value.

upgrades.yml

Island upgrades, bought from the island bank by the owner or a moderator. Values are absolute, not incremental: a tier says what the island has at that tier, not what it adds to the previous one. Delete an upgrade's whole section to switch it off.

Last updated