stardew-tracker/README.md

37 lines
1.4 KiB
Markdown
Raw Normal View History

2026-10-04 19:27:36 +01:00
# Valley Yearbook
A small, shared tracker for the first two years of Stardew Valley. It combines:
- the standard Community Center bundles;
- crop growth times and last safe planting dates;
- birthdays, festivals, seasonal events, and weekly reminders; and
- one server-side checklist that stays in sync across phones and computers.
The app is deliberately dependency-free at runtime: Python's standard library serves the site and stores progress in SQLite. Nginx/Authelia are expected to provide the public access boundary.
## Run locally
```sh
python3 app.py --database /tmp/stardew-progress.sqlite3
```
Then open `http://127.0.0.1:8089`.
## NixOS module
Add this repository as a flake input, import `nixosModules.default`, and enable:
```nix
services.stardew-tracker.enable = true;
```
The service listens on loopback port `8089` by default and stores its SQLite database in `/var/lib/stardew-tracker`.
When proxying through Nginx, protect the complete origin with Authelia and pass its authenticated username as `Remote-User`. Progress is shared by everyone who can access the site; the username is retained only as lightweight update metadata.
## Data scope
The planner targets Stardew Valley 1.6 and standard bundles, not remixed bundles. Calendar and bundle data is based on the [Stardew Valley Wiki](https://stardewvalleywiki.com/Calendar).
Stardew Valley is © ConcernedApe. This is an unofficial fan-made utility and includes no game art or assets.