Compare commits

...
3 Commits
Author SHA1 Message Date
FaroeGames c476e5c816 Add UI screenshots to docs/screenshots and embed in README showcase
Build and Publish Docker Image / test-and-publish (push) Successful in 6m14s
2026-11-17 16:10:36 -07:00
FaroeGames 488bf34e8e Rewrite READMEs as public showcase documentation with screenshot section 2026-11-17 16:07:04 -07:00
FaroeGames f3fde4ddba Remove harmless duplicate webp MIME entry from nginx.conf 2026-11-17 15:56:05 -07:00
10 changed files with 82 additions and 68 deletions

No files matched your search

+1
View File
@@ -3,6 +3,7 @@
node_modules node_modules
**/tests **/tests
*.xlsx *.xlsx
docs
README.md README.md
**/README.md **/README.md
package.json package.json
+78 -65
View File
@@ -1,88 +1,101 @@
# Professor Oak Challenge Trackers # 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 > **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.
- **`/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.
--- ---
## 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
### Unified Tracker Hub (`/`)
![Professor Oak Challenge Trackers Hub](./docs/screenshots/hub.jpg)
### Omega Ruby & Alpha Sapphire — Route Checklist (`/oras/`)
![ORAS Route Checklist with Exclusive Starter Locking and Sprites](./docs/screenshots/oras-checklist.jpg)
### Luminescent Platinum v2.1 — Live Incense Burner Slot Overrides (`/luminescent-platinum/`)
![Luminescent Platinum Checklist with Inline Incense Burner Rate Overrides](./docs/screenshots/luminescent-incense.jpg)
### Pokédex View & Pokémon Detail / Movedex Modal
![Luminescent Platinum Pokédex View](./docs/screenshots/luminescent-pokedex.jpg)
![Pokémon Inspector Modal with Base Stats, Abilities, Evolution Family, and Movedex](./docs/screenshots/pokedex-modal.jpg)
---
## Running Locally or with Docker
Requires **Node.js 20+** for local development/testing:
```bash ```bash
# Run unified site + ORAS + Luminescent Platinum test suites # Run all test suites (Hub + ORAS + Luminescent Platinum)
npm test 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 npm start
``` ```
--- Or run as a self-contained static container (`nginx:1.27-alpine`, serving on port `28473`):
## 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:
```bash ```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 docker compose up -d --build
``` ```
To update later after pushing changes to Gitea: 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)).
```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`
--- ---
## 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: - **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.
### Way 1 — Unraid Dashboard **"apply update"** Button (via Gitea Container Registry) - **PokeAPI:** Gen VI Pokémon/item sprites and ORAS learnset tables.
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`.
-1
View File
@@ -12,7 +12,6 @@ server {
include /etc/nginx/mime.types; include /etc/nginx/mime.types;
types { types {
application/javascript mjs; application/javascript mjs;
image/webp webp;
} }
gzip on; gzip on;
Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 128 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 129 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 133 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

+2 -1
View File
@@ -8,7 +8,8 @@ Standalone interactive web tracker for **Pokémon Luminescent Platinum v2.1**, m
- **Complete 547 Excel Pokédex (+ Optional 3 Special Forms = 550)**: - **Complete 547 Excel Pokédex (+ Optional 3 Special Forms = 550)**:
- All 105 Sinnoh routes/areas from the workbook with `Morning`, `Day`, `Night`, `Poké Radar`, `Honey Tree`, `Any Incense`, `Any Incense Surf`, `Surf`, `Old/Good/Super Rod`, `Gift`, `Gift Egg`, `Trade`, `Static`, and `Quest` tables. - All 105 Sinnoh routes/areas from the workbook with `Morning`, `Day`, `Night`, `Poké Radar`, `Honey Tree`, `Any Incense`, `Any Incense Surf`, `Surf`, `Old/Good/Super Rod`, `Gift`, `Gift Egg`, `Trade`, `Static`, and `Quest` tables.
- Pre-Badge evolution checklists obey each upcoming Gym Leader's level cap, Luminescent's Lv. 36 trade-evo replacements, held-item stone conversions, Moss Rock / Magnetic Field / Ice Rock / Move Reminder gates, and Solaceon Nursery `Manaphy + Ditto → Phione` breeding. - Pre-Badge evolution checklists obey each upcoming Gym Leader's level cap, Luminescent's Lv. 36 trade-evo replacements, held-item stone conversions, Moss Rock / Magnetic Field / Ice Rock / Move Reminder gates, and Solaceon Nursery `Manaphy + Ditto → Phione` breeding.
- **Jubilife Gift Egg (Only 1)** lets you pick 1 early baby bonus without locking the remaining 17 babies out of later wild/gift routes. - **Jubilife Gift Egg (Only 1)** lets you pick 1 early baby bonus without locking the remaining 17 babies out of later wild/gift routes, and **Route 201** includes an interactive initial **Starter** picker synced to your Rival teams.
- **Incense Burner Toggle** (available in the header, section banners, and inline next to Incense spawns) switches regional spawns ON/OFF and highlights real-time Grass & Surf slot rate overrides.
- **Special Forms (+3)** optional header toggle counts `Crystal Onix`, `Stitched Gengar`, and `Spiky-Eared Pichu` cleanly alongside the base 547 Pokédex. - **Special Forms (+3)** optional header toggle counts `Crystal Onix`, `Stitched Gengar`, and `Spiky-Eared Pichu` cleanly alongside the base 547 Pokédex.
- **Collapsible Route-Level Trainer & Boss Battles**: Includes regular route trainers, rivals (`Barry`, `Dawn`, `Lucas`, `Cedric`), Team Galactic commanders & HQ, `[Team 1–4]` randomized Gym Leader / Elite Four / Cynthia rosters with team-variant switcher pills, Johto Time Portals, Type Masters, and held items / abilities / natures / moves. - **Collapsible Route-Level Trainer & Boss Battles**: Includes regular route trainers, rivals (`Barry`, `Dawn`, `Lucas`, `Cedric`), Team Galactic commanders & HQ, `[Team 1–4]` randomized Gym Leader / Elite Four / Cynthia rosters with team-variant switcher pills, Johto Time Portals, Type Masters, and held items / abilities / natures / moves.
- **Global Caught Sync, Save Profiles & Movedex**: - **Global Caught Sync, Save Profiles & Movedex**:
+1 -1
View File
@@ -10,7 +10,7 @@ A dark-mode web application modeled on the **Luminescent 2.1 Professor Oak Track
- **10 Level-Capped Badge Checkpoints:** Tracks every section from **Pre-Badge 1 (Roxanne · Lv. 14)** through **Pre-Elite Four (Champion Steven · Lv. 59)** and **Post-Game**, scheduling evolutions at the earliest checkpoint whose upcoming Gym Leader / Champion level cap allows them (`≤ Lv. 14`, `16`, `21`, `28`, `30`, `35`, `45`, `46`, `59`, `79`). Includes an optional **Secret Super Training** toggle (off by default) if you prefer skipping 510-EV minigames and waiting for overworld / NPC / Dive Shard stones. - **10 Level-Capped Badge Checkpoints:** Tracks every section from **Pre-Badge 1 (Roxanne · Lv. 14)** through **Pre-Elite Four (Champion Steven · Lv. 59)** and **Post-Game**, scheduling evolutions at the earliest checkpoint whose upcoming Gym Leader / Champion level cap allows them (`≤ Lv. 14`, `16`, `21`, `28`, `30`, `35`, `45`, `46`, `59`, `79`). Includes an optional **Secret Super Training** toggle (off by default) if you prefer skipping 510-EV minigames and waiting for overworld / NPC / Dive Shard stones.
- **Route-Level Collapsible Trainer & Gym Cards:** Expand regular route trainers, Gyms, Rival lineups (adapting to your chosen starter), Team Aqua/Magma raids, Victory Road, Pokémon League, and Delta Episode battles directly under the route header where they take place, with defeated checkboxes. - **Route-Level Collapsible Trainer & Gym Cards:** Expand regular route trainers, Gyms, Rival lineups (adapting to your chosen starter), Team Aqua/Magma raids, Victory Road, Pokémon League, and Delta Episode battles directly under the route header where they take place, with defeated checkboxes.
- **Mutually Exclusive Choices:** All Hoenn starters, Route 111 fossils, and post-game starter gifts appear directly in the checklist—checking one option automatically locks out the alternatives in Strict Solo mode (and unchecking it unlocks them again). Switch **Strict Solo Cartridge / Show All** in the toolbar to view trade evolutions and opposite-version exclusives too. - **Mutually Exclusive Choices:** All Hoenn starters, Route 111 fossils, and post-game starter gifts appear directly in the checklist—checking one option automatically locks out the alternatives in Strict Solo mode (and unchecking it unlocks them again). Switch **Strict Solo Cartridge / Show All** in the toolbar to view trade evolutions and opposite-version exclusives too.
- **Sortable & Searchable Pokédex, ORAS Movedex, External Guides & Sprites:** Sort by `Hoenn #`, `Nat #`, `Name`, `Caught`, `Earliest Milestone`, or `Evolution Method`. Every Pokédex row includes an arrow popup menu linking straight to **Serebii (Gen 6)**, **Bulbapedia**, **Pokémon Database**, and **Smogon**. Clicking any Pokémon opens its Regular & Shiny ORAS sprites, evolution family with evolution item icons, all route locations, and a searchable **ORAS Movedex** (Level-Up, TM/HM, Move Tutor, and Egg moves). - **Sortable & Searchable Pokédex, Gen VI Stats, ORAS Movedex, External Guides & Sprites:** Route checklists display mini sprites and elemental type badges, while the Pokédex table sorts by `Hoenn #`, `Nat #`, `Name`, `Caught`, `Earliest Milestone`, `Base Stats (BST)`, or `Evolution Method`. Every Pokédex row includes an arrow popup menu linking straight to **Serebii (Gen 6)**, **Bulbapedia**, **Pokémon Database**, and **Smogon**. Clicking any Pokémon opens its Regular & Shiny ORAS sprites, **Gen VI Base Stats & Abilities**, evolution family with evolution item icons, all route locations, and a searchable **ORAS Movedex** (Level-Up, TM/HM, Move Tutor, and Egg moves).
- **Zero-Dependency & Offline-Ready:** Built with standard ES modules, CSS, and Node.js built-ins—no npm install required. Sprites and item icons load from [PokeAPI/sprites](https://github.com/PokeAPI/sprites), or automatically from `assets/sprites/` if you download the `sprites/` folder locally. Progress auto-saves to `localStorage` and supports JSON export/import backups. - **Zero-Dependency & Offline-Ready:** Built with standard ES modules, CSS, and Node.js built-ins—no npm install required. Sprites and item icons load from [PokeAPI/sprites](https://github.com/PokeAPI/sprites), or automatically from `assets/sprites/` if you download the `sprites/` folder locally. Progress auto-saves to `localStorage` and supports JSON export/import backups.
## Running Locally ## Running Locally