Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt

Use this file to discover all available pages before exploring further.

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
required
Configuration for this manifest.

Sub-Configuration Types

IslandDefaults

sizeInChunks
Int
default:"1"
Default island radius in chunks (1 chunk = 16×16 blocks).
maxSizeInChunks
Int
default:"20"
Maximum island radius achievable through upgrades.
height
Int
default:"100"
Y-level where islands spawn.
teamLimit
Int
default:"4"
Default team/member limit.
maxMembers
Int
default:"4"
Alias for teamLimit.
warpsLimit
Int
default:"3"
Default warp slot limit per island.
possessionBorder
Boolean
default:"true"
Enable possession border (visual) by default.
possessionBorderColor
BorderColor
default:"BLUE"
Default possession border color.
worldBorder
Boolean
default:"true"
Enable world border (physical) by default.
worldBorderColor
BorderColor
default:"BLUE"
Default world border color.
cropGrowth
Double
default:"1.0"
Default crop growth multiplier.
mobDrops
Double
default:"1.0"
Default mob drops multiplier.
spawnerRates
Double
default:"1.0"
Default spawner rates multiplier.
maxDisbands
Int
default:"-1"
Maximum disband count per player (-1 = unlimited).
enabledFlags
List<IslandFlag>
Island flags enabled by default (CREEPER_EXPLOSION, NATURAL_ANIMALS_SPAWN, WATER_FLOW, BUILD, BREAK, etc.).
rolePermissions
Map<IslandRole, List<IslandFlag>>
Default permissions per role (VISITOR, MEMBER, MODERATOR, ADMIN, LEADER).

TeleportationSettings

voidTeleportMembers
Boolean
default:"true"
Save members from void damage by teleporting them to spawn.
voidTeleportVisitors
Boolean
default:"true"
Save visitors from void damage.
visitorsDamage
Boolean
default:"false"
Allow visitors to take damage on islands.
warpWarmup
Int
default:"0"
Warp warmup in seconds (0 = instant).
homeWarmup
Int
default:"0"
Home teleport warmup in seconds.
visitWarmup
Int
default:"0"
Visit teleport warmup in seconds.
teleportOnJoin
Boolean
default:"false"
Teleport player to their island on join.
onKickActions
List<Ref<TriggerableEntry>>
Actions triggered when a player is kicked from an island.

LeaderboardSettings

includeLeader
Boolean
default:"true"
Include island leader in member count display.
roundLevel
Boolean
default:"true"
Round calculated level to nearest integer.
blacklistDimensions
List<String>
Dimension IDs excluded from the leaderboard.

OptimizationSettings

disableRedstoneOffline
Boolean
default:"false"
Disable redstone when no island members are online.
disableRedstoneAfk
Boolean
default:"false"
Disable redstone when all island members are AFK.
disableSpawningAfk
Boolean
default:"false"
Disable mob spawning when all island members are AFK.

ContractSettings

creationCooldownSeconds
Int
default:"300"
Cooldown between contract creations per player.
defaultMaxContracts
Int
default:"3"
Default contract limit per island.
permissionLimits
Map<String, Int>
Permission-based contract limits (e.g. “btcsky.contracts.vip” → 5).
availableDurations
List<Int>
default:"[1, 6, 12, 24, 48, 72, 168]"
Available contract durations in hours.
minReward
Double
default:"100.0"
Minimum reward amount.
maxReward
Double
default:"1000000.0"
Maximum reward amount.
requireAcceptConfirmation
Boolean
default:"true"
Require confirmation before accepting a contract.
maxApplicantsPerContract
Int
default:"10"
Maximum applicants per contract before auto-close.
enableApplicantReview
Boolean
default:"true"
Allow contract creator to review applicants.
rewardTaxPercent
Double
default:"5.0"
Tax percentage on contract rewards (goes to server).

ResearchSettings

commandEnabled
Boolean
default:"true"
Enable/disable the research command.
branches
List<ResearchBranch>
Research categories (Agriculture, Automation, Combat, etc.) with level progression.
nodes
List<ResearchNodeConfig>
Individual research nodes with costs, fuel requirements, success chances, and rewards.
costMultiplier
Double
default:"1.0"
Global research cost multiplier.
fragments
List<ResearchFragment>
Available research fragments (Basic, Advanced, Mystical) with power amounts and processing times.

HologramSettings

maxHologramsPerIsland
Int
default:"5"
Base limit for holograms per island.
maxLinesPerHologram
Int
default:"10"
Maximum lines per hologram.
viewDistance
Double
default:"32.0"
View distance in blocks.
advancedPermission
String
default:"btcsky.holograms.advanced"
Permission for advanced hologram features (colors, etc.).
allowPlaceholders
Boolean
default:"true"
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<String, CollectionCategoryConfig>
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.