ShadowSpawners

The default language of the server. The plugin ships en_US and it_IT in lang/, and you can add more: a lang/fr_FR.yml file is picked up on its own.

Every player reads the messages in the language of their own client, when that language exists. On by default because it costs nothing and because a server with players from two countries almost always wants it; turn it off if you would rather everyone read the same thing, for instance to keep the chat uniform.

Also accept the section symbol in texts, on top of the ampersand. Only useful to those pasting texts from old configurations of other plugins.

On update, moves this file, spawners.yml, lang/ and menus/ to the new version: what you changed is carried over, what you never touched takes the new default, the previous files go to backup/<date>/ and anything that could not be carried is listed in PORTING-<version>.txt. Turn it off only if you manage the files with a tool of your own: with it off your files are never rewritten, and a message missing from them is read from the copy inside the jar.

How often to write what changed to the database. Changes are never lost either way: on shutdown there is a blocking write that drains the queue. Raising it reduces writes on a server with a lot of spawner movement, lowering it reduces how much is lost in a crash.

How long a confirmation request lives before it expires. Under ten seconds it becomes a race; over a minute, a player clicks CONFIRM on a question they no longer remember asking.

The menu of a spawner opens even with something in hand.

- with a SPAWNER in hand the menu never opens, because that gesture is
  the merging of two spawners into a stack;
- with SHIFT held the menu does not open and the block in your hand is
  placed: it is the same way out the game gives you on chests. Careful
  though - if shift-places-whole-stack is on, a SHIFT with spawners in
  hand places the entire pile.

Teleporting from the list only works on your own spawners. Anyone with shadowspawners.admin can also go to other people's, because that is half the job of whoever answers "someone stole my spawner".

The id of this plugin on bstats.org. It only tells how many servers use it and which version they are on; it sends no names, no addresses and no coordinates.

Turn it off if harvesting is handled by another plugin on this server. With it off the break event is not even listened to: the cost is zero, not "almost zero".

Silk touch is required to harvest.

Keeping it on is almost always right: without it a spawner is harvested bare-handed, and from that moment the dungeons of the world become a free shop. Turn it off only if you have a precise idea of your economy.

The minimum silk touch level. A plain one is enough; raise it only if you have custom enchantments and want the good one to be required.

The chance for mobs that have no row of their own in spawners.yml, from 0 to 1. One means always.

The default is 1 on purpose. A low "out of the box" chance is the quickest way to make somebody angry: a player who breaks their first spawner and gets nothing thinks the plugin is broken, not that they were unlucky. If you want certain mobs to be rare, use that type's row in spawners.yml: there it reads as a choice.

How much every silk touch level above the minimum adds. With 0.1, a silk touch III on a 50% chance brings it to 70%. It is for those who sell upgraded enchantments and want them to be felt.

In creative the harvest always succeeds, silk touch or not. It is what someone fixing up a map expects, and in creative the chance protects nothing from nobody.

A broken spawner also drops the experience, as it would in vanilla. Off by default: whoever harvests the spawner takes away the real value, and the extra experience is a gift nobody asked for.

Say it in chat when the chance does not come through.

On by default, and it is worth explaining why: without a message, a player who breaks a spawner at 30% and gets nothing cannot tell whether they were unlucky or the plugin is not working. Silence, here, produces support tickets.

Placing a spawner AGAINST another of the same type merges the two, and the block keeps a counter.

How many can be stacked.

Thirty-two is a considered number: it is enough for a farm to make sense, and little enough that a player cannot fit the whole server inside one block. Raising it a lot moves the problem onto load, which is the reason extra-cycles-per-tick below exists.

On the free version this value does not count: without a licence the stack is always 1. What you had stacked before stays stacked and keeps producing, you simply cannot add to it.

Breaking with SHIFT takes the whole stack away in one go, instead of one spawner. With it off one spawner is always removed per break, which is safer and much slower.

Placing with SHIFT puts in the whole pile you have in hand, instead of one.

A stack spawns more mobs than a single spawner.

With it off a stack is just tidy storage: it takes one block instead of thirty-two and does not produce more. Some people want it that way, to keep the load flat without giving up the tidiness.

How many extra cycles to grant in total, per tick, across the whole server.

In plain Minecraft an egg on a spawner changes its type, for free. From here on that change goes through us: it can be charged for, it can require a permission, and it can ask for confirmation.

Turning it off keeps the vanilla behaviour blocked anyway: that is the right call, because a plugin that sells blaze spawners and lets you turn a pig into a blaze for free has sold nothing.

What a change costs, in the currency below. Zero means free. It is per spawner: a stack of 32 changes all 32 at once, and pays 32 times (the item cost below too).

The right value is "less than buying the spawner new, but not much less": if it is cheap the shop stops meaning anything, because people buy the cheapest mob and transform it.

What it is paid in: 'money' is the default currency of ShadowEconomy. You can put the id of another currency or of a token: to ShadowEconomy tokens are currencies, so they work here with nothing special.

The egg is consumed. In creative it never is, whatever this says.

Ask for confirmation with the two chat buttons before changing.

On by default: it is an operation that costs money and that cannot be undone, and it is extremely easy to do by accident while holding an egg and clicking around. When the change is free confirmation is not asked anyway, because there would be nothing to confirm.

The currency used by price rows that do not declare one of their own.

How many spawners at most in a single purchase. It stops a shift-click gone wrong from emptying an account.

How much every spawner already in circulation adds. 0.01 means 1% each: with fifty blazes around, the fifty-first costs 50% more. It is linear and not exponential on purpose - an exponential curve on a successful server produces numbers that do not fit in a lore line.

The floor and the ceiling of the multiplier. The floor is there so a price never reaches zero; the ceiling so it never becomes unreadable.

How many spawners do not count. The first ones are the ones that get the game going, and charging more for them is the way to not get it going at all.

Only whoever placed a spawner may break or modify it.

Whoever is in creative bypasses the owner check and the region check. It is what someone fixing up a map expects.

Registered spawners resist explosions.

On by default because a spawner bought for a hundred thousand coins that disappears to a creeper is a refund request, and on a server with a spawner shop it is THE refund request. With it off the vanilla behaviour applies: the spawner blows up and its row is removed from the database, leaving no ghosts behind.

Pistons cannot move a spawner.

In plain Minecraft they already cannot, because it is a block with an entity inside. The check is here anyway because that rule has changed at least once in the history of the game and datapacks exist that remove it: a spawner moved without us knowing would become a ghost row in the database. Turn it off only if you have a redstone machine that needs it.

Money. ShadowEconomy if it is there - several currencies, its tokens and prices that follow the market. Otherwise any economy plugin that registers with Vault (EssentialsX, CMI, ...), with the one currency of the server. With neither, the shop does not open and paid upgrades cannot be bought; everything else in the plugin works exactly as before.

Permission to break follows the rules of the region. If ShadowRegions is not there WorldGuard is tried, and if that is not there either the other protection plugins installed decide - they see the event before we do.

A spawner can spawn a custom mob, by writing the type as custom:<id>. ShadowCustomizer does not exist yet: when it arrives it will hook itself up at the first start, without touching anything here.

How many extra cycles to grant stacks is decided by it, based on the real load of the server, instead of the fixed ceiling above. Here is the policy, there is the throughput.

The table prefix. Change it only if you share a database with something else. Only letters, digits and underscores are kept: a table name cannot be bound as a parameter, so it ends up concatenated into the SQL, and "an administrator writes it" is not a reason to leave a concatenation open.

Writes every query to the console. Only to understand a problem: on a live server it fills the log in minutes.

If MySQL does not answer at startup, start on the local file instead of not starting. On by default: a server that will not come up because of an unreachable database is a much bigger problem than one that comes up with old data. Set it to false only if you would rather find out immediately.

Lets another process open the same H2 file while the server runs. Only needed if you want to look inside it with an external tool.

How many days of grace before falling back to the free version when something does not add up: a subscription that just expired (the renewal is almost always already on its way) or an address that does not match (far more often a NAT or a proxy than a thief).

The address your players know the server by. Only needed behind a proxy, where the machine never sees its own public address.

The base address of the activation service. The plugin appends /claim and /check by itself. Empty means automatic activation is off and the key must be pasted by hand.

Asks the activation service above (activation-url + /ip) how this server looks from the outside: it answers with the address it sees, and nothing about the server is sent. It is the only reliable way of knowing your own public address from behind a NAT, and it is the reason a licence sold on a domain works on a machine whose local addresses are all 10.x. A failure is silent: the grace period exists exactly so that a server with no outbound internet keeps running. Only when a licence is installed: a server without a key asks nobody. false = never ask.

How many are bought with a shift-click. On a server where a spawner costs a thousand coins sixteen is reasonable; on one where it costs a million it is an accident, and it should be lowered.

The four middle rows, border excluded: twenty-eight entries per page.