Rewrite READMEs as public showcase documentation with screenshot section
This commit is contained in:
1 parent
f3fde4ddba
commit
488bf34e8e
3 files changed
+69
-67
No files matched your search
@@ -1,88 +1,89 @@
|
||||
# Professor Oak Challenge Trackers
|
||||
|
||||
Unified web portal hosting two standalone **Professor Oak Challenge** trackers under a shared landing hub:
|
||||
A dark-mode **Professor Oak Challenge (POC)** web tracker hub covering multiple Pokémon games under one site. Built to make multi-section Pokédex planning fast, readable, and easy to track directly in your browser without spreadsheets.
|
||||
|
||||
- **`/`** — Landing hub ([index.html](./index.html)) showing live browser save summaries and launcher cards
|
||||
- **`/oras/`** — Pokémon **Omega Ruby & Alpha Sapphire** tracker ([oras/](./oras/))
|
||||
- **`/luminescent-platinum/`** — Pokémon **Luminescent Platinum (v2.1)** tracker ([luminescent-platinum/](./luminescent-platinum/))
|
||||
|
||||
All progress, save profiles, and toggles persist locally in your browser per game (`poc-tracker:v1:*` for ORAS, `lumi-poc-tracker:v1:*` for Luminescent Platinum), and each tracker has a **← Hub** link in the top header plus **Export Save / Import** JSON backups.
|
||||
> **Browser-First & Private:** All progress, save profiles, and ruleset toggles are stored locally in your browser (`localStorage`), with one-click JSON backup export and import. There is no account system, database, or tracking.
|
||||
|
||||
---
|
||||
|
||||
## Local Development & Tests
|
||||
## Included Trackers
|
||||
|
||||
Requires Node.js 20+ (no external npm packages or build step required):
|
||||
### 1. Pokémon Omega Ruby & Alpha Sapphire (`/oras/`)
|
||||
A full **Nintendo 3DS · Gen VI** Professor Oak Challenge tracker supporting both **Alpha Sapphire** and **Omega Ruby** in one app:
|
||||
|
||||
- **Version Modes & Rulesets:** Switch between **Alpha Sapphire** (`410` Solo POC Pokémon) and **Omega Ruby** (`410` Solo POC Pokémon), or toggle **Show All** (`478` total Pokémon including trade evolutions and version exclusives).
|
||||
- **10 Level-Capped Checkpoints:** Enforces evolutions achievable at or below each upcoming Gym Leader / Champion level cap (`Roxanne Lv. 14` → `Steven Lv. 59` + `Post-Game / Delta Episode`).
|
||||
- **Optional Secret Super Training Toggle:** Off by default—keep stone evolutions in later checkpoints via overworld/NPC stones and Dive Shards, or turn it on if you grind 510-EV Secret Super Training early.
|
||||
- **Interactive Route Checklists:** Displays Pokémon sprites, elemental type pills, encounter rates, level ranges, evolution item icons, mutually exclusive branch locking (Starters, Fossils, Johto/Sinnoh/Unova gifts), and global **Caught** sync across every route and the Pokédex tab.
|
||||
- **Route-Level Trainer & Gym Battles:** Collapsible battle drawers directly beneath each route and Gym, tracking trainer defeats and dynamically adapting Rival teams to your chosen starter.
|
||||
- **Gen VI Pokédex, Stats & Movedex:** Sortable Pokédex table with `BST` / Base Stats, plus a detail inspector showing **Gen VI Base Stats**, **Abilities**, Regular & Shiny ORAS sprites, evolution family, all encounter locations, a searchable **ORAS Movedex** (`Level-Up`, `TM/HM`, `Tutor`, `Egg`, `All`), and external links (`Serebii`, `Bulbapedia`, `Pokémon Database`, `Smogon`).
|
||||
|
||||
### 2. Pokémon Luminescent Platinum v2.1 (`/luminescent-platinum/`)
|
||||
A dedicated tracker tailored to the **Nintendo Switch · BDSP Mod (Luminescent Platinum v2.1)** Pokédex and mechanics:
|
||||
|
||||
- **Complete v2.1 Pokédex (`547` + Optional `+3` Special Forms):** Tracks every catch and evolution across **10 Boss Level-Cap Sections** (`Roark Lv. 16` → `Gardenia Lv. 26` → `Fantina Lv. 33` → `Maylene Lv. 39` → `Wake Lv. 44` → `Byron Lv. 53` → `Candice Lv. 56` → `Volkner Lv. 62` → `Cynthia Lv. 78` → `Post-Game Lv. 100`), with an optional **Special Forms (+3)** toggle for Crystal Onix, Stitched Gengar, and Spiky-Eared Pichu (`550`).
|
||||
- **Live Incense Burner Slot Simulator:** Toggle **Incense Burner** right from the header, section banner, or next to `Any Incense` spawns to activate regional encounters (`Any Incense` / `Any Incense Surf`) and see real-time overwritten spawn rates (`20%` Grass slots 4–5 pushing displaced Pokémon into `1%` slots 10–11, and `30%` Surf slot 1 overrides marked **`Replaced by Incense`**).
|
||||
- **Accurate Chronological Progression:** Includes the **Route 201 Initial Starter Picker**, **Jubilife Trainer School 1-of-18 Mystery Egg Picker** (tracks early bonus picks without locking the remaining 17 babies out of later routes), chronological **Old Rod** backtracks after visiting the Jubilife–Route 218 Gatehouse, and separate backtrack cards for Good Rod, Honey Trees, Surf, and Super Rod.
|
||||
- **Route Trainers & `[Team 1–4]` Boss Variants:** Collapsible battle cards covering regular trainers, Rivals (`Barry`, `Dawn`, `Lucas`, `Cedric`), Team Galactic raids, Johto Time Portals, Type Masters, and randomized `[Team 1–4]` boss lineups with variant filtering.
|
||||
- **Luminescent Base Stats & Movedex:** Sortable Pokédex plus full inspector modal with Luminescent v2.1 stats, custom abilities, Regular & Shiny sprites, full learnsets, and external Pokédex links.
|
||||
|
||||
---
|
||||
|
||||
## Core Site Features
|
||||
|
||||
- **Unified Hub Landing Page (`/`):** Launch either tracker cleanly from [index.html](./index.html), with live client-side detection showing your saved profile progress on each game card and a **`← Hub`** navigation button in every tracker header.
|
||||
- **Independent Multi-Save Profiles:** Run multiple challenge playthroughs per game (Create, Rename, Delete, Reset, Export Save, Import JSON backup).
|
||||
- **Zero-Dependency Stack:** Built with plain HTML, CSS, and Vanilla ES Modules—no frontend bundler, framework runtime, or third-party npm packages required.
|
||||
|
||||
---
|
||||
|
||||
## Project Layout
|
||||
|
||||
```text
|
||||
.
|
||||
├── index.html # Landing hub page (/)
|
||||
├── assets/ # Hub styles & save-badge preview script
|
||||
├── oras/ # Alpha Sapphire & Omega Ruby tracker (/oras/)
|
||||
├── luminescent-platinum/ # Luminescent Platinum v2.1 tracker (/luminescent-platinum/)
|
||||
├── tests/ # Hub server & packaging tests
|
||||
├── docker/nginx.conf # Nginx static server configuration
|
||||
├── Dockerfile # Lightweight Nginx container build
|
||||
├── docker-compose.yml # Container deployment definition
|
||||
└── server.mjs # Local Node.js static server
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Screenshots
|
||||
|
||||
*(You can add screenshots to `docs/screenshots/`—such as `hub.png`, `oras-checklist.png`, `luminescent-incense.png`, and `pokedex-modal.png`—and link them here.)*
|
||||
|
||||
---
|
||||
|
||||
## Running Locally or with Docker
|
||||
|
||||
Requires **Node.js 20+** for local development/testing:
|
||||
|
||||
```bash
|
||||
# Run unified site + ORAS + Luminescent Platinum test suites
|
||||
# Run all test suites (Hub + ORAS + Luminescent Platinum)
|
||||
npm test
|
||||
|
||||
# Serve unified site at http://127.0.0.1:4173
|
||||
# Start unified local server on http://127.0.0.1:4173
|
||||
npm start
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Uploading to Gitea (`git.trevorstocks.ca`)
|
||||
|
||||
This folder is already initialized with Git and ready to push once you create an empty repository on Gitea:
|
||||
Or run as a self-contained static container (`nginx:1.27-alpine`, serving on port `28473`):
|
||||
|
||||
```bash
|
||||
git remote add origin https://git.trevorstocks.ca/<your-username>/<repo-name>.git
|
||||
git push -u origin main
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Hosting in a Standalone Docker Container on Unraid
|
||||
|
||||
The repository includes a lightweight `nginx:1.27-alpine` [Dockerfile](./Dockerfile), [docker/nginx.conf](./docker/nginx.conf), and [docker-compose.yml](./docker-compose.yml) configured cleanly for reverse proxies (`absolute_redirect off`, `.mjs`/`.webp` MIME types, trailing-slash redirects, `/health` probe, running on uncommon high port `28473`).
|
||||
|
||||
### Option A — Build Directly on Unraid (`docker compose`)
|
||||
|
||||
SSH into your Unraid server (e.g., into `/mnt/user/appdata/professor-oak-tracker`):
|
||||
|
||||
```bash
|
||||
git clone https://git.trevorstocks.ca/<your-username>/<repo-name>.git /mnt/user/appdata/professor-oak-tracker
|
||||
cd /mnt/user/appdata/professor-oak-tracker
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
To update later after pushing changes to Gitea:
|
||||
|
||||
```bash
|
||||
cd /mnt/user/appdata/professor-oak-tracker
|
||||
git pull
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
### Option B — Reverse Proxy / Subdomain Setup (Nginx Proxy Manager / SWAG)
|
||||
|
||||
- **Default Compose port:** `28473` on Unraid → container port `28473` (avoids `80`, `443`, `8080`, `8088`)
|
||||
- **Nginx Proxy Manager / SWAG target:**
|
||||
- Scheme: `http` (Nginx Proxy Manager handles HTTPS/SSL termination for your subdomain)
|
||||
- Forward Hostname / IP: your Unraid IP (or `professor-oak-tracker` if both containers share a custom Docker bridge network like `proxynet`)
|
||||
- Forward Port: `28473`
|
||||
Behind a reverse proxy, point your host/subdomain to container port `28473` over `http` (`absolute_redirect off` is already enabled in [docker/nginx.conf](./docker/nginx.conf)).
|
||||
|
||||
---
|
||||
|
||||
## Automatic Updates on Unraid (Instead of Manual `git pull`)
|
||||
## Data Sources & Credits
|
||||
|
||||
Unraid's Docker dashboard **"apply update"** badge only checks **remote Docker registries**—containers built locally with `docker compose up -d --build` will show updates as `not available`. Choose either approach below:
|
||||
|
||||
### Way 1 — Unraid Dashboard **"apply update"** Button (via Gitea Container Registry)
|
||||
|
||||
1. In Gitea (`git.trevorstocks.ca`), make sure **Packages** and **Actions** (with a Docker-capable runner) are enabled.
|
||||
2. Generate a Personal Access Token (**Profile → Settings → Applications → Generate New Token**) with **`package` (`write:package`, `read:package`)** permission, then add it to your repository (**Settings → Actions → Secrets**) as **`REGISTRY_TOKEN`** *(Gitea's built-in `GITEA_TOKEN` usually lacks Container Registry write permission)*.
|
||||
3. Push to `main`: [`.gitea/workflows/docker-publish.yml`](./.gitea/workflows/docker-publish.yml) runs `npm test` and pushes `git.trevorstocks.ca/faroegames/oaktracker:latest`.
|
||||
3. In Gitea's **Packages** tab for `oaktracker`, set the container package visibility to **Public** (or run `docker login git.trevorstocks.ca` once in the Unraid terminal if keeping it private—note Unraid's automatic UI update checker works most reliably with public HTTPS packages; private custom registries may require clicking **Force Update** or using Watchtower).
|
||||
4. On Unraid, add the container in **Docker → Add Container** (rather than Compose) with:
|
||||
- **Name:** `professor-oak-tracker`
|
||||
- **Repository:** `git.trevorstocks.ca/faroegames/oaktracker:latest`
|
||||
- **Port:** Container `28473` → Host `28473`
|
||||
- Now Unraid detects new pushes in its Docker tab (or Watchtower can auto-update it).
|
||||
|
||||
### Way 2 — Hands-Free Auto-Rebuild via Unraid **User Scripts** (Zero Gitea Runner Needed)
|
||||
|
||||
If you don't run a Gitea Actions Runner, keep building locally with `docker compose` and add [`scripts/unraid-git-update.sh`](./scripts/unraid-git-update.sh) to Unraid's **User Scripts** plugin on a schedule (e.g., `*/15 * * * *`). It checks `git fetch origin main` and only rebuilds/restarts when a new commit is pushed to `git.trevorstocks.ca`.
|
||||
- **Team Luminescent:** Pokémon Luminescent Platinum v2.0/v2.1 Pokédex data, encounter tables, trainer teams, move learnsets, and sprites.
|
||||
- **Serebii.net:** Pokémon ORAS Pokéarth encounter data and Gen VI `pokedex-xy` base stats & abilities.
|
||||
- **PokeAPI:** Gen VI Pokémon/item sprites and ORAS learnset tables.
|
||||
Reference in new issue
Block a user