> For the complete documentation index, see [llms.txt](https://esmp-fun.gitbook.io/plugins/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://esmp-fun.gitbook.io/plugins/better-storage/reference/settings.md). # Settings Every setting is in `plugins/BetterStorage/config.yml`, with an explanation above each one in the file itself. After changing something, run `/bs reload`. The few that need a restart say so. The defaults suit almost every server. This page is for when you want something to work differently. ## database Where Better Storage keeps its records: chest jobs, filters and upgrades. | Setting | Default | What it means | | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | `sqlite` | `sqlite` is a file in the plugin folder, nothing to set up. `mysql` uses your own MySQL or MariaDB server, with the details under `mysql:`. Restart needed. | ## browser The storage screen. | Setting | Default | What it means | | ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `include-shulkers` | `false` | Also show what is inside shulker boxes **placed** in the chunk. Shulker boxes sitting in a chest are never opened up. | | `locate-seconds` | `10` | How long chests glow after a player asks where an item is (F over an item). 1 to 60. | | `auto-unpack` | `false` | When a player takes more than there is loose, break open stored blocks to make up the difference, like iron blocks into ingots. Each player can switch it for themselves with `/bs unpack`; this is what they start with. | ## interactions | Setting | Default | What it means | | -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | `sneak-open` | `true` | Sneak and right-click a chest with an empty hand to open the storage screen (or an upgraded chest's settings). | | `hopper-custom-view` | `true` | `true`: right-clicking a hopper opens its filter screen. `false`: hoppers open normally, and sneaking with an empty hand opens the filter. | | `wrench-item` | `BRUSH` | What players hold to take an upgrade off a chest. Any item name, like `STICK`. | ## collection Vacuum hoppers: hoppers with **Vacuum** switched on in their filter. | Setting | Default | What it means | | ---------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `enabled` | `true` | `false` switches vacuum hoppers off for everyone. | | `sweep-interval-ticks` | `40` | How often they pick up items already on the ground. 20 ticks is 1 second, so 40 is every 2 seconds. Fresh drops are caught straight away either way. | | `mode` | `chunk` | `chunk`: anywhere in the hopper's chunk. `radius`: up to `radius` blocks away, even into the next chunk. | | `radius` | `24` | How far, in blocks, when `mode` is `radius`. 1 to 64. | ## processing [Chests that work](/plugins/better-storage/using-it/upgrades.md). | Setting | Default | What it means | | ------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `source` | `self` | `self`: an upgraded chest only uses what is inside it. `chunk`: it also takes materials from **Feeder** chests and puts what it makes into **Collector** chests in the same chunk and claim. Those two jobs only appear when this is `chunk`. | | `labels` | `true` | Show a floating name over upgraded chests, like "Smelter". | | `interval-ticks` | `20` | How often upgraded chests do their work. 20 ticks is 1 second. Smelting and brewing still take as long as with the real block. | | `max-operations-per-pass` | `40` | The most upgraded chests handled each time. With more than this, they take turns. Raise it if machines feel slow, lower it if they cost too much performance. | ## routing Where Quick Dump, items put back through the storage screen, what machines make and items from hoppers feeding a chest end up. The order it picks chests in is on [Chest jobs](/plugins/better-storage/using-it/chest-jobs.md#prio). | Setting | Default | What it means | | ---------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `strategy` | `nearest` | When several chests are equally good: `nearest` uses the closest one, `round_robin` takes turns to spread items evenly. | | `hoppers` | `true` | A hopper feeding a chest in a chunk where chests have a job, a filter or a fill order puts each item in the chest that asks for it. `false`: hoppers only fill the chest they point into, like in vanilla. | ## protection Claim plugins Better Storage checks. Players only see and use chests they could open by hand, and every take and put is checked again. | Setting | Default | | ----------------- | ------- | | `griefprevention` | `true` | | `lands` | `true` | | `residence` | `true` | | `worldguard` | `true` | Set one to `false` to stop checking that plugin. Restart needed. {% hint style="info" %} If one of these plugins is installed but Better Storage can't talk to it, for example after a big update of that plugin, its claims are **blocked** rather than left open, and the console says so. Players with `betterstorage.admin.bypass-claims` (operators) are never blocked. {% endhint %} ## upgrades What [upgrading a chest](/plugins/better-storage/using-it/upgrades.md) costs, on top of the block itself, which is always used up. ```yaml upgrades: costs: crafter: { money: 5000, levels: 5, items: ["DIAMOND:5"] } blast_furnace: { money: 2500 } cost-multiplier: 1.0 refund-policy: block ``` | Setting | Default | What it means | | ----------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `costs` | nothing | Per type: `crafter`, `furnace`, `smoker`, `blast_furnace`, `brewing`, `composter`. Each can ask for `money` (needs Vault and an economy plugin), `points` (needs PlayerPoints), `levels` (XP levels) and `items` (as `"ITEM:amount"`), in any mix. A type left out costs only the block. | | `cost-multiplier` | `1.0` | Multiplies every cost. `2.0` doubles them, `0.5` halves them. | | `refund-policy` | `block` | What taking an upgrade off gives back: `block` the block, `full` the block plus everything paid, `none` nothing. | Give a player `betterstorage.discount.25` and they pay 25% less. With several, the biggest one counts. ## resource-pack | Setting | Default | What it means | | --------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `enabled` | `false` | `true`: players who loaded the server's resource pack get the nicer look. Only switch it on once the pack is in your server's pack. See [The resource pack](/plugins/better-storage/getting-started/resource-pack.md). | ## metrics | Setting | Default | What it means | | --------- | ------- | ------------------------------------------------------------------------------------------------------- | | `enabled` | `true` | Sends anonymous usage numbers (bStats), which help decide what to improve next. No player data is sent. | ## Texts Every text players see is in `plugins/BetterStorage/messages.yml`, so you can reword or translate anything. Colours use MiniMessage, like `` and ``. Run `/bs reload` after a change. A line you delete from `messages.yml` falls back to the built-in text, so after an update new texts show up by themselves.