Configuration
Every option in config.yml works as described. Most of them can also be changed in game from /shardshop admin. Run /shardshop admin reload after editing a file.
Other files#
items.yml: the catalog.earning.yml: playtime, mobs, mining, daily reward and multipliers.messages.yml,menus.yml,holograms.yml: all text and player menus.webhooks.yml: alerts for rotations, purchases and sold-out items.
config.yml options#
| Setting | Default | What it does |
|---|---|---|
updates.enabled | true | Turn the BuiltByBit update check on or off. |
updates.check-on-startup | true | Check shortly after the server starts. |
updates.check-interval-hours | 24 | Hours between checks, from 1 to 168. |
updates.auto-download | false | Download new versions by themselves. They install on the next restart. |
updates.notify | true | Tell the console and admins about updates. |
| updates.shared-token / resource-id | "" / 0 | Leave blank to use the built-in values. |
gui.live-update-seconds | 1 | How often open menus redraw their timers. |
storage.type | SQLITE | SQLITE or MYSQL. See the mysql block for host, port, database, username, password, use-ssl and table-prefix. |
storage.auto-save-minutes | 5 | Minutes between automatic saves. |
currency.provider | SHARDS | SHARDS, VAULT or PLAYERPOINTS. |
| currency.singular / plural | Shard / Shards | Currency names. |
currency.display-format | &d%amount% %currency% | How amounts look everywhere. Placeholders: %amount% %currency%. |
currency.starting-balance | 100 | What new players start with (built-in currency). |
currency.max-balance | -1 | Highest balance. -1 for no maximum. |
| currency.pay.enabled / min-amount / tax-percent | true / 1 / 0 | Player payments, the smallest payment, and the percent taken from each payment. |
| currency.vouchers.enabled / min-amount | true / 10 | Allow /shards withdraw and set the smallest voucher. |
rotation.enabled | true | When false, the shop only changes with /shardshop admin rotate. |
rotation.mode | interval | interval, daily or weekly. |
rotation.every | 7d | Interval mode length, for example 12h, 3d, 1d12h. |
| rotation.time / day | "18:00" / FRIDAY | Time (24-hour) for daily and weekly modes, and the day for weekly mode. |
rotation.timezone | "" | Time zone name such as America/New_York. Blank uses the server clock. |
rotation.avoid-repeats | 1 | Rotations an item stays out of the shop, when there are enough other items. |
rotation.announce | true | Chat message, title and sound when the shop changes. |
rotation.warnings | [24h, 1h, 10m, 1m] | Warnings before a rotation. |
| deals.enabled / per-rotation | true / 1 | Random discounts, and how many items get one each rotation. |
| deals.min-percent / max-percent | 10 / 30 | Range of the random discount. |
rarities.<id> | 4 defaults | name, color, weight, guaranteed, glow, particle, base and announce for each rarity. |
purchase.require-confirmation | true | Show the quantity and price screen before buying. |
purchase.max-quantity | 64 | The most a player can buy in one go. |
purchase.cooldown-seconds | 2 | Seconds between purchases. 0 for none. |
purchase.full-inventory | claim | claim, drop or block. |
| purchase.announce-rare / announce-sold-out | true / true | Tell the server about announce rarities being bought and about sold-out items. |
| messages.enable-titles / enable-actionbar / enable-sounds / join-notice | true | Turn feedback types on or off. |
sounds.<key> | see file | Sound keys for menu-open, click, purchase, fail, rotation, warning, reveal, wishlist and earn. Blank for silence. |
stands.* | see file | item-height, text-height, item-scale, text-width, text-range, base, spin, spin-degrees-per-second, bob, glow, particles, reveal. |
| board.scale / width / background-alpha | 1.5 / 300 / 96 | Info board size and background. |
shop-warp.* | empty | Warp location. Set it with /shardshop admin setwarp. |