itch-io-install-instructions.html

<!--
  FS25 Farm Dashboard — itch.io INSTALLATION INSTRUCTIONS (itch-safe HTML)

  Paste into: Edit project → Installation instructions → <> HTML mode.
  Uses the same itch-safe tags as itch-io-page-description.html.

  Full guide: docs/INSTALL.md
-->

<p><strong><span style="color:#b8860b">Read these steps in order</span></strong> — install the <strong>mod first</strong>, then the Windows app.</p>

<p>The desktop app does <em>not</em> run inside FS25. It only reads <code>data.json</code>, which the in-game mod creates while you play (or while a dedicated server runs with the mod). Until you load a save with the mod enabled, the dashboard shows <strong>“waiting for data”</strong> even after the installer finishes.</p>

<p><strong>App 4.2.1</strong> · <strong>Mod 3.4.0.7</strong> · Dashboard at <strong>http://localhost:8766</strong> after setup</p>

<p><strong>Updating from 4.2 / 3.4.0.6:</strong> close Farm Dashboard and Farming Simulator → download the new Setup and <code>FS25_FarmDashboard.zip</code> → replace the app and the mod zip in <code>Documents\My Games\FarmingSimulator2025\mods\</code> (delete any old unpacked folder) → load the save → start the app. Dedicated: replace the mod on the host, restart the server, then update joined clients.</p>

<p><strong>Dedicated servers:</strong> prefer <strong>join as client</strong> (same mod on a joined PC → local <code>data.json</code> → app <strong>Local</strong> mode — <strong>no FTP</strong>). <strong>FTP</strong> remains available for headless-only hosts. Giants port <strong>8080</strong> is an optional XML feed, not a substitute for <code>data.json</code>.</p>

<hr />

<h2>Stage A — Install the mod</h2>

<ol>
  <li>Download <strong>FS25_FarmDashboard.zip</strong> from this page (recommended) or <a href="https://github.com/WizardlyPayload/FarmHub/releases">GitHub Releases</a>.</li>
  <li>Copy the zip into your FS25 <strong>mods</strong> folder:
    <br /><code>Documents\My Games\FarmingSimulator2025\mods\</code>
    <br /><em>Alternative:</em> extract to <code>mods\FS25_FarmDashboard\</code> with <code>modDesc.xml</code> at the folder root.</li>
  <li>Start <strong>Farming Simulator 25</strong> once so the game registers the mod.</li>
</ol>

<figure>
  <img
    src="https://raw.githubusercontent.com/WizardlyPayload/FarmHub/main/docs/doc-screenshots/fd-install-010-mod-folder.png"
    alt="FS25_FarmDashboard zip in the mods folder"
  />
  <figcaption><code>FS25_FarmDashboard</code> as a zip or folder under <strong>mods</strong>.</figcaption>
</figure>

<hr />

<h2>Stage B — Enable on every save</h2>

<p>Repeat for <strong>each savegame</strong> (and each dedicated-server save) that should use the dashboard:</p>

<ol>
  <li>Open the save’s <strong>Mods</strong> list in FS25.</li>
  <li>Enable <strong>Farm Dashboard</strong> / <strong>FS25 Farm Dashboard</strong>.</li>
  <li><strong>Load the save and enter the world</strong> — the main menu alone is not enough.</li>
</ol>

<figure>
  <img
    src="https://raw.githubusercontent.com/WizardlyPayload/FarmHub/main/docs/doc-screenshots/fd-install-020-fs25-mod-enabled.png"
    alt="Farm Dashboard mod enabled in the save mod list"
  />
  <figcaption>Mod ticked in the save’s mod list.</figcaption>
</figure>

<hr />

<h2>Stage C — Confirm data.json is updating</h2>

<p>After about one minute in-game, check this path on your PC:</p>

<p><code>Documents\My Games\FarmingSimulator2025\modSettings\FS25_FarmDashboard\&lt;savegame&gt;\data.json</code></p>

<p>The file should exist and its <strong>Modified</strong> time should advance while you play. For dedicated <strong>join as client</strong>, confirm this path on the <em>joined client</em> PC (not only on the server). For <strong>FTP</strong>, confirm the file on the server profile you will poll.</p>

<figure>
  <img
    src="https://raw.githubusercontent.com/WizardlyPayload/FarmHub/main/docs/doc-screenshots/fd-install-030-datajson-explorer.png"
    alt="data.json with a recent modified timestamp in File Explorer"
  />
  <figcaption>File Explorer — recent <code>data.json</code> timestamp while playing.</figcaption>
</figure>

<hr />

<h2>Stage D — Install the Windows app</h2>

<ol>
  <li>Download and run <strong>FS25-Farm-Dashboard-Setup-4.2.1.exe</strong> from this page (recommended) or <a href="https://github.com/WizardlyPayload/FarmHub/releases">GitHub Releases</a>.</li>
  <li>Choose your language on the welcome page and complete the installer.</li>
  <li>Launch <strong>Farm Dashboard</strong> from the Start menu.</li>
</ol>

<figure>
  <img
    src="https://raw.githubusercontent.com/WizardlyPayload/FarmHub/main/docs/doc-screenshots/fd-install-040-installer-welcome.png"
    alt="Installer welcome page"
  />
  <figcaption>Installer welcome — pick your language.</figcaption>
</figure>

<figure>
  <img
    src="https://raw.githubusercontent.com/WizardlyPayload/FarmHub/main/docs/doc-screenshots/fd-install-045-installer-finished.png"
    alt="Installer finished page"
  />
  <figcaption>Installer finished — launch Farm Dashboard.</figcaption>
</figure>

<hr />

<h2>Stage E — First launch &amp; Server Manager</h2>

<p>On first launch the app opens <strong>Server Manager</strong> if no servers are configured yet.</p>

<figure>
  <img
    src="https://raw.githubusercontent.com/WizardlyPayload/FarmHub/main/docs/doc-screenshots/fd-install-050-app-first-launch.png"
    alt="Farm Dashboard Server Manager on first launch"
  />
  <figcaption>Server Manager before you add a Local save (SP or join-as-client) or FTP server.</figcaption>
</figure>

<h3>Setup walk-through</h3>

<ol>
  <li>Pick your language (top-right on Setup).</li>
  <li>Click <strong>Auto-detect saves</strong> for local PC play (or for a dedicated <strong>join-as-client</strong> mirror already writing on this PC), or add a row manually.</li>
  <li>For dedicated hosts: prefer <strong>Local</strong> after join-as-client (see below). For headless-only / GPortal-style FTP: add <strong>Dedicated Server (FTP)</strong> with host, credentials, profile path, and save slot.</li>
  <li>Optional: <strong>Scan FS25 mods for dashboard images</strong> (vehicle icons from your mod folder).</li>
  <li>With at least one server in the list, click <strong>Launch Dashboard</strong> → open <strong>http://localhost:8766</strong>.</li>
</ol>

<hr />

<h2>Dedicated server — join as client (no FTP)</h2>

<p>Recommended when someone can stay connected to the dedicated server. The same mod automatically mirrors <code>data.json</code> from the dedicated authority to every joined client; the desktop app watches that local folder. Works for the legacy app (<strong>4.2.1</strong> line) and <strong>v5</strong>.</p>

<ol>
  <li>Install <strong>FS25_FarmDashboard.zip</strong> on the <strong>dedicated server</strong> (Stages A–B on that save).</li>
  <li>On the PC that runs Farm Dashboard, install the <strong>same</strong> updated mod and <strong>join the server as a client</strong> (spare/alt account or admin playing).</li>
  <li>Mirroring starts automatically when you join — no in-game opt-in switch.</li>
  <li>Confirm local <code>Documents\My Games\FarmingSimulator2025\modSettings\FS25_FarmDashboard\mirror_&lt;slot&gt;\data.json</code> updates while the client stays connected.</li>
  <li>In Setup or <strong>Settings → Servers &amp; saves</strong>, add a <strong>Local</strong> server (or Auto-detect) pointing at that folder — <strong>no FTP</strong>.</li>
</ol>

<p><strong>Limits:</strong> needs at least one connected client; empty server (zero players) does not mirror until someone joins; large exports may lag a few seconds; requires the updated mod with export mirror on server and client.</p>

<hr />

<h2>Dedicated server — FTP (Advanced)</h2>

<ol>
  <li>Complete Stages <strong>A–C</strong> on the server — mod enabled, save loaded, <code>data.json</code> present on the server profile.</li>
  <li>In Setup or <strong>Settings → Servers &amp; saves</strong>, add FTP host, port, username, password, base profile path, and save slot folder.</li>
  <li>Optional <strong>HTTP feed</strong> (Giants dedicated XML on port <strong>8080</strong>) improves vehicle age, prices, and market history when available — it does <strong>not</strong> replace <code>data.json</code>.</li>
  <li>Set <strong>Poll every</strong> (1–25 minutes). Local saves (including join-as-client) use file watching; FTP uses this schedule.</li>
</ol>

<hr />

<h2>Post-install checks</h2>

<dl>
  <dt><strong>Landing page</strong></dt>
  <dd>Section cards with counts (or zeros until data arrives).</dd>
  <dt><strong>Data-source badge</strong></dt>
  <dd>XML + Live + API (or a subset if unavailable).</dd>
  <dt><strong>Settings → Servers</strong></dt>
  <dd>Correct local path (SP or join-as-client) or FTP host + save slot.</dd>
  <dt><strong>Wrong save empty</strong></dt>
  <dd>Repeat Stage B for that save.</dd>
</dl>

<hr />

<h2>Troubleshooting</h2>

<details>
  <summary><strong>Waiting for data</strong></summary>
  <p>Complete Stages B and C. Verify the save path in <strong>Settings → Servers</strong>. The mod must be enabled and you must have entered the world at least once.</p>
</details>

<details>
  <summary><strong>Port 8766 in use</strong></summary>
  <p>Close other apps using port 8766, then restart Farm Dashboard.</p>
</details>

<details>
  <summary><strong>Join-as-client: no local data.json</strong></summary>
  <p>Keep the client connected. Confirm the same updated mod on server and client. An empty dedicated server with zero players does not mirror until someone joins — use FTP for headless-only.</p>
</details>

<details>
  <summary><strong>FTP never updates</strong></summary>
  <p>Check FTP credentials, save slot folder name, and firewall. Set poll interval to at least 1 minute. Confirm <code>data.json</code> exists on the server profile. Prefer join-as-client when someone can stay connected.</p>
</details>

<details>
  <summary><strong>Blank or broken after upgrade</strong></summary>
  <p>Update <strong>both</strong> the app (<strong>4.2.1</strong>) and mod (<strong>3.4.0.7</strong>) from the same release line.</p>
</details>

<hr />

<p>
  <a href="https://github.com/WizardlyPayload/FarmHub/blob/main/docs/INSTALL.md"><strong>Full install guide (INSTALL.md)</strong></a>
  &nbsp;·&nbsp;
  <a href="https://github.com/WizardlyPayload/FarmHub/blob/main/docs/USER_MANUAL.md"><strong>User manual</strong></a>
  &nbsp;·&nbsp;
  <a href="https://github.com/WizardlyPayload/FarmHub/blob/main/docs/UPGRADE_FROM_FS25-Farm-Dashboard.md"><strong>Upgrade from 2.0.0</strong></a>
</p>

<p><small><em>Not affiliated with GIANTS Software. Farming Simulator is a trademark of GIANTS Software GmbH.</em></small></p>