DUXPLIMA Documentation

bank.conf

The island bank: currencies, interest, refunds and upkeep.

The file is plugins/uxmSkyblock/modules/bank.conf. Every default below is the shipped value.

bank

The island bank: money its members share, interest, refunds and the upkeep an island pays.

KeyDefaultWhat it does
operation-retention30dHow long a settled idempotency record is kept. Every deposit, withdrawal, upgrade purchase, shop trade and upkeep charge writes one so a retry of it is answered rather than applied twice, and it has to outlive every retry anything can make. A record that never settled is never swept, whatever this says.

bank.interest

Interest on the money in an island bank, paid into it once each interval to an island one of whose members played lately. It never fills a bank past the limit of its bank limit upgrade.

KeyDefaultWhat it does
enabledfalse
interval24hHow often an island is paid, at most once in each
percent1.0The share of the bank's money paid, in percent
active-within72hHow lately a member must have played for the island to be paid
max-per-payment0The most one payment gives, in money; 0 for no most

bank.delete-refund

When an island is deleted, the share of its bank's money paid back to its owner's own wallet, from 0 for nothing to 1 for all of it.

KeyDefaultWhat it does
share0.0

bank.upkeep

Upkeep fee and bankruptcy escalation system

KeyDefaultWhat it does
enabledfalseWhether recurring upkeep debiting is active
interval24hCycle interval between upkeep runs (e.g. 24h)
base-fee500.00Base flat fee per cycle (currency units, e.g. 500.00 = 50000 minor units)
per-member-fee100.00Additional fee per registered island member (currency units, e.g. 100.00 = 10000 minor units)
grace-duration72hDuration before an island in GRACE escalates to LOCKED lockout
auto-remediate-on-deposittrueAutomatically remediate accumulated debt upon bank deposit if funds suffice

bank.money

The island's own money, as the bank window draws it. It is always kept, so it has no "enabled", and it stands among the currencies below as one of them.

display-name  its name, a key of the language files written with a leading @, or your words
icon          the item its tile wears
order         where it stands among the currencies, the lowest first
quick         the amounts its window moves in one click. The window shows the first two.
format        how an amount of it is written in every line and window. "economy" lets the
              economy plugin write it, with its own sign, as its own commands do. Or write a
              pattern with <amount> where the number goes: "$<amount>", "<amount> coins".
KeyDefaultWhat it does
display-name@bank.currencies.money
iconGOLD_INGOT
order0
quick100, 1000
formateconomy

bank.currencies

The currencies an island bank keeps beside the island's own money.

The island's own money is the server's economy, read through Vault: it is what upgrades, the shop and upkeep spend, and it is always kept. Everything listed here is kept too, so members can put their experience, their points or a stack of diamonds away together and take them out again. Each is kept in whole numbers.

The id of a currency is what the bank keeps it under, and what a player writes after an amount: /is bank deposit 50 experience. It is lower case letters, digits, _ and -, and it may not be primary, crystals, exp or vault, which the bank keeps for itself. Once an island holds some of a currency, keep its id: turn it off with "enabled = false" rather than renaming or deleting it, so what the islands hold still has a name.

Every currency takes:

type          where it lives, one of the nine below
order         where it stands among the others in the bank window, the lowest first
enabled       whether islands can use it now
display-name  its name, a key of the language files written with a leading @, or your
              own words
icon          the item its tile in the bank window wears
quick         the amounts its window moves in one click, [10, 100] when left out. The
              window shows the first two

Nine types:

vault           the Vault economy, for a second balance on a server that runs two
vaultunlocked   VaultUnlocked, the modern Vault. currency-name picks one of its currencies
playerpoints    PlayerPoints
ecobits         EcoBits. currency-name is the id you gave the currency in EcoBits
treasury        Treasury. currency-name picks one of its currencies, wait-for how long a
                call may take before the bank gives up on it, "10s" when left out
item            an item in the inventory, as material = "minecraft:diamond". Only the
                plain item counts, never a renamed or enchanted one
experience      the player's experience, unit = "points" or "levels". Points are the fair
                count: a level is worth more the higher it is
bridge          any other economy plugin, described by hand. See the example at the end
placeholder     a balance read through a placeholder and moved by two console lines

A currency whose plugin is not installed, or which is described wrongly, stays out of the bank and the console says why. The rest of the bank is not touched. So every currency below ships turned on: points shows only on a server that runs PlayerPoints.

Experience and items live in the player, so they move only while the player is online, which is always the case for the player putting them in or taking them out.

bank.currencies.experience

KeyDefaultWhat it does
typeexperience
order10
enabledtrue
display-name@bank.currencies.experience
iconEXPERIENCE_BOTTLE
unitpoints
quick10, 100
bank.currencies.points.typeplayerpoints
bank.currencies.points.order20
bank.currencies.points.enabledtrue
bank.currencies.points.display-name@bank.currencies.points
bank.currencies.points.iconAMETHYST_SHARD
bank.currencies.points.quick10, 100
bank.currencies.diamonds.typeitem
bank.currencies.diamonds.order30
bank.currencies.diamonds.enabledtrue
bank.currencies.diamonds.display-name@bank.currencies.diamonds
bank.currencies.diamonds.iconDIAMOND
bank.currencies.diamonds.materialminecraft:diamond
bank.currencies.diamonds.quick1, 16