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
6 changes: 4 additions & 2 deletions PRODUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ on one map, links them only through Trading Post barter, and still offers ordina
- **Away players keep their colony:** by default a colony is never handed over while its player is away. A friend
can look after it (Y), and automatic hand-over after a set number of days away is opt-in, for groups where
someone may not come back.
- **Sharing power** (not played yet): the **Power Export Facility** (Power tab; 20 gears, 20 planks and 20 logs,
- **Sharing power** (not played yet; only in the 1.4.0-rc32 pre-release, so not on the site until a release with it
is GitHub's Latest): the **Power Export Facility** (Power tab; 20 gears, 20 planks and 20 logs,
10 of each a half; 200 science), two halves with a worker each, sends one colony's spare power to another (**Send power to …**, with
**Charge my batteries first** and **Use my batteries for …**). Power never joins between colonies otherwise;
Ctrl+P shows every colony's power and H opens the Power window. It trades nothing: payment is a Trading Post barter.
Expand All @@ -92,7 +93,8 @@ on one map, links them only through Trading Post barter, and still offers ordina
5. **Every player has the same game version and the exact same download. Update together:** a different build
cannot join (*Multiplayer build mismatch*).

**Status:** beta, current version **1.4.0-rc32** (a release candidate, GitHub's Latest; its changes are not played yet). The site names the newest published release,
**Status:** beta, current version **1.4.0-rc31** (a release candidate, GitHub's Latest; its changes are not played yet).
**1.4.0-rc32** (sharing power) is a pre-release for testing: the site describes rc31 until rc32 or later is Latest. The site names the newest published release,
and `docs/assets/release.js` fills the version badges from GitHub. 1.4.0 has not been released yet. It is built for
Timberborn **1.1.2.4**, and only the Steam version on Windows has been tested. It passes a large automated test
suite, and every feature has been played except mixed factions and sharing power (12+ hours in one game with no desync). Players should play
Expand Down
33 changes: 13 additions & 20 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
</a>
<a class="btn ghost" href="#install">Install guide</a>
</div>
<p class="status-tag plate caution"><span><span data-release="version">1.4.0-rc32</span></span><span>Timberborn 1.1.2.4</span><span>Beta: back up your saves</span></p>
<p class="status-tag plate caution"><span><span data-release="version">1.4.0-rc31</span></span><span>Timberborn 1.1.2.4</span><span>Beta: back up your saves</span></p>
</div>

<figure class="map-figure plate enamel">
Expand Down Expand Up @@ -243,7 +243,7 @@ <h3>Everyone needs</h3>
<ol class="steps">
<li><div>
<h3>Download the zip</h3>
<p>From the <a href="https://github.com/timbermods/TimberTogether/releases" data-release-href="notes">newest release</a>, download <code><span data-release="asset-name">TimberTogether-1.4.0-rc32.zip</span></code> under <b>Assets</b> (not "Source code"). Got a zip from your host? Use that one.</p>
<p>From the <a href="https://github.com/timbermods/TimberTogether/releases" data-release-href="notes">newest release</a>, download <code><span data-release="asset-name">TimberTogether-1.4.0-rc31.zip</span></code> under <b>Assets</b> (not "Source code"). Got a zip from your host? Use that one.</p>
</div></li>
<li><div>
<h3>Close Timberborn</h3>
Expand All @@ -269,7 +269,7 @@ <h3>Enable the mods</h3>
<h3>Before you join: compare three things with your host</h3>
<p>All three must match.</p>
<dl class="readings">
<div><dt>The mod</dt><dd class="val" data-release="version">1.4.0-rc32</dd><dd class="why">The mod list shows <b>Timber Together</b> with its version.</dd></div>
<div><dt>The mod</dt><dd class="val" data-release="version">1.4.0-rc31</dd><dd class="why">The mod list shows <b>Timber Together</b> with its version.</dd></div>
<div><dt>The game</dt><dd class="val">Timberborn 1.1.2.4</dd><dd class="why">The same Timberborn version for everyone.</dd></div>
<div><dt>The download</dt><dd class="val">The same zip</dd><dd class="why">The same file, not only the same number.</dd></div>
</dl>
Expand Down Expand Up @@ -322,11 +322,6 @@ <h3>Folktails and Iron Teeth together <span class="not-played">Not played yet</s
<p>The host ticks <b>Mixed factions</b> on the New Game page, and each player picks a faction in the room. Your colony gets your faction's toolbar, beavers, bots and buildings. Between factions, Trading Posts carry the goods both use, and science, but not beavers.</p>
<p class="muted">Needs every faction unlocked on the host's computer, and no other faction mod; otherwise the box is greyed and says why.</p>
</article>
<article class="plate enamel">
<h3>Sharing power <span class="not-played">Not played yet</span></h3>
<p>Build a <b>Power Export Facility</b> (Power tab) between two colonies. Each half needs its colony's road, a shaft at its end, and a worker. Tick <b>Send power to &hellip;</b> on your half, and your spare power goes to them.</p>
<p class="muted">Power goes one way between two colonies, and each colony can pass it on. <kbd>H</kbd> opens the Power window. To pay for it, trade at a Trading Post.</p>
</article>
<article class="plate enamel">
<h3>Away for a while? Your colony waits</h3>
<p>Your colony is kept for you. To keep it running, press <kbd>Y</kbd> &rarr; <b>Let &hellip; look after it</b>. Your friend presses <b>Run this colony</b> to play it, and <b>Back to your colony</b> when done. <b>Take it back</b> any time.</p>
Expand All @@ -339,7 +334,6 @@ <h3 style="margin:3rem 0 1.2rem;font-size:1.7rem">Your colony, your rules</h3>
<ul class="rules">
<li><b>Yours alone</b><p>Your districts, beavers, stock, working hours and marks. Nobody else can change your buildings, and your beavers work only for you.</p></li>
<li><b>Build anywhere</b><p>No land and no borders: build right up to a neighbor. The one rule: your roads never join theirs. <kbd>Ctrl</kbd>+<kbd>L</kbd> shows every colony's roads.</p></li>
<li><b>Your own power</b><p>Your power never joins a neighbor's, except through a Power Export Facility. <kbd>Ctrl</kbd>+<kbd>P</kbd> shows every colony's power.</p></li>
<li><b>Your own science</b><p>With <b>Separate science and unlocks</b> ticked (the default), each colony earns its own science and unlocks its own buildings.</p></li>
<li><b>Remembered by the save</b><p>The save knows you by your Steam ID, so you get the same colony whoever hosts.</p></li>
<li><b>Shared by everyone</b><p>Speed, pause, pings, chat, saving, and the map itself: water, droughts, badwater and weather.</p></li>
Expand Down Expand Up @@ -457,7 +451,7 @@ <h2 id="also-h">Also included</h2>
<div class="head">
<div class="marker" aria-hidden="true"><i></i><b></b><i></i></div>
<h2 id="status-h">Beta: what's been played</h2>
<p>The release candidate for 1.4.0. Automated checks cover everything here, and all but two features have been played. Play on a copy of your save and keep backups.</p>
<p>The release candidate for 1.4.0. Automated checks cover everything here, and all but one feature has been played. Play on a copy of your save and keep backups.</p>
</div>
<div class="status-grid">
<div class="plate enamel">
Expand All @@ -479,7 +473,6 @@ <h3>Played in real games</h3>
<h3>Not played yet</h3>
<ul class="checklist open">
<li>Folktails and Iron Teeth together.</li>
<li>Sharing power through a Power Export Facility.</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -556,24 +549,24 @@ <h2 id="help-h">Troubleshooting</h2>
<div class="wrap">
<div class="head">
<div class="marker" aria-hidden="true"><i></i><b></b><i></i></div>
<h2 id="release-h">What's in <span data-release="version">1.4.0-rc32</span></h2>
<h2 id="release-h">What's in <span data-release="version">1.4.0-rc31</span></h2>
</div>
<div class="release">
<div class="plate grommets">
<span class="ver" data-release="version">1.4.0-rc32</span>
<span class="ver" data-release="version">1.4.0-rc31</span>
<p>The release candidate for 1.4.0. Everyone in a game needs this build.</p>
<div class="btn-row">
<a class="btn ghost" href="https://github.com/timbermods/TimberTogether/releases" data-release-href="notes">Release notes</a>
</div>
<p style="margin:1.1rem 0 0"><a href="https://github.com/timbermods/TimberTogether/releases">All releases</a> &middot; <a href="https://github.com/timbermods/TimberTogether/blob/main/STABILITY-CHANGELOG.md">Changelog</a></p>
</div>
<div class="measure" data-release-pinned="1.4.0-rc32">
<h3>Share power with a neighbor</h3>
<p>The <b>Power Export Facility</b> sends your spare power to another colony. Tick <b>Send power to &hellip;</b> on your half: they get only what they can use, after your own buildings.</p>
<h3>Your power stays yours</h3>
<p>Two colonies' power never joins, except through a facility. <kbd>Ctrl</kbd>+<kbd>P</kbd> shows every colony's power.</p>
<h3>The Power window</h3>
<p>Press <kbd>H</kbd> to see where power goes, your networks and facilities, and every colony's power.</p>
<div class="measure" data-release-pinned="1.4.0-rc31">
<h3>Type the whole trade</h3>
<p>Offer 101 logs for 2 gears, or 500 for 500. Nothing is refused. The game carries exactly that, up to 100 of each a round, and <b>Rounds</b> shows how many.</p>
<h3>Your own colony, everywhere you look</h3>
<p>The Global history graphs, the wellbeing window and a good's stock chart show only your colony.</p>
<h3>A cleaner colonies window</h3>
<p>The Trading Posts and colonies window (<b>Y</b>) matches the game's own windows, with readable text.</p>
</div>
</div>
</div>
Expand Down
12 changes: 5 additions & 7 deletions docs/install.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ <h2>Install the mod</h2>
<ol class="steps">
<li><div>
<h3>Download the zip</h3>
<p>From the <a href="https://github.com/timbermods/TimberTogether/releases" data-release-href="notes">newest release</a>, download <code><span data-release="asset-name">TimberTogether-1.4.0-rc32.zip</span></code> under <b>Assets</b>, not "Source code". Got a zip from your host? Use that one.</p>
<p>From the <a href="https://github.com/timbermods/TimberTogether/releases" data-release-href="notes">newest release</a>, download <code><span data-release="asset-name">TimberTogether-1.4.0-rc31.zip</span></code> under <b>Assets</b>, not "Source code". Got a zip from your host? Use that one.</p>
</div></li>
<li><div>
<h3>Close Timberborn</h3>
Expand All @@ -109,7 +109,7 @@ <h3>Enable the mods</h3>
</div></li>
</ol>
<p>To check the download, run this in PowerShell where you saved it, and compare with the SHA-256 on the release page:</p>
<pre><code>Get-FileHash .\<span data-release="asset-name">TimberTogether-1.4.0-rc32.zip</span> -Algorithm SHA256</code></pre>
<pre><code>Get-FileHash .\<span data-release="asset-name">TimberTogether-1.4.0-rc31.zip</span> -Algorithm SHA256</code></pre>
</section>

<section id="compare">
Expand All @@ -119,7 +119,7 @@ <h2>Compare with your host</h2>
<table class="stacked compare">
<thead><tr><th>What</th><th>Should read</th><th>Where to look</th></tr></thead>
<tbody>
<tr><td><b>The mod</b></td><td><span data-release="version">1.4.0-rc32</span></td><td>The mod list shows <b>Timber Together</b> with its version.</td></tr>
<tr><td><b>The mod</b></td><td><span data-release="version">1.4.0-rc31</span></td><td>The mod list shows <b>Timber Together</b> with its version.</td></tr>
<tr><td><b>The game</b></td><td>1.1.2.4</td><td>The same Timberborn version for everyone.</td></tr>
<tr><td><b>The download</b></td><td>The same zip</td><td>The same file, not only the same number: compare the SHA-256 if in doubt.</td></tr>
</tbody>
Expand All @@ -131,9 +131,9 @@ <h2>Compare with your host</h2>
<section id="verify">
<h2>Check it loaded</h2>
<ul>
<li>The mod list shows <b>Timber Together</b> with version <b><span data-release="version">1.4.0-rc32</span></b>.</li>
<li>The mod list shows <b>Timber Together</b> with version <b><span data-release="version">1.4.0-rc31</span></b>.</li>
<li>The main menu has a <b>Join co-op game</b> button.</li>
<li>Your game log, <code>%USERPROFILE%\AppData\LocalLow\Mechanistry\Timberborn\Player.log</code>, contains the line <code>Timber Together v<span data-release="version">1.4.0-rc32</span> is loaded!</code></li>
<li>Your game log, <code>%USERPROFILE%\AppData\LocalLow\Mechanistry\Timberborn\Player.log</code>, contains the line <code>Timber Together v<span data-release="version">1.4.0-rc31</span> is loaded!</code></li>
</ul>
<p>If it isn't there, see <a href="troubleshooting.html#not-loading">The mod doesn't load</a>.</p>
</section>
Expand Down Expand Up @@ -260,9 +260,7 @@ <h3 class="settings-group">Keys</h3>
<tbody>
<tr><td><kbd>Ctrl</kbd>+<kbd>K</kbd></td><td>Found your colony, if you have none.</td></tr>
<tr><td><kbd>Ctrl</kbd>+<kbd>L</kbd></td><td>Show every colony's roads in its color.</td></tr>
<tr><td><kbd>Ctrl</kbd>+<kbd>P</kbd></td><td>Show every colony's power in its color.</td></tr>
<tr><td><kbd>Y</kbd></td><td>Your Trading Posts and every colony.</td></tr>
<tr><td><kbd>H</kbd></td><td>The Power window.</td></tr>
<tr><td><kbd>Enter</kbd></td><td>Type in the chat.</td></tr>
<tr><td><kbd>Home</kbd></td><td>Back to your colony. Click a name in the connection panel to go to that player.</td></tr>
<tr><td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>J</kbd></td><td>Write a diagnostics report.</td></tr>
Expand Down
16 changes: 1 addition & 15 deletions docs/troubleshooting.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h2>Installing and loading</h2>
<li>Install and enable <b>Harmony</b> and <b>Mod Settings</b>.</li>
<li>Enable <b>Timber Together</b> in the mod manager and restart the game.</li>
<li>Check the game version: Timberborn 1.1 (tested on 1.1.2.4).</li>
<li>Search <code>%USERPROFILE%\AppData\LocalLow\Mechanistry\Timberborn\Player.log</code> for <code>Timber Together v<span data-release="version">1.4.0-rc32</span> is loaded!</code>. If it's there, the mod loaded.</li>
<li>Search <code>%USERPROFILE%\AppData\LocalLow\Mechanistry\Timberborn\Player.log</code> for <code>Timber Together v<span data-release="version">1.4.0-rc31</span> is loaded!</code>. If it's there, the mod loaded.</li>
</ol>
</div>
</details>
Expand Down Expand Up @@ -224,20 +224,6 @@ <h2>Colonies and trading</h2>
</div>
</details>

<details class="q" id="power">
<summary>"That would join another colony's power"</summary>
<div class="answer">
<p>A shaft or powered building of yours would connect to theirs. Keep your shafts a cell apart; to share power, put a Power Export Facility between them. <kbd>Ctrl</kbd>+<kbd>P</kbd> shows whose power is whose.</p>
</div>
</details>

<details class="q" id="no-power">
<summary>No power crosses a Power Export Facility</summary>
<div class="answer">
<p>Select your half: its panel says what's missing. Each half needs its colony's road at its door, a shaft at its end, and a worker at work. Power crosses only when one side has some to spare and the other can use it.</p>
</div>
</details>

<details class="q" id="shared">
<summary><kbd>Ctrl</kbd>+<kbd>K</kbd> says this is one shared colony</summary>
<div class="answer">
Expand Down
Loading