Ctrl K
The official documentation for all UltraPlugins.
Explore setup guides, file configurations, commands, and permissions using the sidebar. If you need help, encounter an issue, or want to suggest new features, join our official Discord community.
UltraRituals is the next-generation creature summoning engine for Minecraft. Design customized magic events linking physical altars to 3D invocation zones with native MythicMobs, EliteMobs, and dynamic command dispatch.
Native integration for MythicMobs, EliteMobs, or console/player multi-command execution.
Choose from over 14 mathematical 3D particle patterns (Helixes, Vortices, Atoms, Wave ripples, etc.).
Dynamic camera centering and FOV zoom effects when offering items to maximize immersion.
Control each phase of the ritual with spatial audio formatted as SOUND:VOLUME:PITCH:DELAY.
Download the UltraRituals.jar file from the official links and place it into your server's plugins/ directory.
To unlock the full power of the summoning engine:
Supported Integrations:
- MythicMobs: Summon custom creatures and multi-phase bosses.
- EliteMobs: Summon EliteMobs dungeon bosses and champions.
- PlaceholderAPI: Display ritual countdowns and altar counts in holograms and scoreboards.
Restart your server to generate the configuration files and default animation presets in plugins/UltraRituals/.
| Command | Description | Permission |
|---|---|---|
| /ultrarituals create <id> [type] | Starts interactive Editor Mode. Types: mythicmobs, elitemobs, command. | ultrarituals.admin |
| /ultrarituals edit <id> | Edits an existing ritual structure in-game. | ultrarituals.admin |
| /ultrarituals setspawn | *(Editing)* Sets the creature summoning spawn point at your position. | ultrarituals.admin |
| /ultrarituals setmob <mob> | *(Editing)* Sets the target mob ID to summon. | ultrarituals.admin |
| /ultrarituals setcommand <cmd> | *(Editing)* Sets console/player commands executed upon completion. | ultrarituals.admin |
| /ultrarituals save | Saves all altars and parameters to disk and exits editor. | ultrarituals.admin |
| /ultrarituals leave | Cancels Editor Mode and discards unsaved changes. | ultrarituals.admin |
| /ultrarituals reload | Hot-reloads configuration files, rituals, and animations. | ultrarituals.admin |
Step-by-step walkthrough to set up your first complete summoning ritual:
Run /ultrarituals create <id> [type]. The type can be mythicmobs, elitemobs, or command. This begins your editing session.
Place physical blocks in the world. They will register instantly as altars and open an interactive GUI where you drag the required offering item and choose particle animations.
Stand where the boss should appear and run /ultrarituals setspawn. Bind the creature name via /ultrarituals setmob <name> (or /ultrarituals setcommand <command>).
Configure cooldowns with /ultrarituals setcooldown <seconds>, spawn delay with /ultrarituals setdelay <seconds>, and type /ultrarituals save to permanently write the ritual to disk.
Organized configuration guide based on plugins/UltraRituals/rituals/sample.yml.
Specifies the summoning engine or ritual action type. Allowed values: mythicmobs, elitemobs, or command.
type: mythicmobs
Public name of the ritual used in broadcasts, titles, and placeholders. Supports color codes (&) and hex gradients.
display_name: '&4&lBlood Altar of the Damned'3D world coordinates where the creature or boss will spawn upon completing all altars.
spawn:
world: world
x: -138.707
y: 64.0
z: -12.944
pitch: 2.79
yaw: 110.85
Vanilla entity type (e.g. WITHER_SKELETON) or custom Boss identifier registered in MythicMobs/EliteMobs.
mob: SkeletonKing
Global reset cooldown in seconds before the ritual can be activated again. Use -1 for no cooldown.
cooldown: 300Delay in seconds from when the final altar is activated until the creature physically spawns. Allows cinematic animations to finish.
spawn_delay: 5Sound played when a player places the correct offering item on an individual altar.
altar_filled_sounds:
- BLOCK_NOTE_BLOCK_CHIME:1.0:1.0Sound sequence triggered the instant all altars are completed.
ritual_activated_sounds:
- ENTITY_WITHER_SPAWN:1.0:1.0Sound emitted during the particle charge phase leading up to creature emergence.
summoning_started_sounds:
- ENTITY_ILLUSIONER_PREPARE_BLINDNESS:1.0:1.0Roar or explosion sound emitted when the boss appears at the spawn coordinates.
spawn_sounds:
- ENTITY_ENDER_DRAGON_GROWL:1.0:1.0Sound played upon defeating the summoned boss creature.
death_sounds:
- ENTITY_WITHER_DEATH:1.0:1.0Sound emitted when the ritual cooldown expires and altars reset to idle state.
reset_sounds:
- BLOCK_BEACON_ACTIVATE:1.0:1.0
Broadcast radius around the ritual area in blocks. Set to -1 for whole-server broadcasts.
radius: 50.0Broadcast notifications sent when an individual altar receives its offering.
altar_activation:
chat:
- '&e%player% has activated an altar (&f%active_altars%/%total_altars%&e)'Title, subtitle, and chat announcements displayed when the boss summoning commences.
ritual_activation:
title: '&6&lSUMMONING'
subtitle: '&7The boss is appearing...'Fine-tuning visual parameters, offering items, and individual altar block behavior.
To open and edit this altar menu in-game, perform Shift + Right Click on any registered altar block with ultrarituals.admin permission.
Offering item required by this specific altar. Supports custom model data, custom names, lore, and NBT tags.
item:
id: minecraft:crying_obsidian
count: 1Idle particle animation preset displayed while the altar is waiting for an offering.
waiting_animation: atom.ymlVisual particle burst triggered the instant the offering item is accepted by the altar.
activation_animation: explosion.ymlContinuous particle pattern executed during the final ritual charging phase.
summoning_animation: helix.yml3D scale factor of the floating offering item display.
scale: 0.75Vertical height offset in blocks above the altar where the item hovers.
y_offset: 1.2Continuous rotational spin speed of the hovering display item.
rotation_speed: 2.0Smooth sinusoidal vertical bobbing floating speed.
oscillation_speed: 1.5Static light emission level projected by the altar block (0 to 15).
light: 12Enables or disables camera focus transitions and FOV zooms upon altar activation.
use_cinematic: trueVisual interaction mode: CONSUME (consumes offering item) or PERSIST (leaves item intact).
activation_mode: CONSUME
UltraRituals includes 15 preconfigured mathematical particle animation presets stored in plugins/UltraRituals/animations/. Expand each card to inspect its YAML parameters.
3D atomic orbital loops revolving around the altar apex.
effects:
- effect_type: ATOM
particle: ELECTRIC_SPARK
sound: BLOCK_AMETHYST_BLOCK_CHIME
amount: 1
spread: 0.0
radius: 1.2
height: 0.0
speed: 1.5
size: 1.0Horizontal planar ring of particles encircling the altar block.
effects:
- effect_type: CIRCLE
particle: SOUL_FIRE_FLAME
sound: BLOCK_AMETHYST_BLOCK_CHIME
amount: 1
spread: 0.0
radius: 1.2
height: 0.0
speed: 1.0
size: 1.0Fast omnidirectional particle burst with randomized velocity spread.
effects:
- effect_type: EXPLOSION
particle: EXPLOSION_NORMAL
sound: ENTITY_GENERIC_EXPLODE
amount: 15
spread: 0.5Static luminous crown halo suspended at configured altitude.
effects:
- effect_type: HALO
particle: END_ROD
height: 2.0
radius: 0.8Parametric 3D heart-shaped particle curve.
effects:
- effect_type: HEART
particle: HEART
amount: 5Continuous ascending dual-helix particle coils.
effects:
- effect_type: HELIX
particle: FLAME
radius: 1.5
height: 3.0
speed: 2.0Horizontal shockwave expanding rapidly across ground surfaces.
effects:
- effect_type: SHOCKWAVE
particle: SWEEP_ATTACK
radius: 5.0
speed: 3.0Smooth rising smoke vortex funneling upward from the altar.
effects:
- effect_type: SMOKE_VORTEX
particle: CAMPFIRE_COSY_SMOKE
height: 4.0Expanding 3D geodesic spherical particle shell.
effects:
- effect_type: SPHERE
particle: CRIT_MAGIC
radius: 2.5Planar square particle perimeter framing the altar base.
effects:
- effect_type: SQUARE
particle: VILLAGER_HAPPY
size: 2.0Radial light beams extending outward in starburst geometry.
effects:
- effect_type: SUNBURST
particle: GLOW
rays: 8
length: 3.0Dense conical whirlwind tornado of particles.
effects:
- effect_type: TORNADO
particle: CLOUD
height: 5.0
radius: 2.5Sinusoidal vertical ripple ring oscillating around the altar.
effects:
- effect_type: WAVE
particle: WATER_SPLASH
radius: 2.0
amplitude: 0.5Comprehensive reference of internal dynamic variables and PlaceholderAPI identifiers supported across messages, broadcasts, and titles.
| Variable | Description |
|---|---|
| %player% | Name of the player who activated or interacted with the altar. |
| %active_altars% | Current count of completed altars in the ongoing ritual. |
| %total_altars% | Total number of altars registered for the ritual. |
| %time% | Remaining cooldown or time limit in seconds. |
| %item% | Display name of the offering item required by the altar. |
| %ritual_display_name% | Public formatted display name of the ritual. |
| Placeholder | Result |
|---|---|
| %ultrarituals_name_<id>% | Returns the formatted public name of the specified ritual. |
| %ultrarituals_active_<id>% | Returns true if the ritual/boss is currently active, false otherwise. |
| %ultrarituals_altars_<id>% | Returns completed altars fraction (e.g. 2/4). |
| %ultrarituals_status_<id>% | Returns the current state (Ready, Active, Cooldown, In Progress). |
UltraFurnaces is the ultimate upgradeable and customizable furnace engine for Spigot/Paper servers. Transform basic item smelting into a full RPG progression system with 8 modular virtual upgrade tracks, dynamic recipes, custom fuels, and stochastic loot drop tables.
Boost cooking speed, fuel efficiency, XP multipliers, Vault currency generation, virtual storage slots, and treasure luck.
Design advanced probabilistic recipes, progressive unlocks based on furnace usage, and native ItemsAdder/ExecutableItems support.
Each placed furnace permanently registers its owner, preventing unauthorized players from breaking it or modifying items, and auto-returns directly to inventory when broken.
Configure custom fuel burn multipliers, infinite fuels, and configurable stochastic treasure loot tables dropping during smelting.
Simple steps to deploy the plugin on your Minecraft server.
Place UltraFurnaces.jar inside the plugins/ folder of your server.
Start or restart your server to automatically generate folder structures and configurations in plugins/UltraFurnaces/.
Install Vault (plus an economy plugin like EssentialsX) if you want furnaces to generate money for owners. Install ItemsAdder or ExecutableItems for custom item recipes.
Global plugin parameters, rank limit systems, furnace owner protection, and custom sounds.
Global refresh interval for the smelting and upgrade processing engine. Default is 1 tick for maximum precision and smoothness.
tick-rate: 1Security rules for placed furnaces. Prohibits strangers from opening or breaking another player's furnace without permission or trusted access.
protection:
prevent-break: true
prevent-open: true
allow-hopper-access: false
Permission-based furnace placement limits. Players inherit the limits assigned to their rank group via ultrafurnaces.limit.<group>.
limits:
default:
total: 3
types:
basic: 3
advanced: 1
vip:
total: 10
types:
basic: 10
advanced: 5
Persistent storage backend for furnace blocks, upgrades, and inventories: SQLITE (local flatfile) or MYSQL (network database).
database:
type: SQLITEEach furnace can equip 8 independent upgrade systems configurable via progression arrays.
Reduces cooking time in ticks per item (default Minecraft is 200 ticks = 10s).
speed:
1: 180
2: 140
3: 100
4: 60
5: 20Fuel duration multiplier. Level 2 (2.0) means fuel burns twice as long.
efficiency:
1: 1.25
2: 1.50
3: 2.00Vanilla XP orb drop multiplier when withdrawing items from the output slot.
experience:
1: 1.5
2: 2.0
3: 3.0Vault currency generated directly into the owner's balance per smelted item.
money:
1: 0.5
2: 1.0
3: 2.5Percentage chance to duplicate the resulting smelted item.
double:
1: 10.0
2: 25.0
3: 50.0Expands internal virtual storage capacity inside the furnace management GUI.
storage:
1: 9
2: 18
3: 27
Percentage chance to discover random loot table items from treasures.yml during smelting.
treasures:
1: 2.5
2: 5.0
3: 10.0
Breakdown of each parameter present in furnace files under plugins/UltraFurnaces/furnaces/*.yml.
Physical block appearance and inventory item properties (material, display name, lore, glow, and custom-model-data).
display:
material: BLAST_FURNACE
name: "&6&lIndustrial Blast Furnace"
lore:
- "&7Smelts ores at blazing speeds."
glow: trueFloating text lines hovering above the placed furnace block with live placeholders.
hologram:
enabled: true
height: 1.2
lines:
- "&6&lIndustrial Furnace"
- "&7Owner: &f%owner%"
- "&7Speed: &a%speed% ticks"List of active upgrades and max level caps allowed for this specific furnace tier.
enabled-upgrades:
- type: speed
max-level: 5
- type: efficiency
max-level: 3
- type: money
max-level: 3
Create unique smelting recipes stored in plugins/UltraFurnaces/recipes/*.yml.
Define required inputs and outputs with custom names, lore, and ItemsAdder identifiers.
input:
material: ROTTEN_FLESH
amount: 1
output:
material: LEATHER
amount: 1
chance: 100.0Custom cook duration in ticks and base experience awarded upon collection.
cook-time: 100
experience: 2.5
Define specialized smelting fuels with custom burn durations and effects in fuels.yml.
Add custom fuel items by specifying their material, display name, lore, glow, and burn duration in ticks.
compressed_coal:
material: COAL
name: "&bCompressed Coal"
lore:
- "&7Burns 4x longer than regular coal."
glow: true
burn-time: 6400 # 320 seconds (32 items)
magic_fuel:
material: BLAZE_ROD
name: "&6Magic Blaze Rod"
burn-time: 12000 # 600 seconds (60 items)Modular loot drop system that rewards lucky players with bonus items during smelting cycles.
Organize loot by weighted drop pools (common, rare, legendary) with nested item groups and custom item support.
common:
- material: COAL
amount: 5
chance: 50.0
- material: IRON_NUGGET
amount: 3
chance: 30.0
rare:
- material: DIAMOND
amount: 1
chance: 10.0
- material: EMERALD
amount: 2
chance: 15.0Complete list of user and administrative commands for UltraFurnaces.
| Command & Syntax | Description | Permission |
|---|---|---|
| /uf give <player> <type> [amount] | Gives an upgraded furnace item to a player. | ultrafurnaces.command.give |
| /uf reload | Hot-reloads configuration files, recipes, fuels, and menus. | ultrafurnaces.command.reload |
| /uf item save <name> | Saves the currently held item into custom storage. | ultrafurnaces.command.item |
| /uf item delete <name> | Deletes a previously saved custom item. | ultrafurnaces.command.item |
| /uf trust <player> | Trusts a friend to open and access your targeted furnace. | ultrafurnaces.command.trust |
| /uf untrust <player> | Revokes a trusted player's access to your furnace. | ultrafurnaces.command.trust |
Internal descriptors for menus and PlaceholderAPI metrics for tabs and scoreboards.
| Placeholder | Description |
|---|---|
| %speed% | Current smelting speed value of the furnace in ticks. |
| %efficiency% | Current fuel burn efficiency multiplier. |
| %experience% | Current XP drop multiplier. |
| %money% | Vault currency generated per smelted item. |
| %extra_items% | Percentage chance to duplicate outputs. |
| %storage% | Current internal virtual storage capacity. |
| %treasures_chance% | Current treasure drop percentage chance. |
| Placeholder | Result |
|---|---|
| %ultrafurnaces_placed% | Total furnaces placed by the player. |
| %ultrafurnaces_placed_<type>% | Total furnaces of a specific tier placed by the player. |
| %ultrafurnaces_limit% | Global furnace placement limit of the player. |
| %ultrafurnaces_limit_<type>% | Placement limit for a specific furnace tier. |
UltraItemRoulette is a fast-paced round-based PvP minigame where players form a circle around a 3D roulette in the center. When the roulette stops, the selected player becomes the hunter with special equipment and must eliminate all others. Features automated arena rollback via FAWE, votable modes with custom kits, cosmetic win and elimination effects, SQL stats, and Vault economy support.
Authentic 3D deceleration curves, real-time spatial tick sounds, and vibrant glowing outlines for evaluated and selected candidates.
Create custom game modes with unique kits for the hunter and survivors, voting rules, and round timeouts.
High-speed zero-lag arena restoration powered by FAWE snapshots, automatic player respawn handling, and multi-arena queues.
Customizable victory dances, kill effects, death sounds, blood particles, SQL leaderboards, and Vault currency rewards.
Requirements and quick installation steps for UltraItemRoulette.
Place UltraItemRoulette.jar inside the plugins/ folder of your server.
FastAsyncWorldEdit (FAWE) or WorldEdit is recommended for instantaneous arena rollbacks between matches without lag.
Restart your server to automatically generate default game modes, 14 GUI interfaces, and cosmetic effects in plugins/UltraItemRoulette/.
Global game rules, PvP modes, round timers, roulette animation parameters, and economy rewards.
HUNT_SELECTED (others can only damage the chosen hunter) or FREE_FOR_ALL.
SELECTED_OUTCOME (ends when hunter dies or kills someone) or LAST_SURVIVOR.
allowed-commands.
ELIMINATE_SELECTED (eliminates hunter) or KEEP_SELECTED.
YELLOW) and final selection (RED).
INTERNAL, VAULT, EXCELLENT_ECONOMY, or CUSTOM.
VOTE, RANDOM, FIXED, or ADMIN_CHOICE.
Each mode file defines its vote priority, GUI icons, and kits assigned to the Selected Hunter (kits.selected) and Other Players (kits.others).
Game modes transform the combat dynamics of each round. During pre-match lobby, players vote for their preferred mode:
Players choose their favorite mode in the voting GUI. The mode with the most votes is selected for the match.
The server randomly picks an enabled mode among all YAML files in modes/.
Each file in modes/ can override global rules from config.yml:
rules.timeout.duration-seconds: Adjusts round timeout duration for this specific mode.rules.center-effect: Defines a unique center particle effect for this mode.schema-version: 1
enabled: true
display:
name: "<gradient:#FFAA00:#FFFF55>Default</gradient>"
icon: MACE
lore:
- "<gray>The default mode when no vote wins."
- "<gray>Selected kit: <white>Mace + 5 Wind Charges"
kits:
selected:
inventory:
0:
material: MACE
name: "<#FFAA00>Selected Player's Mace"
unbreakable: true
1:
material: WIND_CHARGE
amount: 5
selector-item:
material: MACE
glow: true
scale: 1.00
rules:
timeout:
duration-seconds: 30schema-version: 1
enabled: true
display:
name: "<gradient:#FF5555:#FFAA00>Archer</gradient>"
icon: BOW
lore:
- "<gray>Bow battle with custom arrows."
kits:
selected:
inventory:
0:
material: BOW
name: "<#FF5555>Hunter's Recurve Bow"
unbreakable: true
1:
material: ARROW
amount: 16Step-by-step administrator walkthrough to create, define spawn anchors, and save FAWE rollback-enabled arenas.
Run /uir create <name> to load the arena editor world. An isolated plot is generated automatically for building and defining boundaries.
Stand at the exact center of the arena and run /uir setcenteritem. Next, position yourself at each player spot and execute /uir addspawn until all player positions are configured.
Set the arena capacity with /uir setmaxplayers <count> and finalize by running /uir save. The arena snapshot will be compiled and ready to host games.
With /uir quickcreate <name> <floor_block> <max_players> [mode], you can generate complete working arenas with circular player distribution in seconds:
Standard circular layout with 7.0 blocks radius from the central item. Ideal for medium to large matches.
Reduced 4.5 block radius for smaller arenas and intense close-quarters combat.
The 14 default inventory GUIs generated by UltraItemRoulette, including main menu, arena browser, voting, cosmetics, and spectator tools.
title: "<#9d7171><bold>ItemRoulette</bold>"
rows: 3
items:
arenas:
slot: 11
material: COMPASS
name: "<green>Play Now"
cosmetics:
slot: 13
material: NETHER_STAR
name: "<yellow>Cosmetics"
stats:
slot: 15
material: BOOK
name: "<aqua>My Statistics"title: "<#9d7171>Select Arena"
rows: 5
pagination:
enabled: true
slots: [10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 23, 24, 25]title: "<#9d7171>Vote for Game Mode"
rows: 3
slots: [11, 12, 13, 14, 15]title: "<#9d7171>Victory Celebrations"
rows: 4Configuration of visual particle and audio effects for victory celebrations, player elimination bursts, and center roulette reveals.
Celebration sequences triggered around the winning survivor at match completion.
type: FIREWORK_SPIRAL
colors: ["#FFAA00", "#FF5555", "#55FFFF"]
duration-seconds: 5type: LIGHTNING_STRIKE
sound: ENTITY_LIGHTNING_BOLT_THUNDER
safe-visual-only: trueVisual bursts and sound cues played at the exact coordinates where a player is eliminated.
particle: SOUL_FIRE_FLAME
count: 30
sound: ENTITY_BLAZE_DEATHparticle: EXPLOSION_NORMAL
count: 20
sound: ENTITY_GENERIC_EXPLODEComplete reference of user and administrative commands for UltraItemRoulette.
| Command & Syntax | Description | Permission |
|---|---|---|
| /uir join [arena] | Joins a specific arena lobby or opens the arena selector. | ultraitemroulette.play |
| /uir leave | Leaves the current arena and restores previous inventory. | ultraitemroulette.play |
| /uir replay | Requests to requeue in the same arena. | ultraitemroulette.play |
| /uir vote <mode> | Votes for a game mode in the pre-match countdown. | ultraitemroulette.vote |
| /uir create <name> | Starts interactive arena creation session in editor world. | ultraitemroulette.admin |
| /uir quickcreate <name> <block> <max> | Instantly generates a preconfigured arena with circular spawns. | ultraitemroulette.admin |
| /uir fakeplayers <count> | Adds simulated bot players to test arena gameplay. | ultraitemroulette.admin |
| /uir start [arena] | Forces immediate start of a match in the arena. | ultraitemroulette.admin |
| /uir stop <arena> | Stops the active match and resets arena. | ultraitemroulette.admin |
| /uir delete <arena> | Permanently deletes an arena and its FAWE snapshot. | ultraitemroulette.admin |
| /uir reload | Reloads all configurations, modes, GUIs, and effects. | ultraitemroulette.admin |
Internal message variables and PlaceholderAPI (PAPI) metrics for scoreboards and holograms.
| Placeholder | Result |
|---|---|
| %player% / <player_name> | Current player name. |
| %selected% / <selected_player> | Name of hunter selected by the roulette. |
| %arena% / <arena> | Active arena identifier. |
| %mode% / <mode> | Public name of active game mode. |
| %round% / <round> | Current round number. |
| %time% / <time> | Remaining round time or countdown in seconds. |
| %alive% / <alive_players> | Number of surviving players in the round. |
| %score% / <score> | Player accumulated score/points. |
| %economy_balance% | Formatted economy balance (Vault/ExcellentEconomy). |
| Placeholder | Result |
|---|---|
| %ultraitemroulette_wins% | Total player wins. |
| %ultraitemroulette_kills% | Total player kills. |
| %ultraitemroulette_deaths% | Total player deaths. |
| %ultraitemroulette_games_played% | Total matches played. |
| %ultraitemroulette_arena_status_<id>% | Current status of specified arena (WAITING, STARTING, IN_GAME). |
| %ultraitemroulette_arena_players_<id>% | Current players in arena (e.g. 4/12). |
UltraCities is a block-based city and land protection system for Paper 1.21.11 and newer. Engineered with zero-lag asynchronous spatial chunk indexing, persistent 3D subzones, 65 typed protection flags, installable crystals, active shields, and global raid events.
Place a physical city core to claim territory. Each core type supports independent leveling, radius expansions, member capacity caps, and shared live chest storage.
Granular control over block physics, combat, explosions, vehicles, and environmental growth with distinct audience rules for owners, members, and visitors.
Socket modular crystals into city cores to provide potion buffs, AuraSkills XP multipliers, crop growth acceleration, temporary flight, or death interception.
Select 3D cuboids with particle wand wireframes. Subzone owners manage independent flags, add local members, and sell plots through an integrated real estate market.
Setting up UltraCities on your Minecraft server. Follow these steps for an optimal configuration.
Requires Java 21 or newer and Paper 1.21.11+ (or compatible forks like Purpur). Optional dependencies include Vault, ExcellentEconomy, and PlaceholderAPI.
Place UltraCities-1.0.0.jar into your server's plugins/ folder.
Start your server to automatically generate configuration files, default core types, and the SQLite database.
Run /uc give <player> basic to give yourself the starter city core block.
Place the core block on the ground and right-click it to open the interactive city control GUI.
plugins/UltraCities/
├── config.yml # Global settings, borders, wireframes, distance rules
├── messages.yml # Chat messages, actionbars, titles, flag denial texts
├── flags.yml # Global baseline defaults, entity lists, GUI displays
├── upgrade-effects.yml # Fireworks, sounds, and broadcast announcements
├── data/
│ └── ultracities.db # SQLite database (cities, subzones, members, skins)
├── city-blocks/ # Modular protection block types (e.g., basic.yml)
├── crystals/ # Installable modular crystal definitions
├── shields/ # Shield types, durations, and costs
├── events/ # Global event configurations (raids.yml, booster.yml)
└── guis/ # 6-row slot-controlled inventory menus
Cities originate from physical core blocks defined in city-blocks/*.yml. Upgrading cores expands their radius, storage, members, and defense.
Each file under city-blocks/ defines a persistent block id. Modifying material properties updates active cores immediately upon /uc reload without forcing chunk reloads.
id: basic
material: LODESTONE
display-name: "&#cf745a&lCity Core &7(Basic)"
lore:
- "&7Place this core to claim your city territory."
- "&eRight-click to manage your city once placed."
worlds:
mode: BLACKLIST
list:
- world_nether
- world_the_end
worldguard:
prevent-region-overlap: trueEach level provides scalable benefits. Upgrades immediately recalculate active cuboid radius and expand limits.
| Attribute | Description |
|---|---|
| radius | Horizontal square distance from the core. Covers full world height (-64 to 320). |
| max-members | Maximum player capacity permitted in the city. |
| chest-rows | Size of the shared live storage chest (1 to 6 inventory rows). |
| crystal-slots | Number of installable crystal sockets unlocked in guis/crystals.yml. |
| raid-block-hits | Hits required by raiders to break blocks during active global raids. |
| upgrade-cost | Multi-currency payment groups supporting Vault, ExcellentEconomy, and custom items. |
The level upgrade menu (guis/level-progress.yml) guides players through a snake progression path displaying completed levels, current tier with upgrade actions, and locked future milestones.
UltraCities provides 65 typed protection flags with full control over blocks, combat, physics, vehicles, and the environment. Each flag can be configured with discrete boolean states and target audiences.
Flags follow a three-tier cascade: 1. Global Defaults (defined in flags.yml) provide baseline settings; 2. Block Defaults (in city-blocks/*.yml) override globals for specific core tiers; and 3. In-Game GUI allows city owners to toggle editable rules in real time.
Inside the flag GUI, Left-Click toggles the rule state (ALLOW / DENY) and Right-Click cycles through permitted audiences: ALL, MEMBERS, NON_MEMBERS, OWNERS, and NON_OWNERS.
| Flag | Type | Description |
|---|---|---|
| build | ALLOW/DENY | Master building permission governing general block breaking, placing, and structural modifications. |
| block-break | ALLOW/DENY | Allows or prevents destroying blocks independently from the master build permission. |
| block-place | ALLOW/DENY | Allows or prevents placing blocks independently from the master build permission. |
| block-trampling | ALLOW/DENY | Prevents farmland from reverting to dirt and turtle eggs from cracking when jumped on. |
| pistons | ALLOW/DENY | Controls piston pushes and retractions that occur entirely within city borders. |
| pistons-out | ALLOW/DENY | Governs pistons pushing blocks across borders into or pulling blocks out of the city. |
| interact | ALLOW/DENY | Controls physical interaction with armor stands, item frames, and miscellaneous entities. |
| use | ALLOW/DENY | Governs opening doors, trapdoors, fence gates, levers, stonecutters, and workstation blocks. |
| chest-access | ALLOW/DENY | Controls opening and withdrawing items from chests, trapped chests, barrels, and shulker boxes. |
| use-anvil | ALLOW/DENY | Controls opening and using repair, rename, and combine interfaces in anvils. |
| use-portals | ALLOW/DENY | Governs entering and teleporting through Nether portals and End portal frames. |
| item-frame-rotation | ALLOW/DENY | Controls rotating items mounted inside regular and glow item frames. |
| villager-trading | ALLOW/DENY | Controls opening the trading window and trading emeralds with villagers and wandering traders. |
| fishing-rod | ALLOW/DENY | Controls casting fishing rods and hooking entities or blocks inside the city. |
| pvp | ALLOW/DENY | Controls player-versus-player melee combat, projectile damage, and sweeps within city borders. |
| damage-animals | ENTITY_SET | Governs attacking peaceful and passive animals. Supports Bukkit EntityType filter lists. |
| damage-mobs | ENTITY_SET | Governs attacking hostile and neutral monster mobs. Supports Bukkit EntityType filter lists. |
| damage-villagers | ALLOW/DENY | Protects villagers and wandering traders from being damaged or slain by players. |
| mob-damage | ALLOW/DENY | Controls whether hostile monsters can deal damage to players inside the city. |
| fall-damage | ALLOW/DENY | Controls taking fall damage upon landing from high heights within city territory. |
| firework-damage | ALLOW/DENY | Controls damage to players and entities caused by exploding firework rockets and crossbows. |
| potion-splash | ALLOW/DENY | Controls splash and lingering potion projectile impacts and area-of-effect clouds. |
| wind-charge | ALLOW/DENY | Governs firing and impact knockback physics of breeze wind charges. |
| tnt | ALLOW/DENY | Controls TNT block placement, priming, and explosion damage to structures. |
| creeper-explosion | ALLOW/DENY | Governs block destruction and entity damage caused by creeper detonations. |
| ghast-fireball | ALLOW/DENY | Governs explosion damage and fiery crater creation from ghast fireballs. |
| enderdragon-block-damage | ALLOW/DENY | Prevents the Ender Dragon's flight and body collision from breaking blocks. |
| wither-damage | ALLOW/DENY | Controls block shattering, wither skulls, and spawning blast damage from the Wither. |
| other-explosion | ALLOW/DENY | Controls miscellaneous explosions such as respawn anchors, end crystals, and bed explosions. |
| enderman-grief | ALLOW/DENY | Prevents Endermen from picking up, carrying, or placing blocks in the city. |
| ravager-grief | ALLOW/DENY | Prevents ravager roars, charging, and walking from destroying crops and foliage. |
| lighter | ALLOW/DENY | Controls striking flint and steel or using fire charges to ignite blocks. |
| entry | ALLOW/DENY | Governs entering across the city boundary. Denied players are repelled with knockback. |
| exit | ALLOW/DENY | Governs leaving the city boundary. Denied players are pushed back toward the interior. |
| enderpearl | ALLOW/DENY | Controls throwing and teleporting via ender pearls into or out of the city. |
| chorus-fruit-teleport | ALLOW/DENY | Controls random spatial teleportation triggered when eating chorus fruit. |
| fly | ALLOW/DENY | Allows or revokes flight mode for players within the city cuboid. |
| ride | ALLOW/DENY | Governs mounting and riding horses, donkeys, camels, striders, and rideable animals. |
| sleep | ALLOW/DENY | Controls entering and sleeping in beds within the city to pass the night. |
| vehicle-place | ALLOW/DENY | Governs placing boats, chest boats, minecarts, and other vehicle entities. |
| vehicle-destroy | ALLOW/DENY | Governs breaking or dealing damage to boats, minecarts, and vehicles. |
| vehicle-use | ALLOW/DENY | Controls entering and piloting vehicle entities (boats, minecarts) inside city borders. |
| mob-spawning | ENTITY_SET | Controls natural mob spawning. Supports Bukkit EntityType filter lists. |
| deny-spawn | ENTITY_SET | Denies specific entity types from spawning within city territory. |
| water-flow | ALLOW/DENY | Governs water spreading, liquid stream physics, and infinite water generation. |
| lava-flow | ALLOW/DENY | Governs lava spreading, fluid flow physics, and cobblestone generation. |
| lava-fire | ALLOW/DENY | Governs lava igniting nearby flammable blocks (wood, wool, leaves). |
| fire-spread | ALLOW/DENY | Governs natural propagation of fire between combustible adjacent blocks. |
| lightning | ALLOW/DENY | Controls natural lightning strikes and lightning-induced fires during thunderstorms. |
| snowman-trails | ALLOW/DENY | Controls snow layers generated beneath snow golems as they walk. |
| snow-fall | ALLOW/DENY | Controls natural accumulation of snow layers during snowfall weather. |
| snow-melt | ALLOW/DENY | Controls snow layers melting due to light sources (torches, lanterns). |
| ice-form | ALLOW/DENY | Controls water surfaces freezing into solid ice blocks in cold biomes. |
| ice-melt | ALLOW/DENY | Controls natural ice melting into water when exposed to warm light levels. |
| frosted-ice-form | ALLOW/DENY | Governs frosted ice creation when players walk on water with Frost Walker enchantment. |
| frosted-ice-melt | ALLOW/DENY | Controls the natural cracking and melting decay stages of frosted ice blocks. |
| crop-growth | ALLOW/DENY | Controls natural growth ticks for wheat, carrots, potatoes, beetroots, and melon stems. |
| soil-dry | ALLOW/DENY | Controls hydrated farmland dehydrating back into ordinary dirt when unwatered. |
| leaf-decay | ALLOW/DENY | Controls natural leaf despawning and sapling drops when disconnected from logs. |
| grass-growth | ALLOW/DENY | Controls spreading of grass and mycelium to adjacent unlit dirt blocks. |
| mushroom-growth | ALLOW/DENY | Governs natural spreading and stem growth of red and brown mushrooms. |
| rock-growth | ALLOW/DENY | Governs growth of dripstone blocks and pointed dripstone stalactites/stalagmites. |
| sculk-growth | ALLOW/DENY | Governs sculk catalyst propagation and sensor/shrieker generation upon entity death. |
| coral-fade | ALLOW/DENY | Controls alive coral blocks dying into dead coral when exposed outside water. |
| copper-fade | ALLOW/DENY | Controls weathering, oxidation, and green patina progression on unwaxed copper blocks. |
| weather-clock | ALLOW/DENY | Locks visual client weather inside city borders (CLEAR, RAIN, THUNDER). |
| time-lock | ALLOW/DENY | Locks client sky time inside city borders (e.g. DAY, NOON, NIGHT, MIDNIGHT). |
Crystals are socketable modular items placed into city cores to provide custom team perks, potion buffs, skill bonuses, flight, death protection, or raid resistance. Each file in plugins/UltraCities/crystals/*.yml defines an independent crystal.
Defines base item material, optional player head Base64 value, display name with HEX color codes, lore lines, visual glow, and minimum required city level to socket the crystal.
material: AMETHYST_SHARD
# value: "" # Optional player head Base64 value
name: "&#cf745a&lOmni-Crystal &7(Tier 3)"
lore:
- "&7Grants active buffs to members inside territory."
- ""
- " &8| &7Required Level: &f{required-level}"
- " &8| &7Remaining Uses: &f{remaining-uses}"
glow: true
required-city-level: 3
Controls when the crystal mechanics are active: ALWAYS (active 24/7), RAID_ONLY (activates only during active global raid events), or OUTSIDE_RAID (active during peaceful times only).
# Options: ALWAYS, RAID_ONLY, or OUTSIDE_RAID
activation-mode: ALWAYS
List of crystal IDs that cannot coexist in the same city core. Compatibility is enforced bi-directionally: listing guardian in speed also prevents installing speed while guardian is present.
incompatible-with:
- speed_crystal
- guardian_crystalApplies continuous Bukkit potion effects to the configured audience while within city territory. Supports potion amplifier levels, ambient mode, and particle toggles.
effects:
audience: MEMBERS # ALL, MEMBERS, NON_MEMBERS, OWNERS, NON_OWNERS
list:
- type: SPEED
level: 2
ambient: true
particles: false
- type: REGENERATION
level: 1
ambient: true
particles: trueConfigures custom XP gain multipliers for specified skill groups and accelerates natural mana regeneration for players inside the city.
aura-skills:
audience: MEMBERS
xp-multipliers:
- skills: [MINING, FORAGING, FARMING]
multiplier: 2.0
- skills: [COMBAT]
multiplier: 1.5
mana-regeneration:
multiplier: 1.25
Restricts custom enchantments from AdvancedEnchantments from activating inside city territory for the target audience. Supports wildcard "*" to deny all custom enchantments.
advanced-enchantments:
audience: NON_MEMBERS
denied:
- TRENCH
- TELEPATHY
- EXPLOSIVEProhibits specified item materials and consumables from being used, drunk, or thrown inside city borders by the configured audience.
blocked-items:
audience: NON_MEMBERS
materials:
- ENDER_PEARL
- CHORUS_FRUIT
- LAVA_BUCKET
- BOWAccelerates natural crop age steps for configured ageable vegetation inside city boundaries without altering the server-wide tick rate.
random-tick:
multiplier: 2.5
blocks:
- WHEAT
- CARROTS
- POTATOES
- BEETROOTS
- NETHER_WART
- SUGAR_CANEWhen enabled, completely freezes natural hunger exhaustion, sprint depletion, and starvation for the designated audience while inside the city.
hunger:
enabled: true
audience: MEMBERSEnables creative flight within city borders. Includes a configurable border exit warning with titles, actionbars, audio ticks, and grace countdown before revoking flight.
flight:
enabled: true
audience: MEMBERS
exit-warning:
enabled: true
duration-seconds: 3
messages:
title: "&c&lFlight disabled in &f{seconds}s"
subtitle: "&7Return to &f{city} &7to keep flying."
sound:
enabled: true
type: BLOCK_NOTE_BLOCK_HAT
volume: 0.35
pitch: 1.2
Intercepts lethal damage like a Totem of Undying, restoring player health to health-hearts with particle animations and sound effects. Supports cooldowns and optional finite consumable uses.
death-protection:
enabled: true
audience: MEMBERS
cooldown-seconds: 300
health-hearts: 4.0
sound: ITEM_TOTEM_USE
particles: true
finite-uses:
enabled: true
max-uses: 5Adds extra hit durability to the city's blocks during global raids. Installed crystals stack their hit resistances additively with the city core level baseline.
raid-block-resistance:
additional-hits: 2
Click the dropdown below to view a complete, commented example.yml containing every single crystal section ready for copy-pasting.
# ==============================================================================
# UltraCities - Comprehensive Crystal Template (example.yml)
# Place in plugins/UltraCities/crystals/example.yml
# ==============================================================================
enabled: true
material: AMETHYST_SHARD
# Optional custom player head base64 value (leave empty if using normal material)
# value: ""
name: "&#cf745a&lOmni-Crystal &7(Master Tier)"
lore:
- "&7Grants multiple active buffs to city members,"
- "&7accelerates crop growth and protects during raids."
- ""
- " &8| &7Required Level: &f{required-level}"
- " &8| &7Remaining Uses: &f{remaining-uses}"
glow: true
required-city-level: 3
# Activation mode: ALWAYS, RAID_ONLY or OUTSIDE_RAID
activation-mode: ALWAYS
# Mutually exclusive crystals (cannot be installed at the same time)
incompatible-with:
- speed_crystal
- defense_crystal
# 1. Potion Effects Configuration
effects:
audience: MEMBERS
list:
- type: SPEED
level: 2
ambient: true
particles: false
- type: REGENERATION
level: 1
ambient: true
particles: true
# 2. Death Protection (Undying Totem Interception)
death-protection:
enabled: true
audience: MEMBERS
cooldown-seconds: 300
health-hearts: 4.0
sound: ITEM_TOTEM_USE
particles: true
finite-uses:
enabled: true
max-uses: 5
# 3. Flight inside city borders
flight:
enabled: true
audience: MEMBERS
exit-warning:
enabled: true
duration-seconds: 3
messages:
title: "&c&lFlight disabled in &f{seconds}s"
subtitle: "&7Return to &f{city} &7to keep flying."
sound:
enabled: true
type: BLOCK_NOTE_BLOCK_HAT
volume: 0.35
pitch: 1.2
# 4. AuraSkills Multipliers (Optional Integration)
aura-skills:
audience: MEMBERS
xp-multipliers:
- skills: [MINING, FORAGING, FARMING]
multiplier: 2.0
- skills: [COMBAT]
multiplier: 1.5
mana-regeneration:
multiplier: 1.25
# 5. Crop Growth Acceleration (Random Ticks)
random-tick:
multiplier: 2.5
blocks:
- WHEAT
- CARROTS
- POTATOES
- BEETROOTS
- NETHER_WART
- SUGAR_CANE
# 6. Hunger & Exhaustion Cancellation
hunger:
enabled: true
audience: MEMBERS
# 7. Blocked Items for Non-Members
blocked-items:
audience: NON_MEMBERS
materials:
- ENDER_PEARL
- CHORUS_FRUIT
- LAVA_BUCKET
# 8. AdvancedEnchantments Restriction
advanced-enchantments:
audience: NON_MEMBERS
denied:
- TRENCH
- TELEPATHY
# 9. Raid Block Durability Bonus (Active during raids)
raid-block-resistance:
additional-hits: 2
Shields defend cities against outsider block breaking, crystal theft, and destruction during global raid events. Each file in plugins/UltraCities/shields/*.yml defines a distinct shield tier with its own duration, appearance, and multi-currency cost.
Defines physical shield item appearance: material (e.g. SHIELD or PLAYER_HEAD), optional Base64 head texture, display name, and lore formatting. Supports placeholders like {duration}, {vault-amount}, and {currency-<id>-amount}.
enabled: true
material: SHIELD
# value: "" # Optional player head Base64 value
name: "&#cf745a&lFortress Shield &7(12 Hours)"
lore:
- "&7Grants complete immunity against raid destruction,"
- "&7block breaking, and crystal theft."
- ""
- " &8| &7Duration: &f{duration}"
- " &8| &7Cost: &e{vault-amount} {vault-name}"
Total protection duration in seconds (e.g. 3600 for 1 hour, 43200 for 12 hours, 86400 for 24 hours). While active, the city is completely immune to outsider raid damage.
# 43200 seconds = 12 hours
duration-seconds: 43200
Payment engine supporting Vault economy, ExcellentEconomy custom currencies, and physical item requirements. Supports mode: ALL (charges all enabled payment groups) or mode: ANY (accepts the first affordable group).
cost:
enabled: true
mode: ALL # Options: ALL or ANY
vault:
enabled: true
amount: 5000.0
display-name: "&eCoins"
excellent-economy:
enabled: true
currencies:
- id: gems
amount: 25.0
display-name: "&bGems"
items:
enabled: true
requirements:
- material: NETHERITE_INGOT
amount: 1
- material: DIAMOND
amount: 16
Controlled via guis/shields.yml. Menus refresh automatically once per second, updating live {shield-remaining} countdowns without reopening. The dynamic [REMOVE-SHIELD] button appears for city owners to dismiss active protection.
# Inside plugins/UltraCities/guis/shields.yml
shield-display:
active:
material: ENCHANTED_BOOK
glow: true
lore:
- "&a&lCURRENTLY ACTIVE"
- "&7Expires in: &e{shield-remaining}"
blocked:
lore:
- "&cAnother shield is currently active."
Click the dropdown below to view a complete, commented example.yml containing every configurable shield option.
# ==============================================================================
# UltraCities - Comprehensive Shield Template (example.yml)
# Place in plugins/UltraCities/shields/example.yml
# The file name (without .yml) is the persistent shield ID.
# ==============================================================================
enabled: true
material: SHIELD
# value: "" # Optional player head Base64 value
name: "&#cf745a&lFortress Shield &7(12 Hours)"
lore:
- "&7Grants complete immunity against raid destruction,"
- "&7block breaking, and crystal theft."
- ""
- " &8| &7Duration: &f{duration}"
- " &8| &7Vault Price: &e{vault-amount} {vault-name}"
- " &8| &7Gems: &b{currency-gems-amount} {currency-gems-name}"
# Protection duration in seconds (43200 seconds = 12 hours)
duration-seconds: 43200
# Multi-currency cost configuration
cost:
enabled: true
# mode: ALL (requires every enabled group) or mode: ANY (first affordable group)
mode: ALL
# Standard Vault Economy
vault:
enabled: true
amount: 5000.0
display-name: "&eCoins"
# ExcellentEconomy Custom Currencies
excellent-economy:
enabled: true
currencies:
- id: gems
amount: 25.0
display-name: "&bGems"
- id: tokens
amount: 5.0
display-name: "&6Tokens"
# Physical Item Payment Requirements
items:
enabled: true
requirements:
- material: NETHERITE_INGOT
amount: 1
- material: DIAMOND
amount: 16Persistent 3D subzones allow players to carve out plots within a city, assign independent flags, manage local members, or list land for sale on the open market.
Administrators grant the selection wand with /city subzone wand <player>. Left-click selects corner one and right-click selects corner two. A temporary 3D particle wireframe traces all 12 edges in real-time.
Subzone owners can list plots with /uc subzone sell [name], choose their target currency (Vault or ExcellentEconomy), and enter the sale price into chat. Prospective buyers inspect and complete purchases through guis/subzone-buy-confirm.yml, transferring ownership atomically.
Subzone flags take full priority over parent-city flags within the cuboid boundaries. Buyers enjoy full autonomy, and parent-city owners are treated as visitors inside the plot until explicitly granted local permissions.
Events are server-wide gameplay states configured in plugins/UltraCities/events/*.yml. Events persist across server restarts and provide live bossbars, broadcast audio, raid sieges, and booster multipliers.
Defines unique command identifier, event type (RAID or BOOSTER), and priority number (higher priority overrides conflicts when multiple events run simultaneously).
id: example_raid
type: RAID # Options: RAID or BOOSTER
enabled: true
priority: 10 # Highest priority wins in case of conflicting forced flags
Plays Bukkit sound effects to all connected players on sounds.started and sounds.ended with independent volume and pitch configuration.
sounds:
started:
enabled: true
sound: BLOCK_BEACON_ACTIVATE
volume: 0.8
pitch: 0.75
ended:
enabled: true
sound: UI_TOAST_CHALLENGE_COMPLETE
volume: 0.8
pitch: 1.0
Renders a live bossbar across player screens displaying title, custom color (RED, PURPLE, BLUE, GREEN, YELLOW, PINK, WHITE), style overlay, and live {remaining} countdown.
bossbar:
enabled: true
title: "&#cf745a&lSIEGE OF CITIES &8| &f{remaining}"
color: RED # RED, PURPLE, BLUE, GREEN, YELLOW, PINK, WHITE
overlay: PROGRESS # PROGRESS, NOTCHED_6, NOTCHED_10, NOTCHED_12, NOTCHED_20
Controls block destruction during raid events. Supports WHITELIST (only listed blocks can be broken) or BLACKLIST (all blocks except listed can be broken), item drops, and anti-macro packet hit cooldowns.
breaking:
enabled: true
mode: BLACKLIST # Options: WHITELIST or BLACKLIST
blocks:
- BEDROCK
- BARRIER
- END_PORTAL_FRAME
- COMMAND_BLOCK
drop-items: true
hit-cooldown-millis: 250 # Anti-macro hit protectionWhen enabled, raiders can infiltrate unshielded city cores during active raids and steal installed crystals by interacting with the physical core block.
crystals:
stealable: trueTemporarily overrides city flags across all unshielded cities while the event is running. When the event ends, all cities return to their normal configured rules automatically. Active shields are immune to all overrides.
forced-flags:
block-break:
state: ALLOW
audience: NON_MEMBERS
block-place:
state: DENY
audience: NON_MEMBERS
chest-access:
state: ALLOW
audience: NON_MEMBERS
pvp:
state: ALLOW
audience: ALL
tnt:
state: DENY
audience: NON_MEMBERS
Configured when type: BOOSTER. Multiplies AuraSkills XP gains and accelerates crop growth ticks within cities. Multiple concurrent boosters stack multiplicatively.
aura-skills:
xp-multipliers:
- skills: [MINING, FORAGING, FARMING]
multiplier: 2.0
- skills: [COMBAT]
multiplier: 1.5
random-tick:
multiplier: 3.0
blocks:
- WHEAT
- CARROTS
- POTATOES
- NETHER_WART
Formatted broadcast announcements sent to all players when the event starts and ends. Supports {duration}, {remaining}, and color codes.
messages:
prefix: "&8[&#cf745aRaid Event&8] "
started:
- "&#cf745aA server-wide city raid has commenced for &f{duration}&#cf745a!"
- "&7Unshielded cities are now vulnerable to block breaking and crystal theft."
ended:
- "&aThe city raid event has concluded."
- "&7All city protections have returned to their normal configured rules."
Click the dropdown below to view a complete, commented example.yml containing every configurable event section.
# ==============================================================================
# UltraCities - Comprehensive Event Template (example.yml)
# Place in plugins/UltraCities/events/example.yml
# ==============================================================================
# Unique identifier used by commands: /city event start example <duration>
id: example_raid
type: RAID # Options: RAID or BOOSTER
enabled: true
priority: 10 # Highest priority wins in case of conflicting forced flags
# Global audio notifications played to all online players
sounds:
started:
enabled: true
sound: BLOCK_BEACON_ACTIVATE
volume: 0.8
pitch: 0.75
ended:
enabled: true
sound: UI_TOAST_CHALLENGE_COMPLETE
volume: 0.8
pitch: 1.0
# Live bossbar display shown across player screens
bossbar:
enabled: true
title: "&#cf745a&lSIEGE OF CITIES &8| &f{remaining}"
color: RED # RED, PURPLE, BLUE, GREEN, YELLOW, PINK, WHITE
overlay: PROGRESS # PROGRESS, NOTCHED_6, NOTCHED_10, NOTCHED_12, NOTCHED_20
# Raid Destruction Mechanics (Applicable when type is RAID)
breaking:
enabled: true
# WHITELIST allows only specified blocks; BLACKLIST allows all except listed blocks
mode: BLACKLIST
blocks:
- BEDROCK
- BARRIER
- END_PORTAL_FRAME
- COMMAND_BLOCK
drop-items: true
hit-cooldown-millis: 250 # Anti-macro protection for block hits
# Crystal theft mechanic from unshielded city cores
crystals:
stealable: true
# Temporary flag overrides during the event (Shielded cities are immune)
forced-flags:
block-break:
state: ALLOW
audience: NON_MEMBERS
block-place:
state: DENY
audience: NON_MEMBERS
chest-access:
state: ALLOW
audience: NON_MEMBERS
pvp:
state: ALLOW
audience: ALL
tnt:
state: DENY
audience: NON_MEMBERS
# Event Broadcast Announcements
messages:
prefix: "&8[&#cf745aRaid Event&8] "
started:
- "&#cf745aA server-wide city raid has commenced for &f{duration}&#cf745a!"
- "&7Unshielded cities are now vulnerable to block breaking and crystal theft."
ended:
- "&aThe city raid event has concluded."
- "&7All city protections have returned to their normal configured rules."
Use /city, /uc, /cities, or /ultracities. Required arguments use < >; optional arguments use [ ]. City commands normally target the protection at your location.
| Command | Description |
|---|---|
| /city [help] | Shows the command guide. The argument is optional. |
| /city menu | Opens the main panel for the city at your location. |
| /city list | Opens the directory of all cities. |
| /city border | Temporarily shows the current city's particle border. |
| /city hologram [on|off|toggle] | Controls your personal view of city holograms; omitting the argument toggles it. |
| /city rename <new name> | Owner only: renames the current city. Color codes and any configured cost, cooldown, or confirmation apply. |
| /city tag <tag|clear> | Owner only: sets or clears the city's short tag. |
| /city add <player> | Owner only: adds a full-access member, subject to the city's member limit. |
| /city remove <player> | Owner only: removes a city member. |
| /city flags | Owner only: opens the city's editable flags panel. |
| /city flags <player> | Owner only: opens an existing member's individual flags panel. |
| /city flag <flag> <allow|deny> [audience] | Owner only: sets a city flag to a state and optional audience allowed by that protection block's configuration. |
| /city userflags <player> | Owner only: opens an existing member's individual flags panel. |
| /city userflags <player> <flag> <allow|deny> | Owner only: directly changes one of that member's individual flags. |
| /city userflag <player> <flag> <allow|deny> | Singular alternative for changing one individual flag. |
| /city nearby request <player> | Asks another online city owner to allow placement inside the minimum city distance. |
| /city nearby accept <player> | Accepts that player's nearby-placement request. |
| /city nearby deny <player> | Declines that player's nearby-placement request. |
| Command | Description |
|---|---|
| /city subzone | Opens settings for the subzone at your location. |
| /city subzone <name> | Opens the named subzone's settings panel. |
| /city subzone menu | Opens the parent city's subzone browser; requires access to the main city. |
| /city subzone list | Lists the parent city's subzones; requires access to the main city. |
| /city subzone create <name> | Creates a subzone from two wand-selected positions, subject to limits and creation cost. |
| /city subzone delete <name> | Deletes a subzone you are allowed to manage. |
| /city subzone cancel | Clears your wand selection. |
| /city subzone sell [name] | Opens sale setup for the named or current subzone. |
| /city subzone unsell [name] | Removes the sale listing; unlist is an alias. |
| /city subzone buy [name] | Opens the purchase confirmation panel. |
| /city subzone flags [name] | Opens the named or current subzone's independent flags panel. |
| /city subzone add <player> | Adds a player to the subzone at your location and opens their individual flags panel. |
| /city subzone remove <player> | Removes a player from the subzone at your location. |
| Command | Description |
|---|---|
| /city give <player> <type> [amount] | Gives a configured protection block item to a player. |
| /city crystal give <player> <crystal> [amount] [silent] | Gives a configured crystal; silent suppresses the recipient notification. |
| /city subzone wand <player> | Gives the subzone selection wand to an online player. |
| /city event start <event-id> <duration> | Starts a configured global raid or booster. Duration accepts seconds or an s, m, h, or d suffix, such as 30m. |
| /city event stop <event-id> | Stops that global event. |
| /city reload | Reloads UltraCities configuration. |
| /city admin [help] | Shows the operator-only administration guide. |
| /city admin menu | Opens the main panel of the city at your location with administrator access. |
| /city admin flags | Opens that city's flags panel with administrator access. |
| /city admin flags <world> <flag> <allow|deny> <audience> | Sets a flag across cities in one world, skipping configurations that do not allow the chosen state or audience. |
| /city admin protections <player> | Opens a list of the player's owned protections, with teleport options. |
| /city admin add <player> | Adds a member to the current city without checking its member limit and opens individual flags. |
| /city admin remove <player> | Removes a member from the current city. |
| /city admin owner <player> | Transfers ownership of the current city. |
| /city admin upgrade [levels|max] | Advances the current city's level without payment or upgrade requirements. |
| /city admin delete | Deletes the city at your location after repeating the command to confirm within 30 seconds. |
| /city admin subzone create <name> | Creates a subzone from your current wand selection with administrator authority. |
| /city admin subzone delete <name> | Deletes a named subzone in the current city. |
| /city admin subzone add <name> <player> | Adds a player to a named subzone and opens individual flags. |
| /city admin subzone remove <name> <player> | Removes a player from a named subzone. |
| /city admin subzone flags <name> | Opens flags for a named subzone. |
| /city admin cleanup <world|all> <owner|everyone> <duration> [confirm] | Previews inactivity cleanup; repeat with confirm within 60 seconds to delete. owner checks only the owner; everyone checks the owner and members. Duration accepts h, d, w, mo, or y, such as 90d. An audit log is written under data/. |
| Permission | Purpose |
|---|---|
| ultracities.command.<path> | Command permissions follow the command path, such as ultracities.command.menu, ultracities.command.subzone.create, and ultracities.command.event.start. Player command nodes default to everyone; give, crystal, event, wand, reload, and admin nodes default to operators. |
| ultracities.admin | Administrative capabilities and child permissions. The /city admin branch additionally checks operator status. |
| ultracities.bypass | Bypasses protected-region restrictions; defaults to operators. |
| ultracities.protections.limit.<amount> | Total owned-protection limit; ultracities.protections.limit.unlimited removes it. |
| ultracities.protections.limit.world.<world>.<amount> | Per-world owned-protection limit; use .unlimited for one world or ultracities.protections.limit.world.unlimited for all worlds. |
With PlaceholderAPI installed, UltraCities registers its own ultracities expansion; no eCloud download is required.
| Placeholder | Result |
|---|---|
| %ultracities_has_city% | true if the player owns or is associated with a city. |
| %ultracities_city_role% | Role in the primary city: owner, member, or none. |
| %ultracities_current_city_role% | Role in the city at the player's location: owner, member, visitor, or none. |
| %ultracities_owned_protections% | Count of protections owned by the player. |
| %ultracities_protection_count% %ultracities_number_of_protections% |
Aliases of owned_protections. |
| %ultracities_member_protections% %ultracities_associated_protections% |
Cities where the player is a non-owner member, and all cities they are associated with, respectively. |
| %ultracities_protection_limit% | Maximum number of owned protections, or unlimited. |
| %ultracities_protections_remaining% | Remaining total allowance, or unlimited. |
| %ultracities_world_protection_count% %ultracities_world_protection_limit% %ultracities_world_protections_remaining% |
Owned count, limit, and remaining allowance in the online player's current world. |
city_ refers to the player's primary city: a city they belong to at their location, otherwise their highest-level owned city, then their highest-level associated city. current_city_ refers to the city at an online player's location, even for visitors. Every city_ suffix below also works with current_city_; for example, %ultracities_current_city_level%.
| Placeholder | Result |
|---|---|
| %ultracities_city_name% %ultracities_city_name_plain% | Formatted city name and plain name. |
| %ultracities_city_tag% | Configured short tag. |
| %ultracities_city_owner% | Owner's current player name. |
| %ultracities_city_level% | Current progression level number. |
| %ultracities_city_radius% | Active protection radius in blocks. |
| %ultracities_city_members_count% %ultracities_city_max_members% | Current member count and maximum member capacity. |
| %ultracities_city_shield_active% | true if protected by an active shield. |
| %ultracities_city_shield_remaining% | Formatted remaining shield duration (e.g. 2h 15m). |
| %ultracities_city_subzones_count% | Number of 3D subzones created in this city. |