Server documentation

Restock & Roam

Active

Hytale • Version 1.0.0

Install, kits, chest networks, trip recovery, BetterClaim, commands, config, and permissions.

Server setup for Restock & Roam: data folders, GUI tabs, trip recovery, BetterClaim, commands, and config.json.

Overview

Restock & Roam is a server-side Hytale 0.6.0+ plugin. Players save personal kits, link a chest network, activate a kit for that base, then crouch and open a linked chest to prepare a trip or to store loot and refill on return.

A standing chest open is vanilla. The plugin only transfers items after a crouch interact on a linked chest, with a kit already active for that network. Each player owns at most one base. Guests keep their own kits and trip snapshots on the host’s chests.

Player data lives under mods/durkz_RestockAndRoam/. If mods/durkz_ExpeditionPrep/ already exists, the plugin keeps using that folder so kits and bases are not lost.

Installation

Requires Hytale 0.6.0+
Download RestockAndRoam-1.0.0.jar from the CurseForge Files tab
Place the JAR in mods/ (global UserData/Mods or per-save mods/)
Start the world. Config is created at mods/durkz_RestockAndRoam/config.json
Run /eprep. Boot log: Restock & Roam loaded. Open /eprep to claim an Expedition Ledger.
(Optional) Install BetterClaim if linked chests should also honor claim chest-interact rules

GUI

/eprep and the Expedition Ledger secondary action open the same CustomUI. Tabs:

Tab	Purpose
Overview	Pick a kit and a base you can use, activate the kit, claim the Ledger
Kits	Save, edit, and delete up to 12 kits
Base	Link or unlink chests, invite or remove guests, delete the network
Chest rules	Role, priority, and filters per chest
Trip status	Last turnaround report, pending loot, abandon or admin recovery

Destructive actions (replace kit, delete kit, delete network, abandon trip, admin reset) require a second click. The first click only asks for confirm and does not move items.

The 13-step player loop is on the mod page.

Kits

A kit is a snapshot of hotbar, armor, utility, tools, inventory, and backpack slots, plus optional supplies total entries (not bound to a slot).

Rule	Detail
Name	1-24 characters: letters, numbers, spaces, `-`, `_`
Count	Up to 12 kits per player per world
Save	Save full kit stores the layout. Items stay on the player
Replace	Same name: click twice to confirm
Excluded	Expedition Ledger and `EditorTool_*` items are never stored
Empty	An empty kit cannot be saved

Add held supplies takes the active hotbar stack and stores a quantity target. Restock later pulls that total into inventory or backpack, not into a specific equipment slot.

Base and guests

Rule	Detail
Primary	Link primary, menu closes, open the chest within 30 seconds
Additional	Link additional, same 30-second window, within 16 blocks of the primary (3D: `dx²+dy²+dz² ≤ 256`)
Size	1 primary plus extras, 17 chests max
Ownership	One network per player. A chest cannot belong to two networks
Guests	Name must resolve to a single known player (joined at least once). Max 128 guests
Access	Owner or guest. Guests cannot edit chests, rules, or guest list
Unlink extra	Select a non-primary chest, Unlink selected
Delete	Delete network needs a second click. Removes the whole base

/expedition cancel drops a pending 30-second link.

Chest rules

Field	Detail
`SUPPLY`	Gives items when the kit is refilled
`LOOT`	Receives items gained since departure
`BOTH`	Both. Primary starts as `BOTH` with empty filters (fallback)
Priority	`-1000` to `1000`. Higher first among filtered chests
Filters	OR list: `item:ID`, `category:ID`, `resource:ID`. Empty = fallback

Sort order: filtered chests before fallback, then higher priority, then link order. The primary always stays first in the list. Move earlier / Move later swap extra chests only.

Turnaround

Crouch, then interact so the chest window actually opens. The plugin waits for that window before moving items.

Case	What happens
First crouch (no trip)	Refill kit from `SUPPLY`/`BOTH`, write a departure snapshot
Return to the same base	Deposit quantity gained vs snapshot into `LOOT`/`BOTH`, then refill kit
Standing interact	Vanilla chest. No transfer
Other base or other world	Blocked until you return to the origin or Abandon trip
Kit change mid-trip	Snapshot stays on the kit used at departure
Full loot chest	Leftovers stay on the player and show as pending on Trip status
Interrupt	Trip is marked for recovery. Inspect inventory, then abandon. Recovery never replays transfers

Loot is taken from inventory, backpack, hotbar, utility, tools, then armor, in that order. Only extra counts since departure are treated as loot.

BetterClaim

Optional dependency durkz:BetterClaim. When BetterClaim is present and enabled, each linked chest also needs its chest-interact permission. If BetterClaim is installed but the lookup fails, access is denied. Without BetterClaim, Restock & Roam does not check claims.

Features

Personal kits with slot layout and optional supply totals
Linked chest network, guests, and per-player trips on a shared base
Deposit only items gained since departure; refill from SUPPLY/BOTH
Overflow stays on the player; Trip status lists pending types
Expedition Ledger (spellbook animation) or /eprep
Optional BetterClaim chest-interact check
Update notices for operators or expeditionprep.admin (checkForUpdates)

Commands

Main command: /expedition (aliases: /eprep, /restock, /rr). No permission required for the GUI.

Command	Access	Description
`/eprep`	Everyone	Open Overview
`/expedition bind`	Everyone	Arm a 30-second primary (or additional) chest link
`/expedition save <name>`	Everyone	Save the current equipment as a kit without opening the GUI
`/expedition prepare <name>`	Everyone	Activate a kit and arm a 30-second prepare at the linked chest
`/expedition cancel`	Everyone	Cancel a pending 30-second chest action

/eprep
/expedition bind
/expedition save Ranger
/expedition prepare Ranger
/expedition cancel

The GUI is the normal path. Chat shortcuts do not replace Use this kit plus crouch on a linked chest.

Permissions

Permission	Description
`expeditionprep.admin`	Inspect another player’s trip, reset tracking, receive update notices

Base owners manage chests and guests with no extra node.

Example:

/perm user <player> expeditionprep.admin true

Server operators inherit update notices through the same check used for expeditionprep.admin.

Configuration

File: mods/durkz_RestockAndRoam/config.json (or mods/durkz_ExpeditionPrep/config.json when that folder already exists).

Field	Default	Description
`checkForUpdates`	`true`	On join, operators or `expeditionprep.admin` get a one-time chat notice if the site lists a newer `RestockAndRoam-x.y.z.jar`

{
  "checkForUpdates": true
}

There are no gameplay toggles in config. Kit size, chest count, and filter rules are enforced in the plugin.

Data files

Path	Purpose
`mods/durkz_RestockAndRoam/config.json`	Update-check toggle
`mods/durkz_RestockAndRoam/profiles/<worldUuid>/<playerUuid>.json`	Per-player kits
`mods/durkz_RestockAndRoam/worlds/<worldUuid>.json`	Networks, active kits, trips

Replace the folder name with durkz_ExpeditionPrep when that directory already exists.

Verifying it works

Boot the world. Log contains Restock & Roam loaded. Open /eprep to claim an Expedition Ledger.
/eprep opens Overview. Claim the Ledger. Inventory gets Durkz_Expedition_Ledger if a slot is free.
Save a kit, link a primary chest within 30 seconds, click Use this kit.
Crouch and open that chest. Chat reports kit refill and a trip starts.
Pick up a new item, return, crouch again. Chat reports loot deposited and kit supplied.
Trip status shows the same summary. Abandon trip (two clicks) clears tracking without moving items.

License

MIT License