Traveler's Chest

Traveler's Chest

Part of the Traveler's Series. Traveler's Chest makes a chest that refills itself after players take from it. Stock loot spots and adventure points for everyone: players take what they need, and one cooldown after the first take the chest refills with the same items in the same slots.

Features

• The chest refills one cooldown after a player first takes from it, with each saved stack back in its slot
• Everyone takes from the same chest, as from any chest
• Only players take items: hoppers, hopper minecarts, droppers and copper golems cannot pull from or push into a Traveler's Chest
• Only operators can break a Traveler's Chest: single, trapped, copper, or either half of a double chest
• Explosions, withers and the ender dragon leave a Traveler's Chest standing
• Chest menus for operators on every supported version: /chests
• Server-side only: players need no client mod

One jar runs on Minecraft 1.20 to 1.20.4, 1.21 to 1.21.11 and 26.1 to 26.3. Fabric loads the build that matches your server, so a server that moves to another supported version keeps the same jar. It needs Fabric Loader 0.16.10 or newer and Fabric API. Minecraft 1.20.5 and 1.20.6 are not supported.

Upgrading from 1.2.x keeps every Traveler's Chest and its items.

Installation

1. Install Fabric Loader and Fabric API on a server running a supported Minecraft version.
2. Download the latest version of Traveler's Chest from the Files tab. One jar covers every supported Minecraft version.
3. Place the .jar file in your server's mods folder.
4. Start your server to generate configuration files.

Configuration

Config Files

• config/travelers-chest/travelers_chest_config.txt

  • Example Contents:

  debug_logging=false
  

  • Enables or disables debug logging for detailed troubleshooting.

• config/travelers-chest/chests.json

  • Stores every Traveler's Chest by dimension and position, with its items, its cooldown and its name. The mod manages this file, so don't edit it by hand.
  • If it cannot be read, the mod saves nothing until it can, and says so, rather than writing over it. Its previous version is kept beside it as chests.json.bak.

• config/travelers-chest/travelers_chests.json

  • Where releases before 2.0.0 saved their chests. 2.0.0 imports it once and leaves it as it was, so going back to an older release still finds your chests. An imported chest starts its cooldown the first time it is loaded and found not full.

Usage

1. Place a chest, single or double, and put the items in it.
2. Face it and run /travelers_chest create, or run /chests and click Add the chest I'm facing.
3. Players open it and take what they need, as from any chest.
4. One cooldown after the first take, the chest refills: each saved stack goes back into its slot, and other slots are left alone. Until someone takes from it, no cooldown runs.
5. The refill happens when someone next opens either half of the chest, or when its area loads, so no area is loaded just to check a chest.

Commands

Operators (permission level 4) use these while looking at a chest, up to 20 blocks away:

• /chests: opens the chest menus. Facing a Traveler's Chest, it opens that chest's menu; anywhere else, the list of every Traveler's Chest.
• /travelers_chest create [time]: makes it a Traveler's Chest that refills with the items in it now, with a cooldown in seconds (default: 1800, half an hour).
• /travelers_chest edit <time>: changes its cooldown. If the chest holds anything, what is in it now becomes what it refills with.
• /travelers_chest destroy: turns it back into a plain chest. Its items stay in it.

Chest Functionality

• Refill Mechanism: A chest refills one cooldown after a player first takes from it, not on a fixed cycle. A slot is refilled when it holds anything other than its saved stack, enchantments and damage included.
• Shared Contents: Everyone takes from the same chest, as from any chest.
• Players Only: Hoppers, hopper minecarts, droppers and copper golems cannot pull from or push into a Traveler's Chest, so a comparator beside one reads 0.
• Double Chest Support: Opening either half of a double chest refills it.
• Protected Chests: Only operators can break a Traveler's Chest, either half of a double chest included. Explosions leave a Traveler's Chest and its items standing, while the blocks around it break as usual: TNT, creepers, end crystals, beds, respawn anchors, fireballs and wither skulls. A wither and the ender dragon pass it without breaking it, and a chest placed against a single one stays single, so the Traveler's Chest keeps its own slots. A trapped chest can be a Traveler's Chest too, and is protected the same way. A copper chest, from Minecraft 1.21.9, can be one too: it keeps its items, its name and its refills as it oxidizes, and copper golems take nothing from it.

/chests opens menus built from the game's own chest screens, so they work on every supported version:

• Facing a Traveler's Chest, it opens that chest's menu: a clock for the cooldown (left-click 10 minutes longer, right-click 10 minutes shorter, a minute at a time at 10 minutes and under, down to 1 minute; shift-click an hour), Open the chest, Refill now, Teleport there, Rename, and Turn into a plain chest.
• Anywhere else, it lists every Traveler's Chest on the server. Hover one to see its first items, where it is, its cooldown, and whether it is full or when it refills; click it to open its menu. The lime dye, Add the chest I'm facing, opens an anvil to name the chest you face, and the new Traveler's Chest starts with a 30-minute cooldown.
• Open the chest opens the chest itself from anywhere, refilled first. Move items in and out as at the chest. Back, in the row under a single chest, or Esc returns to the chest's menu; a double chest fills the screen, so its title says Esc to go back. Going back after a change asks whether to save the items: Save the items makes the chest refill with them from now on, and closing the question keeps the old items.
• Rename opens an anvil holding the current name. The name is written onto the chest, both halves of a double chest, so players see it as the chest's title. An emptied box keeps the current name.
• A chest whose block is gone shows as gone in the list, with Remove from the list.

Each button checks the operator level again before it acts, so only operators can change anything.

Debug Logging

Enable debug logging in config/travelers-chest/travelers_chest_config.txt for detailed logs of mod operations, such as chest refills and new Traveler's Chests:

debug_logging=true

Logs are output to the server console. Releases before 2.0.0 looked for this file in a folder that never exists, so they could not turn debug logging on.

JSON Structure

Chests are stored in chests.json (format 2) with the following schema, one entry per chest:

• dimension: The dimension the chest is in
• pos: Its position, as x, y and z
• double: Whether it is a double chest
• name: The name given in the menus, when it has one
• wait: The cooldown in seconds
• takenAt: The world time, in ticks, of the first take; present only while its cooldown runs
• items: The saved stacks, each with its slot, its dataVersion (the Minecraft data version it was saved at) and its item as SNBT text

Each stack is brought up to date by Minecraft's own item upgrades when it is read, so a world that moves to a newer Minecraft keeps its chests. Two flags can appear on a chest: unchecked, on an imported chest not yet loaded, and gone, when its block is missing.

Example:

{
  "format": 2,
  "chests": [
    {
      "dimension": "minecraft:overworld",
      "pos": [-4, -60, -12],
      "double": true,
      "name": "Supply Cache",
      "wait": 1800,
      "takenAt": 291,
      "items": [
        {"slot": 0, "dataVersion": 3955, "item": "{id:\"minecraft:torch\",count:8}"},
        {"slot": 30, "dataVersion": 3955, "item": "{id:\"minecraft:bread\",count:16}"}
      ]
    }
  ]
}

travelers_chests.json, the 1.2.x file, is imported once and left as it was. If an older release runs in between and changes it, 2.0.0 imports it again.

Support

To support the development of Traveler's Chest, please join the GBTI Network for access to:

• Exclusive tools and resources
• Development support

Other Ways to Contribute

• Star the project on GitHub
• Report issues via the Issue Tracker
• Submit improvements via Pull Requests

Links

• Project page on gbti.network
• Source code on GitHub

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.