DUXPLIMA Documentation

Upgrading to 5.0.0

Moving a 4.2.0 server to uxmSpawners 5.0.0, what the update does on its own, where every file went, and what behaves differently afterwards.

5.0.0 is a rewrite. Your spawners, their levels, storage, friends and boosts carry over, and so do your settings, but most files have new names and places, and several things behave differently. The update moves everything on the first start; this page says what it does and what is left to you.

Before you start

CheckWhy
The server runs uxmSpawners 4.2.0The update reads 4.2.0 files. Update an older 4.x to 4.2.0 first. A 3.x ancSpawners folder is not read at all
Paper 1.21.11 or newer, Java 215.0.0 does not start on anything older
Vault and an economy pluginStill required
LuckPerms installedRequired now: without it the server does not load uxmSpawners. NBTAPI and a hologram plugin are no longer needed
PacketEvents installedHolograms need it now. See Holograms
The server can reach the internet on its first startThe plugin downloads its libraries and checks its license
A copy of plugins/uxmSpawners/ and the worldsThe plugin backs itself up too, but a copy of your own costs nothing
Customised texts of the shipped languages are not carried over

For English, Turkish, German, French and Polish, 5.0.0 starts from its own new messages and menus. Your 4.2.0 lang_<code>.yml is kept in backups/v5-<date>/configs/lang/. Note what you changed before updating, and put it into the new files afterwards. The mob names you added or changed in translates, and hologram lines you changed, are carried over. A language you added yourself, such as lang_es.yml, is carried over with its texts.

The update

  1. Stop the server, replace the jar and start it.
  2. The plugin copies your files and database.db to backups/v5-<date>/, then moves every setting to its new place. The console names each step.
  3. It starts on the new files and the database is brought to the new tables. The 4.2.0 tables are copied, not changed.
  4. The console says The update to 5.0.0 is done.

If a step fails, or the plugin cannot start on the new files, everything is put back as it was from the backup, and the console says why. With stop-server-on-failure on, the default, the server then stops. It can go on with the 4.2.0 jar, or start 5.0.0 again once the problem is fixed. A crash in the middle is handled the same way on the next start. Two spawner names that differ only in case, a 4.x file that is no valid YAML, or a lang/ or modules/ folder that is a link stop the update before anything is changed.

The moved files get the 5.0.0 comments above every key, and your 4.x comments on prices and permissions stay. 4.x files in another encoding than UTF-8, such as a loot table saved in ANSI, are written as UTF-8.

Where everything went

4.2.05.0.0
config.yml: spawnersOne file per type in spawners/, such as spawners/diamond.yml, in the new four-part layout below. See Spawner Types
config.yml: itemPricesprices.yml, under default-prices and price-provider, with price-items-by: MATERIAL to price as 4.2.0 did. With a shop plugin as the provider, the 4.x prices are written as comments, since 4.2.0 did not use them then
config.yml: disabled-worldsworld-management in config.yml, as a BLACKLIST
config.yml: auto-saveGone. Production is written every database.flush-interval-seconds, 5
config.yml: use-modern-autokilluse-modern-auto-kill
config.yml: nerf-spawner-mobs, no-equipment, open-gui-on-click, disable-xp-drops, protect-spawners-from-explosionsgeneral-settings.yml
config.yml: disable-vanilla-spawners-spawningvanilla-spawner-support.disable-vanilla-spawning in general-settings.yml
modules/settings.yml, other.yml, storage_limits.yml, friends.yml, autokill.yml, multipliers.ymlgeneral-settings.yml, as one file
modules/boosts.ymlboosts.yml
modules/hologram.ymlhologram.yml, with the FancyHolograms look carried over where it fits
The hologram lines in the language filecontent in hologram.yml, from the language in use
lang/lang_<code>.ymllanguages/<code>/messages.yml and five files in languages/<code>/menus/
logs/errors.txtA file a day in logs/. The old file is left where it is

Renamed keys, all carried with their values:

4.2.05.0.0
Spawner files: name, lore, disable-item-flagsitem-settings.name, lore, hide-flags
Spawner files: spawnerInfo.mode, delay, sell_buttonspawner.mode, delay, sell-button
Spawner files: spawnerInfo.material, details, model-dataspawner.produces.spawns, name and lore, model
Spawner files: spawnerInfo.rangespawner.spawn-conditions.players.range
{entity_name}, {entity_name_lang} in names, lore and material<entity_name>, <entity_name_lang>
[toggle_autokill] and the other toggle actions in menus[toggle_setting] auto-kill and so on
{uses} in the pickaxe name<uses>
storage-limit.xpLimit, xpPermissionsxp-limit, xp-permissions
auto-kill.loottable-only-autokillloot-table-only-auto-kill
vanilla-spawner-support.support-on-break, drop-vanilla-on-breakon-break: UXMSPAWNERS, VANILLA or NONE, set to what your server did
spawner-drop-chance.defaultAlso copied to the new vanilla-default, since 4.2.0 used it for natural spawners too
Loot tables: itemDrops, xpDrops, xpDropChanceitem-drops, xp-drops, xp-drop-chance. The old names are still read

Every new setting is added with its default; each spawner file gets enabled: true, block-settings, the other spawn conditions turned off, and hologram: {}. The shipped default and diamond spawners get the 5.0.0 name and lore where yours were still 4.2.0's. database.type is set to SQLITE, since 4.2.0 only ever used database.db, whatever the file said.

The items players carry

Spawner items, boost items and spawner pickaxes from 4.2.0 keep working while item-signing.accept-old-items is on, which is the default. The ones in a player's inventory and ender chest are converted to the 5.0.0 format when they join, so they stack with new ones. A boost item does what its entry in boosts.yml says now. Once the old items have gone around, turn accept-old-items off: anyone in creative mode can make an item in the old format. See Item Signing.

What behaves differently

Area4.2.05.0.0
Selling, items without a priceSold for nothing and goneStay in the storage
Selling, renamed itemsSold at their material's priceThe same: the update writes price-items-by: MATERIAL. New servers price the item itself, ITEM
Breaking the last level with items storedThe storage was deletedRefused until it is empty. break-with-storage changes it
A spawner blown up, or its block removedThe storage was lostSold for the owner. lost-spawner-storage changes it
break-management.modeThe names did not match what they didEach mode does what its name says. Check yours against Breaking Rules
block: false without the right toolThe whole spawner was lostOne level is lost. lost-levels: ALL for the 4.2.0 way
The spawner pickaxeLost a use on every breakOnly when the mode asked for it. pickaxe-uses: ALWAYS for the 4.2.0 way
Natural spawners with on-break: VANILLAAlways droppedRolled against vanilla-default, which the update sets to 100
Loot tablesApplied to every spawner mobWith loot-table-only-auto-kill: true, the 4.2.0 default, only to mobs Auto Kill kills
Auto Kill enabled and forceenabled: false changed little, force only new spawnersenabled: false turns it off everywhere, force keeps it on for every spawner
Auto Kill lootRolled with a random online player as the killer; legacy credited that player with the killThe game's loot table without a killer, the same for modern and legacy. No player is credited, and Looting never counts
When spawners runA player within rangeSpawn conditions, players.range among them. Not in Peaceful worlds unless work-in-peaceful is on
Level UpMatched items by their name and loreMatches by spawner file, mob and mode, so items handed out before a rename still count
FriendsEvery owner could add them, without limitOwners need uxmspawners.friends, op only until you grant it, and add up to max-friends, 10
Friends and the hologramFriends could toggle itOwner only
BoostsAnyone could apply one to any spawnerOwner and friends only. SELL_MULTIPLIER and enabled: false now work
Spawn eggs on natural spawnersAnyonePlayers with uxmspawners.spawnegg
Mobs from spawnersNo capAt most max-living-mobs, 32, alive per spawner. Players cannot ride, tame or equip them
Storage limitsUpdated when the owner opened the menuAlso on join, reload and LuckPerms changes. New spawners store XP at once
Taking itemsLeft-click 64, right-click as many as fitA click opens a menu to choose how many; shift-click takes as many as fit
Natural spawners with disable-vanilla-breakinguxmspawners.admin could break themuxmspawners.breakvanillaspawners, part of uxmspawners.admin
A type without rangeRange 0, never ranRange 16
HologramsDrawn by FancyHolograms, DecentHolograms or CMIDrawn by uxmSpawners, with PacketEvents. No storage bar line: the update leaves a {storage_bar} line out
A failed startThe plugin stayed offThe server stops, unless stop-server-on-failure: false
SavingEvery auto-save.interval, 300 secondsPlayer actions at once, production every 5 seconds
MenusThe 4.2.0 layoutA new layout, with a spawn conditions clock, a stop button, a Settings menu, a withdraw menu and pages of friends

protect-spawners-from-explosions keeps the value your 4.2.0 config.yml had, false unless you changed it. New servers start with true; consider turning it on.

After the update

  1. Read the console from the first start for warnings.
  2. Put your text changes back into languages/<code>/, from the copy in backups/v5-<date>/configs/lang/.
  3. Decide on price-items-by in prices.yml; MATERIAL keeps the 4.2.0 way.
  4. Grant uxmspawners.friends, and uxmspawners.spawnegg if players used eggs. See Permissions.
  5. Check break-management, break-with-storage, lost-spawner-storage and dropped-storage in general-settings.yml, and max-friends if owners had many friends.
  6. Open a few spawners and check their level, storage and friends.

To move to MySQL, set it up after the update has finished. The plugin does not copy spawners from SQLite to MySQL: a server switched over starts with none. The items already handed out keep working, through item-signing-key.txt.

Going back

Once 5.0.0 has started, going back to 4.2.0 means stopping the server and copying the files and database.db from backups/v5-<date>/ back into the plugin folder. Everything that happened since is lost, and items made or converted by 5.0.0 do not work in 4.2.0.

Related: Installation, Configuration, Troubleshooting