Reference

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#

SettingDefaultWhat it does
updates.enabledtrueTurn the BuiltByBit update check on or off.
updates.check-on-startuptrueCheck shortly after the server starts.
updates.check-interval-hours24Hours between checks, from 1 to 168.
updates.auto-downloadfalseDownload new versions by themselves. They install on the next restart.
updates.notifytrueTell the console and admins about updates.
updates.shared-token / resource-id"" / 0Leave blank to use the built-in values.
gui.live-update-seconds1How often open menus redraw their timers.
storage.typeSQLITESQLITE or MYSQL. See the mysql block for host, port, database, username, password, use-ssl and table-prefix.
storage.auto-save-minutes5Minutes between automatic saves.
currency.providerSHARDSSHARDS, VAULT or PLAYERPOINTS.
currency.singular / pluralShard / ShardsCurrency names.
currency.display-format&d%amount% %currency%How amounts look everywhere. Placeholders: %amount% %currency%.
currency.starting-balance100What new players start with (built-in currency).
currency.max-balance-1Highest balance. -1 for no maximum.
currency.pay.enabled / min-amount / tax-percenttrue / 1 / 0Player payments, the smallest payment, and the percent taken from each payment.
currency.vouchers.enabled / min-amounttrue / 10Allow /shards withdraw and set the smallest voucher.
rotation.enabledtrueWhen false, the shop only changes with /shardshop admin rotate.
rotation.modeintervalinterval, daily or weekly.
rotation.every7dInterval mode length, for example 12h, 3d, 1d12h.
rotation.time / day"18:00" / FRIDAYTime (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-repeats1Rotations an item stays out of the shop, when there are enough other items.
rotation.announcetrueChat message, title and sound when the shop changes.
rotation.warnings[24h, 1h, 10m, 1m]Warnings before a rotation.
deals.enabled / per-rotationtrue / 1Random discounts, and how many items get one each rotation.
deals.min-percent / max-percent10 / 30Range of the random discount.
rarities.<id>4 defaultsname, color, weight, guaranteed, glow, particle, base and announce for each rarity.
purchase.require-confirmationtrueShow the quantity and price screen before buying.
purchase.max-quantity64The most a player can buy in one go.
purchase.cooldown-seconds2Seconds between purchases. 0 for none.
purchase.full-inventoryclaimclaim, drop or block.
purchase.announce-rare / announce-sold-outtrue / trueTell the server about announce rarities being bought and about sold-out items.
messages.enable-titles / enable-actionbar / enable-sounds / join-noticetrueTurn feedback types on or off.
sounds.<key>see fileSound keys for menu-open, click, purchase, fail, rotation, warning, reveal, wishlist and earn. Blank for silence.
stands.*see fileitem-height, text-height, item-scale, text-width, text-range, base, spin, spin-degrees-per-second, bob, glow, particles, reveal.
board.scale / width / background-alpha1.5 / 300 / 96Info board size and background.
shop-warp.*emptyWarp location. Set it with /shardshop admin setwarp.