Customization¶
Once uSkyBlock is installed and working, these are the highest-value places to make the server feel distinct from the defaults.
Main config¶
Most general customization starts in plugins/uSkyBlock/config.yml.
See the Configuration Reference for every available key.
Common settings to review:
| Option | Default | Notes |
|---|---|---|
language |
en |
Plugin language |
options.general.worldName |
skyworld |
Name of the skyblock world |
options.general.maxPartySize |
4 |
Max players per island |
options.island.default-scheme |
default |
Default starting island schematic |
options.island.chestItems |
(see config) | Items placed in the starter chest |
options.island.distance |
128 |
Blocks between island centers |
options.island.protectionRange |
128 |
Protection radius per island |
options.island.height |
150 |
Spawn height for new islands |
options.island.allowPvP |
deny |
PvP on islands: deny or allow |
options.extras.obsidianToLava |
true |
Right-click obsidian with empty bucket to recover lava |
nether.enabled |
true |
Enable a skyblock nether world |
To apply config changes without a full restart: /usb reload
Schematics¶
Island schematics live in plugins/uSkyBlock/schematics/. Additional schematics are registered under island-schemes in config.yml and gated behind permissions using usb.schematic.<name>.
Creating a custom schematic¶
- Build your island in-game. Include at least one chest. The chest closest to the island center becomes the player's spawn point.
- Select the island bounds with WorldEdit and run
//copy, then//schem save <name>. - Copy the
.schemfile fromplugins/WorldEdit/schematics/toplugins/uSkyBlock/schematics/. - Add a config entry under
island-schemesinconfig.ymlwith the schematic name, permission, description, display item, and any limits. - Run
/usb reload.
To disable a built-in schematic without deleting it, set enabled: false:
Biomes¶
Biome choices are defined in plugins/uSkyBlock/biomes.yml.
This file controls:
- which biome options appear in the biome menu
- the display item, name, and description for each biome
- which biome keys are valid for
/island biome
Access is still controlled by permissions. Grant usb.biome.<name> for individual biomes, or usb.biome.* for all configured biomes.
Gameplay tuning files¶
Beyond config.yml, one file is especially important:
challenges.yml— defines challenge progression, requirements, and rewards. See Challenges config.
This is a high-impact tuning file. Change it carefully and test on a staging server first if you are already live.
For an overview of custom gameplay mechanics like guardian habitats, nether terraforming, and mob spawning controls, see the Custom Mechanics page. The server-side knobs for these features are documented in the Configuration Reference under spawning and nether.
Cooldowns and limits¶
| Option | Default | Notes |
|---|---|---|
options.general.cooldownRestart |
30 s |
Cooldown between island restarts |
options.general.biomeChange |
60 s |
Cooldown between biome changes |
options.island.spawn-limits.animals |
64 |
Per-island animal cap |
options.island.spawn-limits.monsters |
50 |
Per-island monster cap |
options.island.block-limits.hopper |
50 |
Per-island hopper limit |
options.island.block-limits.spawner |
10 |
Per-island spawner limit |
Placeholders¶
uSkyBlock exposes island data as placeholders and can render placeholders from other plugins in its chat formats.
For other plugins (PlaceholderAPI)¶
If PlaceholderAPI is installed,
uSkyBlock automatically registers the uskyblock expansion — no eCloud download needed.
All placeholders take the viewing player's island as context:
%uskyblock_version%, %uskyblock_island_level%, %uskyblock_island_level_int%,
%uskyblock_island_rank%, %uskyblock_island_leader%, %uskyblock_island_biome%,
%uskyblock_island_schematic%, %uskyblock_island_partysize%, %uskyblock_island_partysize_max%,
%uskyblock_island_members%, %uskyblock_island_trustees%, %uskyblock_island_bans%,
%uskyblock_island_location%, %uskyblock_island_location_x%, %uskyblock_island_location_y%,
%uskyblock_island_location_z%, %uskyblock_island_golems%, %uskyblock_island_copper_golems%,
%uskyblock_island_monsters%, %uskyblock_island_animals%, %uskyblock_island_villagers%,
and the _max variants of the creature limits.
Creature counts are sampled on the main server thread at most every 10 seconds; a cold
async lookup (e.g. the first scoreboard poll) briefly shows ….
In uSkyBlock chat formats¶
The island/party chat formats (options.island.chat-format, options.party.chat-format)
are MiniMessage strings and support two placeholder tags in addition to <display-name>
and <message>:
<usb:KEY>— uSkyBlock's own values, always available (same keys as above without theuskyblock_prefix), e.g.<usb:island_level>.<papi:PLACEHOLDER>— any PlaceholderAPI placeholder, when PlaceholderAPI is installed, e.g.<papi:luckperms_prefix>. Without PlaceholderAPI the tag renders literally.
Older configs using {usb_island_level} style tokens are migrated automatically.
Visitor protection¶
Islands are automatically protected. The protection.visitors section in config.yml controls what visitors can and cannot do.
Key flags:
| Flag | Default | Notes |
|---|---|---|
kill-animals |
on | Visitors cannot kill animals |
kill-monsters |
on | Visitors cannot kill monsters |
villager-trading |
on | Visitors cannot trade with villagers |
shearing |
on | Visitors cannot shear animals |
item-drops |
on | Visitors cannot drop items |
trampling |
on | Visitors cannot trample crops |
use-portals |
off | Visitors can use portals |
Island members and trusted players bypass these restrictions. Creeper and wither damage, fire spread, and lava flow protection are also configurable under protection.