|
| 1 | +SV Progress Tracker |
| 2 | + |
| 3 | +Track your Stardew Valley progress locally in your browser by dropping in your save file. No data leaves your device. |
| 4 | + |
| 5 | +What it does |
| 6 | + |
| 7 | +- Parses your Stardew Valley save file (XML) fully in the browser |
| 8 | +- Shows clean, visual progress for: |
| 9 | + - Skills and XP toward the next level |
| 10 | + - Cooking recipes known and cooked counts |
| 11 | + - Crafting recipes made |
| 12 | + - Crops shipped (Monoculture/Polyculture helpers) |
| 13 | + - Fish caught |
| 14 | + - Friendship levels and heart progress for dateable NPCs |
| 15 | + - Monsters killed by category (Adventurer's Guild) |
| 16 | + - Items shipped and total money earned |
| 17 | + - Museum collection (artifacts and minerals) with found vs. donated |
| 18 | +- Supports single player and farmhands; view each player via tabs |
| 19 | + |
| 20 | +How it works (privacy-first) |
| 21 | + |
| 22 | +- Runs entirely client-side (React + Vite); your save file is parsed with fast-xml-parser in your browser |
| 23 | +- No uploads, no servers, no storage by default |
| 24 | + |
| 25 | +How to use |
| 26 | + |
| 27 | +1) Open the app: https://thecoderaccoons.github.io/svprogresstracker |
| 28 | +2) Drag-and-drop your save file into the drop area, or click to choose the file |
| 29 | +3) Switch between tabs to view Skills, Achievements, and more for each player/farmhand |
| 30 | + |
| 31 | +Where to find your save file |
| 32 | + |
| 33 | +- Windows: C:\Users\YourUser\AppData\Roaming\StardewValley\Saves\<FarmName>_######## |
| 34 | +- macOS: ~/Library/Application Support/StardewValley/Saves/<FarmName>_######## |
| 35 | +- Linux: ~/.config/StardewValley/Saves/<FarmName>_######## |
| 36 | + |
| 37 | +Note: Drop the file named the same as your farm (without the folder extension) e.g., FarmName_123456789. |
| 38 | + |
| 39 | +Current status and roadmap |
| 40 | + |
| 41 | +- Implemented: Skills, Cooking, Crafting, Crops, Fishing, Friendship, Monsters, Shipping, Money, Museum |
| 42 | +- In progress / planned: Quests, Special Orders summaries, Grandpa's Evaluation view |
| 43 | + |
| 44 | +Tech stack |
| 45 | + |
| 46 | +- React 19 + TypeScript, Vite 6 |
| 47 | +- fast-xml-parser for XML → JSON |
| 48 | +- React Tabs for UI navigation |
| 49 | + |
| 50 | +Local development |
| 51 | + |
| 52 | +- Install dependencies: npm ci |
| 53 | +- Run dev server: npm run dev |
| 54 | +- Build for production: npm run build (outputs to build/) |
| 55 | + |
| 56 | +Deployment (via GitHub Releases → GitHub Pages) |
| 57 | + |
| 58 | +This repo deploys to GitHub Pages when a Release is published. |
| 59 | + |
| 60 | +- Workflow file: .github/workflows/release-pages.yml |
| 61 | +- Trigger: release published |
| 62 | +- Build: Vite builds to build/ |
| 63 | +- Deploy: Official Pages actions publish the artifact |
| 64 | + |
| 65 | +First-time GitHub setup |
| 66 | + |
| 67 | +1) Push the workflow to the default branch |
| 68 | +2) Create a Release (e.g., v1.0.0). The workflow builds and deploys |
| 69 | +3) In Settings → Pages, set Build and deployment to GitHub Actions |
| 70 | + |
| 71 | +Live URL |
| 72 | + |
| 73 | +https://thecoderaccoons.github.io/svprogresstracker |
| 74 | + |
| 75 | +Notes |
| 76 | + |
| 77 | +- Vite base is set to /svprogresstracker/ in vite.config.js so assets resolve at the repo subpath |
| 78 | +- A legacy npm run deploy (gh-pages) script exists, but CI via Releases is recommended |
| 79 | + |
| 80 | +Credits |
| 81 | + |
| 82 | +- Code: TheCodeRaccoons |
| 83 | +- Design and non-Stardew assets: Ookamijime |
| 84 | +- Stardew Valley assets © ConcernedApe |
1 | 85 |
|
0 commit comments