79 lines
3.9 KiB
Markdown
79 lines
3.9 KiB
Markdown
# QuartmasterArrange
|
|
|
|
Quartermaster x Item Arrange compatibility for Project Zomboid Build 42.20 and later.
|
|
|
|
Mod ID: `QuartermasterItemArrange`
|
|
|
|
Requires [Quartermaster](https://steamcommunity.com/sharedfiles/filedetails/?id=3761216758)
|
|
and [Item Arrange](https://steamcommunity.com/sharedfiles/filedetails/?id=3767639280).
|
|
|
|
## Repository layout
|
|
|
|
The repository root is the mod folder. It can be linked directly into `Zomboid/mods`:
|
|
|
|
```text
|
|
QuartmasterArrange/
|
|
common/
|
|
42.20/
|
|
mod.info
|
|
media/lua/...
|
|
```
|
|
|
|
From PowerShell, with the destination absent:
|
|
|
|
```powershell
|
|
New-Item -ItemType SymbolicLink -Path 'C:\Users\Hudson\Zomboid\mods\QuartermasterItemArrange' -Target 'C:\Users\Hudson\Git\QuartmasterArrange'
|
|
```
|
|
|
|
A physical copy of this mod was installed previously at that destination. Move it
|
|
outside the mods folder before creating the link. Windows may require Developer
|
|
Mode or an elevated shell for symbolic links.
|
|
|
|
Alternatively, copy this repository's `common` and `42.20` folders into a single
|
|
folder under `Zomboid/mods`. Keep them side by side; no additional nested mod folder
|
|
is needed.
|
|
|
|
## Use
|
|
|
|
1. Enable **Quartermaster**, **Item Arrange**, and **Quartermaster - Item Arrange Compatibility** for the save, then restart the game.
|
|
2. Right-click any container Quartermaster can configure and select **[ ] Item Arrange**. A checked option switches the mode off again.
|
|
3. Use **Configure sorting...** to select its categories, specific items, presets and priority.
|
|
4. Select **Distribute Loot**. Your character walks to the destination, faces its tile and uses Item Arrange's Shift-drop placement. You do not need to hold Shift or aim the mouse.
|
|
|
|
The toggle is also available in Quartermaster's inventory context menu. Stacked
|
|
objects and separate compartments can be marked independently. Normal destinations
|
|
keep their usual container transfers.
|
|
|
|
## Placement details
|
|
|
|
- A marked container represents display space on its world tile. Item Arrange controls the final positions on the floor or furniture surfaces.
|
|
- The container's internal weight capacity does not limit display deliveries. Available display space is checked when each item is delivered.
|
|
- Blocked or full destinations, removed objects and failed loads are skipped without cancelling the remaining haul. Items stay in their source or carrier. Failed display deliveries are not automatically rerouted.
|
|
- Item Arrange's item and surface support is unchanged. Unsupported items may become ordinary ground drops.
|
|
- Compartments and objects sharing a tile share that tile's arrangement space. The toggle cannot select a particular shelf on the same tile.
|
|
- Existing contents remain inside marked containers. Quartermaster still skips items already in their matching destination.
|
|
- Displayed items are world items, so they do not count as container contents for Quartermaster's manifest or crafting-from-storage.
|
|
- Marks are saved per compartment on the world object. Sorting copy/paste and presets do not copy the independent Item Arrange flag.
|
|
|
|
## Multiplayer
|
|
|
|
Install the mod on the server and every client. Add `QuartermasterItemArrange`
|
|
after `Quartermaster` and `ItemArrange` in the server's `Mods` list. The required
|
|
Workshop IDs are `3761216758` and `3767639280`. This add-on has no published
|
|
Workshop ID.
|
|
|
|
The server validates and saves marks. A shared timed action delegates placement to
|
|
Item Arrange. Live multiplayer behavior still needs an in-game test.
|
|
|
|
## Validation
|
|
|
|
Built against Quartermaster **0.24.0** and Item Arrange **2.9**. Passed **17 offline
|
|
Lua 5.1 integration scenarios** using their actual installed Lua implementations
|
|
with mocked game objects, including a full sort queue with mixed destinations.
|
|
Every shipping Lua file passed syntax compilation. The game and Java networking
|
|
were not exercised.
|
|
|
|
Start with one supported item delivered to a marked table or shelf, then try a
|
|
mixed haul to both a marked display and a normal crate. Repeat on the intended
|
|
multiplayer server before relying on it there.
|