Перейти к основному содержимому

Btcsky Dimension Template

Island Dimension Template

Island Dimension Template Entry Defines all settings for a single dimension (overworld, nether, end, skills, mining, etc.) Each island can have multiple dimensions, each configured via this template. This entry is completely self-contained with all nested configurations inline, eliminating the need for separate ID-based lookups.

Поля

ПолеТипПо умолчаниюОписание
dimensionIdStringoverworldUnique dimension identifier (e.g., 'overworld', 'nether', 'skills', 'mining')
priorityInt0Order priority in menus (higher = first)
descriptionList<String>—Description shown in dimension menu. Supports colors and placeholders.ПлейсхолдерыЦветаМногострочное
iconItem—Menu item icon for this dimension
menuSlotsList<Int>—Slot positions in dimension menu (0-53)
defaultBiomeStringminecraft:plainsDefault biome identifier (e.g., 'minecraft:plains')
templateWorldNameStringbtcsky_template_overworldTemplate world name to clone from (must exist in slime_worlds directory)
allowedBiomesList<BiomeGroup>—Allowed biome groups for this dimension
BiomeGroup (2)
ПолеТипПо умолчаниюОписание
iconItem—Icon representing the group
biomesList<BiomeDefinition>emptyList of biomes in this group
BiomeDefinition (7)
ПолеТипПо умолчаниюОписание
biomeIdStringPLAINSBiome identifier (e.g., 'PLAINS', 'minecraft:plains', 'custombiomes:my_biome')
displayNameString<green>PlainsDisplay name shown in menu (supports MiniMessage)Цвета
permissionString—Permission required to unlock/use this biome (empty = none)
costDouble0.0Cost to unlock this biome
iconMaterialGRASS_BLOCKCustom icon for this biome
descriptionList<String>emptyDescription/Lore for this biome
customSpawnsList<CustomMobSpawn>emptyCustom BTCMobs that can spawn in this biome
overrideGlobalFlagsBooleanfalseOverride global island flags for this dimension
enabledFlagsList<IslandFlag>—Enabled flags for this dimension (if override is enabled)Значения:NATURAL_ANIMALS_SPAWNNATURAL_MONSTER_SPAWNSPAWNER_ANIMALS_SPAWNSPAWNER_MONSTER_SPAWNWATER_FLOWLAVA_FLOWCROPS_GROWTHTREE_GROWTHFIRE_SPREADEGG_LAYENDERMAN_GRIEFLEAF_DECAYANIMAL_DAMAGEMONSTER_DAMAGEBUILDBREAKINTERACTPVP
unlockDimensionUnlockConfig—Unlock requirements and costs for this dimension
DimensionUnlockConfig (10)
ПолеТипПо умолчаниюОписание
unlockedByDefaultBooleantrueIs this dimension unlocked by default for new islands?
isPrimaryBooleantrueIs this the primary/main dimension?
costDouble0.0Cost to unlock
currencyRef<ManifestEntry>—Currency storage definition for unlock cost
requiredLevelInt0Required island level to unlock
permissionString—Permission required to unlock (empty = none)
requirementMessageString—Custom requirement text shown in lore when locked (e.g. 'Requiert: Quete du Nether'). Use {cost}, {level} placeholders.
unlockedLoreList<String>emptyLore lines to ADD when dimension is unlocked (appended after the item's default lore). Leave empty for default.Цвета
lockedLoreList<String>emptyLore lines to ADD when dimension is locked (appended after the item's default lore). Leave empty for default.Цвета
onUnlockList<Ref<TriggerableEntry>>emptyTypeWriter actions to trigger on unlock
limitsDimensionLimitsConfig—Block and entity limits specific to this dimension
DimensionLimitsConfig (5)
ПолеТипПо умолчаниюОписание
blocksList<BlockLimitConfig>emptyBlock placement limits for this dimension
BlockLimitConfig (5)
ПолеТипПо умолчаниюОписание
blockItem—Block type (use Item Editor for vanilla or custom blocks)
limitInt10Maximum allowed count of this block
upgradeableBooleantrueCan this limit be upgraded?
upgradeCostDouble1000.0Cost per upgrade level
upgradeIncreaseInt5Limit increase per upgrade level
entitiesList<EntityLimitConfig>emptyEntity spawn limits for this dimension
EntityLimitConfig (6)
ПолеТипПо умолчаниюОписание
entityTypeEntityTypeVILLAGERVanilla entity type
btcMobIdString—BTCMob ID (if using BTCMob extension, leave empty for vanilla)
limitInt10Maximum allowed count of this entity
upgradeableBooleantrueCan this limit be upgraded?
upgradeCostDouble1000.0Cost per upgrade level
upgradeIncreaseInt2Limit increase per upgrade level
machinesList<MachineLimitConfig>emptyMachine limits for this dimension (requires Machine Extension)
MachineLimitConfig (5)
ПолеТипПо умолчаниюОписание
machineIdString—Machine ID (from Machine Extension)
limitInt5Maximum allowed count of this machine
upgradeableBooleantrueCan this limit be upgraded?
upgradeCostDouble5000.0Cost per upgrade level
upgradeIncreaseInt1Limit increase per upgrade level
petsList<PetLimitConfig>emptyPet limits for this dimension (requires Pets Extension)
PetLimitConfig (5)
ПолеТипПо умолчаниюОписание
petIdString—Pet ID (from Pets Extension)
limitInt2Maximum allowed count of this pet
upgradeableBooleantrueCan this limit be upgraded?
upgradeCostDouble25000.0Cost per upgrade level
upgradeIncreaseInt1Limit increase per upgrade level
warpLimitInt3Maximum numbers of warps for this dimension
crystalCrystalStateACTIVEWhether this dimension has a usable stabilisation crystal, a decorative one, or none at all
crystalOffsetVectorZEROWhere the stabilisation crystal stands by default, relative to this dimension's home
crystalMovableBooleantrueMay a player move the crystal in this dimension? The Archipel says no
mobLevelAtCenterInt1Mob level at the island's central chunk
mobLevelAtEdgeInt45Mob level at the outermost unlockable chunk; the level rises continuously between the two
spawnerIslandSpawnerConfig—How this dimension is populated: rate, distance and caps
IslandSpawnerConfig (8)
ПолеТипПо умолчаниюОписание
enabledBooleantrueWhether this dimension is populated at all
attemptChanceDouble0.25Chance, per spawner pass and per player, of attempting a spawn (0 to 1)
minDistanceInt4Closest a mob may appear from the player, in blocks
maxDistanceInt48Furthest a mob may appear from the player, in blocks
capRadiusDouble32.0Radius, in blocks, over which the caps below are counted
maxNearbyMobsInt20Maximum living mobs within the cap radius; zero disables the cap
maxPerChunkInt8Maximum living mobs in the target chunk; zero disables the cap
perTemplateCapsList<SpawnTemplateCap>emptyPer-template caps within the cap radius, overriding the global one
SpawnTemplateCap (2)
ПолеТипПо умолчаниюОписание
btcMobIdString—BTC mob template identifier this cap applies to
limitInt4Maximum mobs of that template within the cap radius
blockValuesList<BlockValueConfig>—Block values for island level calculation in this dimension
BlockValueConfig (3)
ПолеТипПо умолчаниюОписание
materialMaterialSTONEBlock type (Vanilla Material)
customBlockIdString—Custom Block ID (e.g. craftengine:ruby_block). Leaves empty for vanilla.
valueDouble1.0Value contribution to island level/worth
generatorDimensionGeneratorConfig—Cobblestone generator configuration for this dimension
DimensionGeneratorConfig (2)
ПолеТипПо умолчаниюОписание
defaultTierInt0Default generator tier for this dimension (tier 0 = free starting tier)
tiersList<GeneratorTierConfig>emptyGenerator tiers with upgrade costs and rates. Leave empty to use the documented default for overworld/nether/end (see DefaultGenerators).
GeneratorTierConfig (4)
ПолеТипПо умолчаниюОписание
tierInt1Tier level (1, 2, 3, ...)
costDouble0.0Cost to unlock this tier
currencyRef<ManifestEntry>—Currency storage definition for tier cost
ratesList<GeneratorRate>emptyBlock generation rates for this tier
expansionDimensionExpansionConfig—Island expansion configuration for this dimension
DimensionExpansionConfig (9)
ПолеТипПо умолчаниюОписание
initialSizeChunksInt1Initial island size in chunks per side (1 = a single 16x16 chunk at the centre).
maxSizeChunksInt15Maximum island size in chunks per side (e.g. 15 = 15x15 chunks). Use an odd value for a centred grid.
baseCostDouble1000.0Base cost for the first expansion
costMultiplierDouble1.25Cost multiplier per expansion level (e.g., 1.5 increase)
stepSizeInt2Number of purchased chunks per level requirement step
levelIncreaseInt100Level requirement increase per step
customChunksList<ChunkCustomizationConfig>emptyDefined custom chunks with specific costs and requirements
ChunkCustomizationConfig (4)
ПолеТипПо умолчаниюОписание
limitIndexInt1The index of the purchased chunk this applies to (1 = 1st purchase, 2 = 2nd...)
costDouble1000.0Cost to unlock this specific chunk
criteriaList<Criteria>emptyRequirements to unlock this chunk
requirementMessageString—Custom message shown when requirements are not metЦветаМногострочное
unlockedMaterialStringGRASS_BLOCKMaterial for the unlocked chunks in binary grid
lockedMaterialStringDIRTMaterial for the locked/buyable chunks in binary grid
multipliersDimensionMultipliersConfig—Default multipliers for this dimension
DimensionMultipliersConfig (6)
ПолеТипПо умолчаниюОписание
cropGrowthDouble1.0Crop growth speed multiplier (1.0 = normal)
mobDropsDouble1.0Mob drop multiplier (1.0 = normal)
spawnerRatesDouble1.0Spawner rate multiplier (1.0 = normal)
xpDouble1.0XP gain multiplier (1.0 = normal)
professionXpDouble1.0Block break XP multiplier for professions
autoCollectionRadiusDouble0.0Radius for auto-collection of drops (0.0 = disabled)
rolePermissionsDimensionRolePermissionsConfig—Default permissions per role in this dimension
DimensionRolePermissionsConfig (5)
ПолеТипПо умолчаниюОписание
visitorList<IslandPermission>emptyPermissions for visitors (non-members)Значения:INTERACTBUILDBREAKCHEST_ACCESSISLAND_CHESTFLYINVITEKICKBANUNBANSET_WARPDELETE_WARPSET_HOMESET_BIOMESET_ROLEMANAGE_FLAGSMANAGE_UPGRADESTRANSFERDISBAND
coopList<IslandPermission>—Permissions for coop membersЗначения:INTERACTBUILDBREAKCHEST_ACCESSISLAND_CHESTFLYINVITEKICKBANUNBANSET_WARPDELETE_WARPSET_HOMESET_BIOMESET_ROLEMANAGE_FLAGSMANAGE_UPGRADESTRANSFERDISBAND
memberList<IslandPermission>—Permissions for regular membersЗначения:INTERACTBUILDBREAKCHEST_ACCESSISLAND_CHESTFLYINVITEKICKBANUNBANSET_WARPDELETE_WARPSET_HOMESET_BIOMESET_ROLEMANAGE_FLAGSMANAGE_UPGRADESTRANSFERDISBAND
moderatorList<IslandPermission>—Permissions for moderators (includes member permissions)Значения:INTERACTBUILDBREAKCHEST_ACCESSISLAND_CHESTFLYINVITEKICKBANUNBANSET_WARPDELETE_WARPSET_HOMESET_BIOMESET_ROLEMANAGE_FLAGSMANAGE_UPGRADESTRANSFERDISBAND
adminList<IslandPermission>—Permissions for admins (includes moderator permissions)Значения:INTERACTBUILDBREAKCHEST_ACCESSISLAND_CHESTFLYINVITEKICKBANUNBANSET_WARPDELETE_WARPSET_HOMESET_BIOMESET_ROLEMANAGE_FLAGSMANAGE_UPGRADESTRANSFERDISBAND
spawnDimensionSpawnConfig—Player spawn configuration for this dimension
DimensionSpawnConfig (3)
ПолеТипПо умолчаниюОписание
cornerSpawnCornerCENTERSpawn corner position (for corner spawn feature)Значения:CENTERNORTH_WESTNORTH_EASTSOUTH_WESTSOUTH_EAST
yLevelInt-1Y level for spawn (-1 to use schematic spawn point)
edgeOffsetInt5Offset from edge when using corner spawn (blocks)
seasonsDimensionSeasonsConfig—Seasonal themes configuration with TinyEssentials calendar integration
DimensionSeasonsConfig (6)
ПолеТипПо умолчаниюОписание
enabledBooleanfalseEnable seasonal themes for this dimension
timingModeSeasonTimingModeFIXED_DURATIONSeason timing mode: FIXED_DURATION or CALENDAR_LINKEDЗначения:FIXED_DURATIONCALENDAR_LINKED
fixedDurationHoursInt168Duration of each season in real-time hours (for FIXED_DURATION mode)
calendarRef<ManifestEntry>—Reference to TinyEssentials definition for calendar linking. When linked, the calendar year is divided evenly by the number of seasons. For example: 4 seasons = each season is 1/4 of the calendar year.
startMonthInt1Starting month for first season (1-12 or calendar-specific). Used to align seasons with real-world equivalents. For 4 seasons: Spring starts month 3 (March), Summer month 6, etc.
definitionsList<SeasonDefinition>—Available seasons with their configurations
SeasonDefinition (10)
ПолеТипПо умолчаниюОписание
displayNameString<green>SpringDisplay name with colorsЦвета
biomeOverrideString—Biome override during this season (empty = no change)
weatherPatternStringCLEARWeather pattern: CLEAR, RAIN, THUNDER, SNOW
cropGrowthMultiplierDouble1.0Crop growth multiplier during this season
mobSpawnMultiplierDouble1.0Mob spawn rate multiplier during this season
mobDropMultiplierDouble1.0Mob drop multiplier during this season
xpMultiplierDouble1.0Additional XP multiplier during this season
particleEffectsList<String>emptyParticle effects to display (empty = none)
onStartList<Ref<TriggerableEntry>>emptyTypeWriter actions to trigger when season starts
onEndList<Ref<TriggerableEntry>>emptyTypeWriter actions to trigger when season ends
eventsDimensionEventsConfig—Random procedural events for this dimension
DimensionEventsConfig (5)
ПолеТипПо умолчаниюОписание
enabledBooleantrueEnable random procedural events
frequencyMultiplierDouble1.0Event frequency multiplier (1.0 = normal)
minIntervalMinutesInt60Minimum time between events in minutes
maxIntervalMinutesInt240Maximum time between events in minutes
eventsList<Ref<IslandEventEntry>>emptyAvailable events for this dimension
combatDimensionCombatConfig—Combat/War system configuration for this dimension
DimensionCombatConfig (13)
ПолеТипПо умолчаниюОписание
enabledBooleanfalseEnable combat zone mode (PvP always enabled, events/seasons blocked)
coreNpcDefinitionRef<ManifestEntry>—Reference to Core NPC definition (from Entity or BetterModel Extension)
coreHealthDouble1000.0Core NPC maximum health
coreRegenerationDouble1.0Core NPC regeneration per second
durationMinutesInt15Combat duration in minutes (0 = unlimited)
minIslandLevelInt10Minimum island level to participate in combat
attackCooldownHoursInt24Cooldown between attacks in hours
attackerSpawnCombatSpawnPoint—Spawn point for attacking team
CombatSpawnPoint (5)
ПолеТипПо умолчаниюОписание
offsetXDouble0.0Relative X offset from island center
offsetYDouble5.0Relative Y offset from island center
offsetZDouble0.0Relative Z offset from island center
yawFloat0Yaw rotation
pitchFloat0Pitch rotation
defenderSpawnCombatSpawnPoint—Spawn point for defending team
CombatSpawnPoint (5)
ПолеТипПо умолчаниюОписание
offsetXDouble0.0Relative X offset from island center
offsetYDouble5.0Relative Y offset from island center
offsetZDouble0.0Relative Z offset from island center
yawFloat0Yaw rotation
pitchFloat0Pitch rotation
coreLocationCombatSpawnPoint—Location of the core NPC relative to island center
CombatSpawnPoint (5)
ПолеТипПо умолчаниюОписание
offsetXDouble0.0Relative X offset from island center
offsetYDouble5.0Relative Y offset from island center
offsetZDouble0.0Relative Z offset from island center
yawFloat0Yaw rotation
pitchFloat0Pitch rotation
onCombatStartList<Ref<TriggerableEntry>>emptyTypeWriter actions to trigger when combat starts
onVictoryList<Ref<TriggerableEntry>>emptyTypeWriter actions to trigger when combat ends (victory)
onDefeatList<Ref<TriggerableEntry>>emptyTypeWriter actions to trigger when combat ends (defeat)
upgradesList<DimensionUpgradeConfig>—Available upgrades for this dimension
DimensionUpgradeConfig (6)
ПолеТипПо умолчаниюОписание
displayNameString—Display nameЦвета
descriptionList<String>emptyDescription for the upgradeЦвета
effectTypeUpgradeEffectTypeCUSTOMEffect type for this upgradeЗначения:CROP_GROWTHMOB_DROP_BONUSSPAWNER_RATESPOTION_EFFECTISLAND_EFFECTBLOCK_LIMITSTORAGE_LIMITREDSTONE_LIMITMISC_LIMITENTITY_LIMITTEAM_SIZEWARP_LIMITGENERATOR_TIERISLAND_FLYEVENT_FREQUENCYEVENT_LOOT
upgradeTemplateSlotItemConfig—Item template for available upgrade. {level}, {cost}, {effect_value} placeholders available.
SlotItemConfig (3)
ПолеТипПо умолчаниюОписание
itemItem—Base item (use Item Editor). Leave empty to show only text.
loreList<String>emptyLore lines. Each line supports MiniMessage and placeholders.ПлейсхолдерыЦветаМногострочное
glowingBooleanfalseApply enchantment glow to the item.
maxedTemplateSlotItemConfig—Item template for maxed upgrade
SlotItemConfig (3)
ПолеТипПо умолчаниюОписание
itemItem—Base item (use Item Editor). Leave empty to show only text.
loreList<String>emptyLore lines. Each line supports MiniMessage and placeholders.ПлейсхолдерыЦветаМногострочное
glowingBooleanfalseApply enchantment glow to the item.
levelsList<UpgradeLevelConfig>emptyUpgrade sequential levels
UpgradeLevelConfig (7)
ПолеТипПо умолчаниюОписание
levelInt1Level number (1, 2, 3...)
loreList<String>emptyCustom lore for this level in the upgrade detail view (appended below the state template).ЦветаМногострочное
costDouble1000.0Unlock cost
effectValueDouble0.0Effect modifier value (multiplier or flat increase)
potionEffectValueString—Potion effect string (e.g., 'SPEED:1')
requiredProfessionLevelMap<String, Int>emptyRequired Profession Levels (RPG Core integration)
onUpgradeList<Ref<TriggerableEntry>>emptyTypeWriter actions to trigger when upgraded
Общие поля TypeWriter (displayName)
ПолеТипПо умолчаниюОписание
displayNameString<green>OverworldDisplay name shown in menus. Supports MiniMessage colors.Цвета

How to use it​

One template is one dimension. dimensionId is the id used everywhere else (placeholders, facts, actions, /typewriter island admin unlock dimension). The world named in templateWorldName must exist in the slime_worlds folder. Exactly one template should have unlock.isPrimary on: it is the home dimension created with the island. Sizes are in chunks per side; use odd values so the grid is centred. Block and entity limits that are not listed are unlimited. See the "Dimension templates" section of the extension page for the field groups.