Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Close Timberborn, then disable MixedStorage in the mod manager or delete its fol

Built against **Timberborn 1.1.2.4**.

The bundled multiplayer integration is built against the **[BeaverBuddies Stability Fork](https://github.com/timbermods/BeaverBuddies-Stability-Fork)** (formerly called Stability Preview), which is the build to use. Stability Fork releases 1.0.0 through 1.1.12 were checked to have everything the integration needs; install the latest. At startup, MixedStorage checks the installed BeaverBuddies for every part it uses. If anything is missing, it turns co-op Apply off rather than risk a desync, and Player.log names what is missing. The original [BeaverBuddies](https://github.com/thomaswp/BeaverBuddies) by thomaswp and contributors, and BeaverBuddies MultiColony (Beta), have not been tested with MixedStorage.
The bundled multiplayer integration is built against the **[BeaverBuddies Stability Fork](https://github.com/timbermods/BeaverBuddies-Stability-Fork)** (formerly called Stability Preview), which is the build to use. Stability Fork releases 1.0.0 through 1.1.12 were checked to have everything the integration needs; install the latest. At startup, MixedStorage checks the installed BeaverBuddies for every part it uses. If anything is missing, it turns co-op Apply off rather than risk a desync, and Player.log names what is missing. The original [BeaverBuddies](https://github.com/thomaswp/BeaverBuddies) by thomaswp and contributors, and Timber Together (Beta), have not been tested with MixedStorage.

Players have reported successful use of earlier builds, and the **v0.5.8 layout, including the dev-mode panel, and the v0.5.7 storage visuals have been verified in game**; v1.0.0 through v1.2.0 leave both unchanged apart from v1.2.0's orange ring around Apply. The v1.0.0 to v1.2.0 changes (Copy settings, error messages, loading damaged saves, the Supply mode order, the panel's reason for an unavailable Apply, patch order, leaving mixed storage with a removed good or through the map editor's undo, and in v1.2.0 storing nothing and the Apply ring) have not been played in game yet. Automated allocation, geometry, native API, and optional multiplayer loading checks also pass, but these do not replace live gameplay testing.

Expand Down
2 changes: 1 addition & 1 deletion docs/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ <h2 class="group-title">Multiplayer and compatibility</h2>
<details class="qa" id="faq-mp"><summary>Does it work in multiplayer?</summary><div class="qa__body"><p>Yes, through the BeaverBuddies Stability Fork. Every player installs the same version of MixedStorage (and the same Stability Fork build) and runs the same game version. Applied allocations synchronize through BeaverBuddies, and Apply may briefly show a queued message until the next simulation tick.</p></div></details>
<details class="qa" id="faq-mp-download"><summary>Is there a separate multiplayer add-on?</summary><div class="qa__body"><p>No. The integration is bundled and switches on automatically when BeaverBuddies is present. If you still have the old <strong>MixedStorage-BeaverBuddies</strong> add-on, remove or disable it.</p></div></details>
<details class="qa" id="faq-replays"><summary>What about old multiplayer replay recordings?</summary><div class="qa__body"><p>Old recordings may reference the former add-on and may need the original mod versions.</p></div></details>
<details class="qa" id="faq-bb-builds"><summary>Which BeaverBuddies builds work?</summary><div class="qa__body"><p>The integration is built against the Stability Fork; install the latest on every computer. At startup MixedStorage checks the installed BeaverBuddies, and if something is missing it turns multiplayer Apply off and names what's missing in Player.log. The original BeaverBuddies and BeaverBuddies MultiColony (Beta) haven't been tested with MixedStorage.</p></div></details>
<details class="qa" id="faq-bb-builds"><summary>Which BeaverBuddies builds work?</summary><div class="qa__body"><p>The integration is built against the Stability Fork; install the latest on every computer. At startup MixedStorage checks the installed BeaverBuddies, and if something is missing it turns multiplayer Apply off and names what's missing in Player.log. The original BeaverBuddies and Timber Together (Beta) haven't been tested with MixedStorage.</p></div></details>
<details class="qa" id="faq-mods"><summary>Is it compatible with other mods?</summary><div class="qa__body"><p>Other mods haven't been specifically tested. If you run into a conflict, <a href="https://github.com/timbermods/MixedStorage/issues" rel="noopener">open an issue</a> and list your enabled mods.</p></div></details>
<details class="qa" id="faq-language"><summary>Is MixedStorage translated?</summary><div class="qa__body"><p>No. The mod's own text is in English. Good names follow your game language.</p></div></details>
<h2 class="group-title">The project</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/install.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h2>Multiplayer with BeaverBuddies</h2>
<li>There is <strong>no separate MixedStorage multiplayer download</strong>.</li>
<li>After upgrading, restart every computer's game and start a fresh multiplayer session.</li>
</ul>
<p class="muted">Install the latest Stability Fork on every computer. At startup MixedStorage checks the installed BeaverBuddies for everything it uses; if something is missing it turns co-op Apply off rather than risk players drifting out of step, and Player.log names what's missing. The original BeaverBuddies and BeaverBuddies MultiColony haven't been tested with MixedStorage.</p>
<p class="muted">Install the latest Stability Fork on every computer. At startup MixedStorage checks the installed BeaverBuddies for everything it uses; if something is missing it turns co-op Apply off rather than risk players drifting out of step, and Player.log names what's missing. The original BeaverBuddies and Timber Together haven't been tested with MixedStorage.</p>
</div>
</section>

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ <h3 class="group-title">Using the panel</h3>
<details class="qa" id="t-lost-allocation"><summary>A building lost its allocation</summary><div class="qa__body"><h4>Why it happens</h4><ul><li>The game's <strong>Copy settings</strong> tool was used from a normal building. That turns a mixed building back into a normal single-good one, the same way it copies a single good between normal buildings.</li><li>Its saved allocation couldn't be read, for example because the save file was damaged. MixedStorage skips it rather than stop the whole save from loading. The building keeps its normal single good, and Player.log has a line starting <code>[MixedStorage] Ignoring an unreadable saved allocation</code>.</li></ul><h4>What to do</h4><p>Set the percentages again and click <strong>Apply 100%</strong>. If a save keeps losing allocations, <a href="#reporting">report it</a> with that log line.</p></div></details>
<details class="qa" id="t-apply-failed"><summary>Apply shows “Apply failed”</summary><div class="qa__body"><h4>Why it happens</h4><p>Something unexpected went wrong while applying the allocation. The panel shows a short reason, and Player.log has the full details.</p><h4>What to do</h4><p><a href="#reporting">Report it</a> with the Player.log lines that start with <code>[MixedStorage]</code> and the steps that led to it.</p></div></details>
<h3 class="group-title">Co-op</h3>
<details class="qa" id="t-bb-incompatible"><summary>Apply says multiplayer support could not start with the installed BeaverBuddies</summary><div class="qa__body"><h4>Why it happens</h4><p>MixedStorage's multiplayer support is built against the BeaverBuddies Stability Fork. If the installed BeaverBuddies lacks something it needs, MixedStorage switches its multiplayer support off rather than let players' games drift out of sync, and writes the reason to Player.log at startup. The game still starts, and single-player allocations usually still work.</p><h4>What to do</h4><ul><li>Install the latest <a href="https://timbermods.github.io/BeaverBuddies-Stability-Fork/" rel="noopener">BeaverBuddies Stability Fork</a> on every computer. The original BeaverBuddies and BeaverBuddies MultiColony (Beta) haven't been tested with it.</li><li>For single-player, you can also disable BeaverBuddies.</li><li>Search Player.log for <code>[MixedStorage]</code> to see what's missing, and include that line if you <a href="#reporting">report it</a>.</li></ul></div></details>
<details class="qa" id="t-bb-incompatible"><summary>Apply says multiplayer support could not start with the installed BeaverBuddies</summary><div class="qa__body"><h4>Why it happens</h4><p>MixedStorage's multiplayer support is built against the BeaverBuddies Stability Fork. If the installed BeaverBuddies lacks something it needs, MixedStorage switches its multiplayer support off rather than let players' games drift out of sync, and writes the reason to Player.log at startup. The game still starts, and single-player allocations usually still work.</p><h4>What to do</h4><ul><li>Install the latest <a href="https://timbermods.github.io/BeaverBuddies-Stability-Fork/" rel="noopener">BeaverBuddies Stability Fork</a> on every computer. The original BeaverBuddies and Timber Together (Beta) haven't been tested with it.</li><li>For single-player, you can also disable BeaverBuddies.</li><li>Search Player.log for <code>[MixedStorage]</code> to see what's missing, and include that line if you <a href="#reporting">report it</a>.</li></ul></div></details>
<details class="qa" id="t-multiplayer"><summary>Multiplayer: Apply says “Queued for multiplayer”, or players see different settings</summary><div class="qa__body"><h4>Why it happens</h4><p>In multiplayer, applied allocations synchronize through BeaverBuddies, so Apply may briefly show a queued message until the next simulation tick. That's normal. Different settings between players usually mean mismatched installs.</p><h4>What to do</h4><ul><li>Every player installs the same version of MixedStorage (and the same Stability Fork build) and runs the same game version.</li><li>After upgrading, restart every computer's game and start a fresh multiplayer session.</li><li>Old replay recordings may reference the former add-on and may need the original mod versions.</li></ul></div></details>
<h3 class="group-title">How it looks</h3>
<details class="qa" id="t-visuals"><summary>The goods in the world look wrong, narrow, or show only one good</summary><div class="qa__body"><h4>Why it happens</h4><p>The in-world split is approximate on purpose. Whole visible cells can't always match a percentage exactly. Tiny shares may have no visible cell, some models look narrower, banners show one representative good, and excess goods may not be fully represented.</p><h4>What to do</h4><p>Use the summary cards for exact amounts. If a model can't be divided, MixedStorage falls back to the original visuals. If something looks truly broken, <a href="#reporting">report it</a> with a screenshot.</p></div></details>
Expand Down