Skip to main content

Btcsky Config

The btcsky_config manifest entry is the central configuration hub for the entire BTC Sky system. It defines core settings, island defaults, teleportation, permissions, commands, messages, and references to all sub-systems.

Configuration​

btcsky_config — Map

Configuration for this manifest.

Properties

commandAliases

Main command aliases for the /island command.

worldPrefix — String

Prefix for generated island world names (e.g. btcsky_<profileId>_<dimension>).

playerSkyDataArtifact — Ref&lt;ArtifactEntry&gt;

Reference to the artifact storing player-specific Skyblock data.

coopFeaturesEnabled — Boolean

Enable cooperative features (Parties/Friends integration). Disable for local testing.

defaults — IslandDefaults

Default settings applied to newly created islands (chunk-based sizing).

teleportation — TeleportationSettings

Teleportation behavior, warmups, void handling, and kick actions.

leaderboard — LeaderboardSettings

Island top leaderboard configuration (sorted by island level).

optimization — OptimizationSettings

Performance settings: redstone disabling, AFK spawn control.

confirmations — ConfirmationSettings

Confirmation dialog toggles for high-risk actions (ban, disband, kick, leave).

sounds — SoundSettings

Sound effects for create, teleport, error, success, level up, upgrade, menus.

messages — BtcSkyMessages

All configurable messages organized by category (errors, success, announcements, toggles, bank, invites, teleport, warps, upgrades, admin, info, formats).

contracts — ContractSettings

Contract system: cooldowns, limits, durations, rewards, tax, applicant review.

research — ResearchSettings

Research tech tree: branches, nodes, fragments, cost multipliers.

holograms — HologramSettings

Hologram system: max per island, max lines, view distance, permissions.

collections — CollectionSettings

Collection system with categories, items, and level progression.

permissions — PermissionSettings

Customizable permission nodes for every command and action.

commands — CommandSettings

Command toggles and aliases for every subcommand (menu, create, home, warp, coop, top, level, upgrades, border, research, contracts, collections, bans, ratings, seasons, generators, biomes, members, settings, visitors, blockValues, holograms, combat, expansion, help, admin).

dimensionTemplates — List&lt;Ref&lt;DimensionTemplateEntry&gt;&gt;

References to all dimension template entries available for this instance.

Sub-Configuration Types​

IslandDefaults​

sizeInChunks — Int

Default island radius in chunks (1 chunk = 16×16 blocks).

maxSizeInChunks — Int

Maximum island radius achievable through upgrades.

height — Int

Y-level where islands spawn.

teamLimit — Int

Default team/member limit.

maxMembers — Int

Alias for teamLimit.

warpsLimit — Int

Default warp slot limit per island.

possessionBorder — Boolean

Enable possession border (visual) by default.

possessionBorderColor — BorderColor

Default possession border color.

worldBorder — Boolean

Enable world border (physical) by default.

worldBorderColor — BorderColor

Default world border color.

cropGrowth — Double

Default crop growth multiplier.

mobDrops — Double

Default mob drops multiplier.

spawnerRates — Double

Default spawner rates multiplier.

maxDisbands — Int

Maximum disband count per player (-1 = unlimited).

enabledFlags — List&lt;IslandFlag&gt;

Island flags enabled by default (CREEPER_EXPLOSION, NATURAL_ANIMALS_SPAWN, WATER_FLOW, BUILD, BREAK, etc.).

rolePermissions — Map&lt;IslandRole, List&lt;IslandFlag&gt;&gt;

Default permissions per role (VISITOR, MEMBER, MODERATOR, ADMIN, LEADER).

TeleportationSettings​

voidTeleportMembers — Boolean

Save members from void damage by teleporting them to spawn.

voidTeleportVisitors — Boolean

Save visitors from void damage.

visitorsDamage — Boolean

Allow visitors to take damage on islands.

warpWarmup — Int

Warp warmup in seconds (0 = instant).

homeWarmup — Int

Home teleport warmup in seconds.

visitWarmup — Int

Visit teleport warmup in seconds.

teleportOnJoin — Boolean

Teleport player to their island on join.

onKickActions — List&lt;Ref&lt;TriggerableEntry&gt;&gt;

Actions triggered when a player is kicked from an island.

LeaderboardSettings​

includeLeader — Boolean

Include island leader in member count display.

roundLevel — Boolean

Round calculated level to nearest integer.

blacklistDimensions — List&lt;String&gt;

Dimension IDs excluded from the leaderboard.

OptimizationSettings​

disableRedstoneOffline — Boolean

Disable redstone when no island members are online.

disableRedstoneAfk — Boolean

Disable redstone when all island members are AFK.

disableSpawningAfk — Boolean

Disable mob spawning when all island members are AFK.

ContractSettings​

creationCooldownSeconds — Int

Cooldown between contract creations per player.

defaultMaxContracts — Int

Default contract limit per island.

permissionLimits — Map&lt;String, Int&gt;

Permission-based contract limits (e.g. "btcsky.contracts.vip" → 5).

availableDurations — List&lt;Int&gt;

Available contract durations in hours.

minReward — Double

Minimum reward amount.

maxReward — Double

Maximum reward amount.

requireAcceptConfirmation — Boolean

Require confirmation before accepting a contract.

maxApplicantsPerContract — Int

Maximum applicants per contract before auto-close.

enableApplicantReview — Boolean

Allow contract creator to review applicants.

rewardTaxPercent — Double

Tax percentage on contract rewards (goes to server).

ResearchSettings​

commandEnabled — Boolean

Enable/disable the research command.

branches — List&lt;ResearchBranch&gt;

Research categories (Agriculture, Automation, Combat, etc.) with level progression.

nodes — List&lt;ResearchNodeConfig&gt;

Individual research nodes with costs, fuel requirements, success chances, and rewards.

costMultiplier — Double

Global research cost multiplier.

fragments — List&lt;ResearchFragment&gt;

Available research fragments (Basic, Advanced, Mystical) with power amounts and processing times.

HologramSettings​

maxHologramsPerIsland — Int

Base limit for holograms per island.

maxLinesPerHologram — Int

Maximum lines per hologram.

viewDistance — Double

View distance in blocks.

advancedPermission — String

Permission for advanced hologram features (colors, etc.).

allowPlaceholders — Boolean

Allow island stats placeholders in holograms.

CommandSettings​

Each subcommand is a CommandToggle with enabled (Boolean), aliases (List<String>), and criteria (List<Criteria>).

Available command toggles: menu, create, home, teleport, warp, coop, top, level, upgrades, border, research, contracts, collections, bans, ratings, seasons, generators, biomes, members, settings, visitors, blockValues, holograms, combat, expansion, help, adminAliases.

PermissionSettings​

Each command has a customizable permission node (e.g. btcsky.command.create, btcsky.command.warp), plus baseUser ("btcsky.user"), baseAdmin ("btcsky.admin"), and adminBypass ("btcsky.admin.bypass").

BtcSkyMessages​

All messages support MiniMessage format with placeholders. Organized into:

  • errors — ErrorMessages (no island, invalid player, not enough money, limits, etc.)
  • success — SuccessMessages (created, disbanded, joined, biome changed, rated, etc.)
  • announcements — AnnouncementMessages (broadcast to island: join, leave, kick, ban, deposit, etc.)
  • toggles — ToggleMessages (fly, bypass, spy, team chat, world border)
  • bank — BankMessages (deposit, withdraw, balance, limit)
  • invites — InviteMessages (invitations, coop, ban/kick notifications)
  • teleport — TeleportMessages (warmup, cancel, unsafe warp, PvP zone)
  • warps — WarpMessages (create, rename, delete, public/private)
  • upgrades — UpgradeMessages (cooldown, max level, limits updated)
  • admin — AdminMessages (help, debug, recalc, purge)
  • info — InfoMessages (owner, name, level, worth, bank, rating, team chat)
  • formats — FormatMessages (number suffixes Q/T/B/M/K, time units, border color names)

CollectionSettings​

categories — Map&lt;String, CollectionCategoryConfig&gt;

Collection categories with display names, icon materials, and item definitions. Each item has levels with required amounts and reward descriptions.

[!TIP] Technically Unlimited Dimensions: BTC Sky allows creating an infinite number of independent dimensions per island. Link multiple DimensionTemplateEntry references in the dimensionTemplates list.

[!TIP] Technically Unlimited Dimensions: BTC Sky allows creating an infinite number of independent dimensions per island. Link multiple DimensionTemplateEntry references in the dimensionTemplates list.