Skip to content

Commit 5ff0444

Browse files
Update
1 parent 765adf2 commit 5ff0444

7 files changed

Lines changed: 23 additions & 384 deletions

File tree

FS25_FarmDashboard_App/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

FS25_FarmDashboard_App/web/assests/js/modules/dashboard-settings.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -844,7 +844,7 @@ function populateAboutModVersions(dashboard) {
844844
const modEl = document.getElementById("settings-about-mod-version");
845845
const expectedEl = document.getElementById("settings-about-mod-expected");
846846
const check = dashboard?.modVersionCheck;
847-
const expected = check?.expectedMin || "3.0.0.0";
847+
const expected = check?.expectedMin || "3.1.0.0";
848848

849849
if (expectedEl) expectedEl.textContent = expected;
850850

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@
2727

2828
Planning notes, audits, i18n pipeline, old release copy, and engine reference text live under **[`_internal/`](./_internal/)** — not required for end users.
2929

30-
**Versions:** App **4.0.0** · Mod **3.0.0.0** · Build scripts: [../tools/README.md](../tools/README.md)
30+
**Versions:** App **4.1.0** · Mod **3.1.0.0** · Build scripts: [../tools/README.md](../tools/README.md)

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
"i18n:audit": "npm run i18n:audit --prefix FS25_FarmDashboard_App",
2525
"i18n:build": "npm run i18n:build --prefix FS25_FarmDashboard_App",
2626
"i18n:sync": "npm run i18n:sync --prefix FS25_FarmDashboard_App",
27-
"i18n:verify": "npm run i18n:verify --prefix FS25_FarmDashboard_App"
27+
"i18n:verify": "npm run i18n:verify --prefix FS25_FarmDashboard_App",
28+
"testers:hash": "node tools/generate-testers-password-hash.mjs"
2829
}
2930
}
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#!/usr/bin/env node
2+
/**
3+
* Print SHA-256 hex for Website/js/testers-config.js → auth.passwordSha256
4+
*
5+
* Usage: node tools/generate-testers-password-hash.mjs "your-secret-password"
6+
*/
7+
import { createHash } from "node:crypto";
8+
9+
const password = process.argv[2];
10+
if (!password) {
11+
console.error("Usage: node tools/generate-testers-password-hash.mjs \"your-password\"");
12+
process.exit(1);
13+
}
14+
15+
const hash = createHash("sha256").update(password, "utf8").digest("hex");
16+
console.log(hash);

wiki/Installation-Guide.md

Lines changed: 1 addition & 130 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,5 @@
11
# Installation Guide
22

3-
<<<<<<< Updated upstream
4-
This guide walks you through installing and setting up the **FS25 Farm Dashboard** step-by-step. Follow these instructions **in order** — the mod must come before the Windows app.
5-
6-
## Why Mod First?
7-
8-
The Windows app **cannot read your farm directly from FS25**. It only reads a file called `data.json` that the **mod creates and updates** while you play.
9-
10-
Until you have **loaded a save with the mod enabled** at least once:
11-
- The game has not created the mod's output folders
12-
- `data.json` does not exist (or is not being updated)
13-
- The dashboard shows "**waiting for data**"
14-
15-
**Solution:** Mod first (creates the data) → App second (reads the data)
16-
17-
---
18-
19-
## Stage A — Install the Mod
20-
21-
1. Download `FS25_FarmDashboard.zip` from [GitHub Releases](https://github.com/WizardlyPayload/FarmHub/releases)
22-
23-
2. Copy the zip file into your FS25 `mods` folder:
24-
=======
253
Step-by-step setup for **FS25 Farm Dashboard**. Follow **stages A–E in order**. Skipping the mod stages is the #1 cause of a blank dashboard.
264

275
## Why mod first?
@@ -39,45 +17,13 @@ Until you load a save with the mod enabled:
3917

4018
## Stage A — Install the mod
4119

42-
1. Download **`FS25_FarmDashboard.zip`** from [Releases](https://github.com/WizardlyPayload/FarmHub/releases).
20+
1. Download **`FS25_FarmDashboard.zip` (3.1.0.0)** from [Releases](https://github.com/WizardlyPayload/FarmHub/releases).
4321
2. Copy into FS25 mods folder:
4422

45-
>>>>>>> Stashed changes
4623
```
4724
Documents\My Games\FarmingSimulator2025\mods\
4825
```
4926

50-
<<<<<<< Updated upstream
51-
**OR** extract it so you have:
52-
```
53-
mods\FS25_FarmDashboard\
54-
├── modDesc.xml
55-
├── icon.png
56-
└── src\
57-
```
58-
59-
3. Start **Farming Simulator 25** (the game will detect the mod)
60-
61-
---
62-
63-
## Stage B — Enable the Mod Per Save
64-
65-
**You must do this for every savegame where you want the dashboard to work.**
66-
67-
1. Open the game and go to **Mods**
68-
2. Find and **enable** the **Farm Dashboard** mod for each save
69-
3. **Load the save and enter the world** (just the main menu is not enough)
70-
4. Wait ~1 minute for the mod to initialize
71-
5. Repeat for all other saves
72-
73-
⚠️ **Important:** Load the save **into the world**, not just the menu screen. The mod only starts collecting data once you're in-game.
74-
75-
---
76-
77-
## Stage C — Confirm Data Is Being Written
78-
79-
After loading a save with the mod enabled, check for the `data.json` file:
80-
=======
8127
**Recommended:** leave as `.zip` (FS25 loads zip mods).
8228

8329
**Or extract** so you have:
@@ -110,85 +56,11 @@ Dedicated / rented server: enable the mod **on the server** and load the save th
11056
## Stage C — Confirm `data.json`
11157

11258
After ~1 minute in-game, check:
113-
>>>>>>> Stashed changes
11459

11560
```
11661
%USERPROFILE%\Documents\My Games\FarmingSimulator2025\modSettings\FS25_FarmDashboard\<savegame>\data.json
11762
```
11863

119-
<<<<<<< Updated upstream
120-
**Good:** The file exists and has a **recent modified timestamp**
121-
122-
**Problem:** File is missing or old → Go back to Stage B
123-
124-
---
125-
126-
## Stage D — Install the Windows App
127-
128-
1. Download the latest `FS25 Farm Dashboard Setup X.X.X.exe` from [GitHub Releases](https://github.com/WizardlyPayload/FarmHub/releases)
129-
130-
2. Run the installer:
131-
- Choose your language on the welcome page
132-
- Follow the setup wizard
133-
- Choose install location (default is fine)
134-
135-
3. Finish the installation
136-
137-
---
138-
139-
## Stage E — First Launch & Setup
140-
141-
1. **Launch** "Farm Dashboard" from the Start menu or desktop shortcut
142-
143-
2. The app opens and shows a **Setup page** if no servers are configured
144-
145-
3. **Auto-detect** your saves:
146-
- Click the **"Auto-detect saves"** button
147-
- Select the saves you want to monitor
148-
- Click **Accept**
149-
150-
4. The app now shows your servers in the list
151-
152-
5. Click **Launch** to proceed to the dashboard
153-
154-
6. **Open your browser** to:
155-
```
156-
http://localhost:8766
157-
```
158-
159-
✓ You should see the Farm Dashboard!
160-
161-
---
162-
163-
## Quick Troubleshooting
164-
165-
| Issue | Solution |
166-
|-------|----------|
167-
| **"Waiting for data"** | Did you complete Stage B? Mod must be enabled and save loaded **into the world**. Check that `data.json` exists (Stage C). |
168-
| **Server not found** | Check Settings → Servers & saves. The path should point to the correct save folder containing `data.json`. |
169-
| **Port 8766 in use** | Another app is using that port. Close the other app or restart the dashboard app. |
170-
| **FTP connection fails** | Check FTP credentials, host, port. Verify the remote directory path contains `data.json`. |
171-
172-
---
173-
174-
## For Dedicated / Rented Servers
175-
176-
Same process, but:
177-
1. Install the mod on the **server**
178-
2. Enable it and load the save **on the server**
179-
3. In the app Setup, choose **FTP** instead of Local
180-
4. Enter your FTP credentials, host, port, and remote directory
181-
5. The app polls the server for updates (every 5 minutes by default)
182-
183-
---
184-
185-
## Next Steps
186-
187-
- **[Read the User Manual](User-Manual)** for a complete feature walkthrough
188-
- **[Enable LAN Access](Security-and-Network#network-browser-access-on-your-lan-important)** if you want to view the dashboard on a tablet or phone
189-
- **[Configure Settings](User-Manual#5-settings-modal--every-tab-and-control)** to customize the dashboard
190-
191-
=======
19264
| Result | Action |
19365
|--------|--------|
19466
| File exists, **recent** modified time | Continue to Stage D |
@@ -254,4 +126,3 @@ Later changes: **Settings (gear) → Servers & saves**.
254126
---
255127

256128
**Next:** [User Manual](User-Manual) · **Stuck?** [Troubleshooting](Troubleshooting)
257-
>>>>>>> Stashed changes

0 commit comments

Comments
 (0)