-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMODDB.html
More file actions
179 lines (179 loc) · 10 KB
/
Copy pathMODDB.html
File metadata and controls
179 lines (179 loc) · 10 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<h2>Burdened</h2>
<p><img src="https://i.imgur.com/EM0iv3w.png" alt="Burdened" width="400" /></p>
<h3>Make every carried slot matter</h3>
<p>Vintage Story treats bags as extra rows of the same inventory. Burdened treats them as bags.</p>
<p>It cuts the space you can use, rearranges it, and lets you open an equipped pack without dumping every bag onto the screen at once.</p>
<p>There is no item-weight formula. The server owns the rules and enforces them on every client.</p>
<h3>What Burdened changes</h3>
<ul>
<li><strong>Fewer slots, on purpose:</strong> 1 to 10 hotbar slots, 1 to 4 bag-equip slots. The HUD contracts around what's left, scrolling skips locked positions, and the server enforces the same rules for everyone. If a setting locks an occupied slot, the item moves into valid storage or drops at your feet. Held items or bags are <span style="text-decoration: underline;">never</span> deleted.</li>
<li><strong>Bags you open yourself:</strong> right-click an equipped bag, or a placed one. Shift picks it up or puts it down. Several bag windows can stay open at once. Selecting a bag moves only that bag into the hand; other wearable bags stay on the body.</li>
<li><strong>Immersive mode:</strong> optional <strong>L / B / R</strong> slots. B takes a general pack (worn on the back, holds ordinary items). L and R take everything else, including a quiver, so a specialised bag never steals the pack slot. Wearable bags keep the attachment their own mod gave them.</li>
<li><strong>A focused inventory screen:</strong> optionally remove bag contents from the inventory dialog so pressing E opens a compact crafting-only window. Equipped bags remain available from the hotbar.</li>
<li><strong>A bounded offhand:</strong> non-bag items can sit there by hand. Bags are always rejected. Vanilla's extra hunger for an ordinary offhand item is a setting (<code>0.2</code> keeps the usual 20%; <code>0</code> turns it off).</li>
<li><strong>Bags from other mods:</strong> sorted by what they are, not by a list of names. A mod can ship a default role; <code>BagRoleOverrides</code> lets the server owner have the last word.</li>
</ul>
<p><img src="https://i.imgur.com/L6wBW5S.png" alt="Several bag inventories open" width="640" /></p>
<p><em>Equipped and placed bags can stay open together.</em></p>
<p><img src="https://i.imgur.com/nDf7bT0.gif" alt="Worn bag in hand" width="640" /></p>
<p><em>When an equipped bag is selected, it is shown in the player's hand without also appearing as a worn duplicate.</em></p>
<p><img src="https://i.imgur.com/kkV9aYR.png" alt="A compact hotbar" width="536" /></p>
<p><em>Config example: two hotbar slots and a single bag slot. The HUD contracts around whatever remains.</em></p>
<h3>Immersive carrying</h3>
<p>Immersive mode replaces the four-slot bag bar with three typed slots. The back slot takes your pack. The left and right slots take everything else, so a quiver or a mining bag never costs you the slot a backpack needs.</p>
<p><img src="https://i.imgur.com/uU4LFRe.png" alt="The immersive L, B, and R bag slots" width="536" /></p>
<p><em>The immersive L, B, and R bag slots.</em></p>
<p><img src="https://i.imgur.com/wuCsr9N.png" alt="Items accepted by the immersive bag roles" width="536" /></p>
<p><em>Works with populated skeps, quivers, and other bags.</em></p>
<h3>Bag controls</h3>
<table style="min-width: 85%; border-collapse: collapse; border: 2px solid #6b563c;" border="1" cellpadding="6">
<thead>
<tr style="background-color: #e3d7c2;">
<th style="text-align: left" scope="col">Where</th>
<th style="text-align: left" scope="col">Input</th>
<th style="text-align: left" scope="col">Action</th>
</tr>
</thead>
<tbody>
<tr>
<td>Placed bag</td>
<td>Right-click</td>
<td>Open its inventory</td>
</tr>
<tr>
<td>Placed bag</td>
<td>Shift + right-click</td>
<td>Equip it into a compatible empty bag slot</td>
</tr>
<tr>
<td>Equipped bag slot</td>
<td>Right-click</td>
<td>Open or close that bag (also with a cursor stack)</td>
</tr>
<tr>
<td>Equipped bag slot</td>
<td>Shift + click</td>
<td>Place it on the targeted block</td>
</tr>
<tr>
<td>Selected equipped bag</td>
<td>Right-click</td>
<td>Open or close the bag when the targeted block does not use the input</td>
</tr>
<tr>
<td>Selected equipped bag</td>
<td>Shift + right-click</td>
<td>Place it on the targeted block</td>
</tr>
</tbody>
</table>
<p>Use <strong>Ctrl + mouse wheel</strong> to include equipped bag slots in hotbar selection. If a pickup or placement is rejected, the bag and its contents stay where they were.</p>
<p>Wall-mounted bags such as quivers keep their vanilla placement gesture: <strong>Ctrl + Shift</strong> against a wall. Chests, vessels, and other containers keep their normal behavior.</p>
<h3>Configuration</h3>
<p>The server creates this file on first run:</p>
<p><code>%APPDATA%\VintagestoryData\ModConfig\burdened.json</code></p>
<p>After editing it, restart the dedicated server or reopen the singleplayer world so the server loads and sends the updated settings.</p>
<table style="min-width: 85%; border-collapse: collapse; border: 2px solid #6b563c;" border="1" cellpadding="6">
<thead>
<tr style="background-color: #e3d7c2;">
<th style="text-align: left" scope="col">Setting</th>
<th style="text-align: left" scope="col">Default</th>
<th style="text-align: left" scope="col">Effect</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>HotbarSlots</code></td>
<td><code>10</code></td>
<td>Usable hotbar slots, from 1 to 10</td>
</tr>
<tr>
<td><code>BagSlots</code></td>
<td><code>4</code></td>
<td>Usable bag-equip slots, from 1 to 4</td>
</tr>
<tr>
<td><code>ImmersiveCarryingMode</code></td>
<td><code>false</code></td>
<td>Use the L / B / R layout instead of <code>BagSlots</code></td>
</tr>
<tr>
<td><code>HideBagContentsInDialog</code></td>
<td><code>true</code></td>
<td>Keep bag contents out of the E inventory</td>
</tr>
<tr>
<td><code>OffhandHoldsAnything</code></td>
<td><code>true</code></td>
<td>Allow manual offhand storage for non-bag items</td>
</tr>
<tr>
<td><code>OffhandHungerPenalty</code></td>
<td><code>0.2</code></td>
<td>Extra hunger rate for ordinary offhand items; <code>0</code> disables it</td>
</tr>
<tr>
<td><code>ImprovedBagInteractions</code></td>
<td><code>true</code></td>
<td>Enable direct opening, pickup, and placement of bags</td>
</tr>
<tr>
<td><code>BagRoleOverrides</code></td>
<td><code>{}</code></td>
<td>Assign bags to the back or waist slots by item code</td>
</tr>
</tbody>
</table>
<p><code>BagRoleOverrides</code> takes an item code and a role of <code>back</code> or <code>waist</code>. Codes accept
<code>*</code> wildcards, and an entry with no domain is read as <code>game:</code>. A server override always wins over a bag's own default. Listing a non-bag does not make it equippable. Entries the server cannot use are skipped and written to the log at startup.</p>
<table style="width: 75%; border-collapse: collapse; background-color: #f4efe4; border: 1px solid #6b563c;"
cellpadding="12">
<tbody>
<tr>
<td>
<p style="margin: 0;"><code>"BagRoleOverrides": {</code></p>
<p style="margin: 0;"><code> "othermod:rucksack-*": "back",</code></p>
<p style="margin: 0;"><code> "game:backpack-sturdy": "waist"</code></p>
<p style="margin: 0;"><code>}</code></p>
</td>
</tr>
</tbody>
</table>
<p dir="auto">Bag mods can declare their own default role in item JSON:</p>
<table style="width: 75%; border-collapse: collapse; background-color: #f4efe4; border: 1px solid #6b563c;"
cellpadding="12">
<tbody>
<tr>
<td>
<p style="margin: 0;"> </p>
<code>"attributes": { "burdened": { "bagRole": "back" } }</code>
<p style="margin: 0;"> </p>
</td>
</tr>
</tbody>
</table>
<p><strong>NOTE:</strong> A server override always wins over that default. Listing an item that is not a bag does not make it equippable. Entries the server cannot use are skipped and written to the log at startup so a typo is easy to spot.</p>
<h3>Compatibility and installation</h3>
<ul>
<li>Built for <strong>Vintage Story 1.22.3</strong>.</li>
<li>Required on both the client and server. Clients and servers should use the same Burdened version.</li>
<li>Standalone, with no required dependencies.</li>
<li>Mods that alter the same inventory, hotbar, bag-slot, or worn-bag behavior may conflict. This includes Immersive Backpacks, Wilderlands Onus Moderatus, and Immersive Modular Backpacks.</li>
</ul>
<p>Download the matching zip from the <strong>Files</strong> tab or use 1-click
install. For a manual installation, place the zip in the Vintage Story
<code>Mods</code> directory without unpacking it, then restart the game or server.</p>
<h3>More information</h3>
<ul>
<li><a href="https://stinow.dev/mods/burdened" target="_blank" rel="noopener noreferrer">Official website</a></li>
<li><a href="https://github.com/stinowdev/vs-burdened" target="_blank" rel="noopener noreferrer">Source and full documentation</a></li>
<li><a href="https://github.com/stinowdev/vs-burdened/blob/main/CHANGELOG.md" target="_blank" rel="noopener noreferrer">Release history</a></li>
<li><a href="https://github.com/stinowdev/vs-burdened/issues" target="_blank" rel="noopener noreferrer">Bug reports and feature requests</a></li>
<li><a href="https://ko-fi.com/stinow" target="_blank" rel="noopener noreferrer">Support development on Ko-fi</a></li>
</ul>
<br />
<p>Feedback is always welcome, especially from dedicated servers.</p>
<br />
<p><em>Burdened is actively developed. The public mod remains free.</em></p>
<p style="color: #e4ddc9;"><em>Keywords: Carrying, Inventory, Immersion, Immersive, Bag, Quiver, Waist, Backpack,
Burden, Carry, Hardcore, Management, Realism, Mechanics, Improvement, GUI, Hotbar, Slot, Slots</em></p>