Skip to content

Add a /changelog/ page and version PixFray from package.json #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Finesssee merged 1 commit into from
Oct 20, 2026
Merged

Add a /changelog/ page and version PixFray from package.json #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion DESIGN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# PixFray design

Applies to every page PixFray renders: the home page tour (`/`), the picker (`/play/`), a channel's fighter page
(`/?channel=`), `/start/`, the mod page (`/admin/`), the owner page, the not-found page and the OBS overlay.
(`/?channel=`), `/start/`, `/changelog/`, the mod page (`/admin/`), the owner page, the not-found page and the OBS overlay.
The look is a **night arena tavern**: warm near-black wood, one gold trim accent, Fraunces headings, and the 3D
arena scene behind the page. Everything here is already built in `public/dashboard.css` (pages) and
`src/intro/intro.css` (home page); this file says how to use it. Read it before changing any page.
Expand All @@ -14,6 +14,7 @@ Write one line for yourself before laying anything out: who opens this page and
|---|---|---|
| `/` | A viewer or streamer who heard of PixFray: learn what it is | The 3D tour and one way in |
| `/play/` | A viewer: find the stream they watch | "Which stream are you watching?", the search, the channel rows |
| `/changelog/` | A viewer or streamer: see what changed and when | The current version, then releases newest first |
| `/?channel=` | A viewer: build their fighter and save it | The 3D fighter stage, the character grid, **Save profile** |
| `/start/` | A streamer: set PixFray up | The headline, **Sign in with Twitch**, the live overlay demo |
| `/admin/` | A mod or the broadcaster: run duels live | The live state, Pause duels, the setup checklist |
Expand Down
2 changes: 1 addition & 1 deletion admin/dev/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ <h3>Integrations and what each one needs</h3>
</main>
<footer class="site-foot"><div class="site-foot-inner">
<a class="foot-brand" href="/"><svg class="mark" viewBox="0 0 20 20" aria-hidden="true"><path d="M2 2h6v6H2zM12 2h6v6h-6zM7 7h6v6H7zM2 12h6v6H2zM12 12h6v6h-6z"/></svg>PixFray</a>
<nav aria-label="More"><a href="/">See a duel</a><a href="/play/">Pick a channel</a><a href="/start/">For streamers</a></nav>
<nav aria-label="More"><a href="/">See a duel</a><a href="/play/">Pick a channel</a><a href="/start/">For streamers</a><a href="/changelog/">Changelog</a></nav>
<p>Duels for Twitch chat. Your fighter is saved per channel, and signing in shares only your public Twitch name.</p>
</div></footer>
<script type="module" src="/src/dev.ts"></script>
Expand Down
2 changes: 1 addition & 1 deletion admin/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ <h2 id="power-title">Turn PixFray off</h2>
</main>
<footer class="site-foot"><div class="site-foot-inner">
<a class="foot-brand" href="/"><svg class="mark" viewBox="0 0 20 20" aria-hidden="true"><path d="M2 2h6v6H2zM12 2h6v6h-6zM7 7h6v6H7zM2 12h6v6H2zM12 12h6v6h-6z"/></svg>PixFray</a>
<nav aria-label="More"><a href="/">See a duel</a><a href="/play/">Pick a channel</a><a href="/start/">For streamers</a></nav>
<nav aria-label="More"><a href="/">See a duel</a><a href="/play/">Pick a channel</a><a href="/start/">For streamers</a><a href="/changelog/">Changelog</a></nav>
<p>Duels for Twitch chat. Your fighter is saved per channel, and signing in shares only your public Twitch name.</p>
</div></footer>
<script type="module" src="/src/admin.ts"></script>
Expand Down
174 changes: 174 additions & 0 deletions changelog/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
<!doctype html>
<html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width,initial-scale=1">
<title>What's new in PixFray · Changelog</title>
<meta name="description" content="Every PixFray release, newest first: new duel features, fighter upgrades, bot commands and fixes.">
<meta name="theme-color" content="#17110c">
<link rel="icon" href="/favicon.svg" type="image/svg+xml"><link rel="icon" href="/favicon.ico" sizes="16x16 32x32 48x48"><link rel="apple-touch-icon" href="/apple-touch-icon.png">
<link rel="preload" href="/assets/fonts/fraunces-latin.woff2" as="font" type="font/woff2" crossorigin>
<link rel="stylesheet" href="/dashboard.css" data-design></head>
<body>
<header class="topbar"><div class="topbar-inner">
<a class="brand" href="/"><svg class="mark" viewBox="0 0 20 20" aria-hidden="true"><path d="M2 2h6v6H2zM12 2h6v6h-6zM7 7h6v6H7zM2 12h6v6H2zM12 12h6v6h-6z"/></svg>PixFray</a>
<nav aria-label="Pages"><a href="/">See a duel</a><a href="/start/">For streamers</a><a class="nav-cta" href="/play/">Pick your fighter</a></nav>
</div></header>

<!-- Releases go newest first. Each one is a <section class="release" id="v<version>"> with an h2 holding the version
and name and a <time datetime>; the newest version equals package.json "version" (tests/changelog.test.ts). -->
<main class="page">
<header class="page-header">
<h1>What's new in PixFray</h1>
<p class="subtitle">Every release, newest first. PixFray is on version <span class="num" id="current-version">0.8.0</span>.</p>
</header>

<div class="with-index changelog">
<nav class="page-index" aria-label="Releases"><ol>
<li><a href="#v0.8.0">0.8.0 Channel point rewards</a></li>
<li><a href="#v0.7.1">0.7.1 Steadier rooms</a></li>
<li><a href="#v0.7.0">0.7.0 Deeper fighter stats</a></li>
<li><a href="#v0.6.2">0.6.2 Under the hood</a></li>
<li><a href="#v0.6.1">0.6.1 Ranks and backups</a></li>
<li><a href="#v0.6.0">0.6.0 Viewer sprites and bot controls</a></li>
<li><a href="#v0.5.0">0.5.0 Open sign-up and the PixFray bot</a></li>
<li><a href="#v0.4.0">0.4.0 PixFray</a></li>
<li><a href="#v0.3.0">0.3.0 Rematches and progression</a></li>
<li><a href="#v0.2.0">0.2.0 Upgrades and more fighters</a></li>
<li><a href="#v0.1.0">0.1.0 First duels</a></li>
</ol></nav>

<div>
<section class="release" id="v0.8.0" aria-labelledby="v0.8.0-title">
<h2 id="v0.8.0-title"><span class="num">0.8.0</span> Channel point rewards</h2>
<p class="meta"><time datetime="2026-10-20">20 October 2026</time></p>
<ul>
<li><span class="badge">New</span> Channel point rewards that add PixFray dollars to the redeemer's fighter, up to 5 per channel. The bot confirms each one in chat with the new wallet total. Setting them up from the mod page comes in a later release.</li>
<li><span class="badge">New</span> A viewer who redeems without a saved fighter gets their points back. A repeated delivery from Twitch never pays twice.</li>
<li><span class="badge">New</span> This changelog page.</li>
<li><span class="badge">Under the hood</span> Duel, alarm and chat logs and daily room counters, so problems are easier to trace.</li>
</ul>
</section>

<section class="release" id="v0.7.1" aria-labelledby="v0.7.1-title">
<h2 id="v0.7.1-title"><span class="num">0.7.1</span> Steadier rooms</h2>
<p class="meta"><time datetime="2026-10-16">16 October 2026</time></p>
<ul>
<li><span class="badge">Fixed</span> An expired rematch no longer keeps a channel's room waking up over and over.</li>
</ul>
</section>

<section class="release" id="v0.7.0" aria-labelledby="v0.7.0-title">
<h2 id="v0.7.0-title"><span class="num">0.7.0</span> Deeper fighter stats</h2>
<p class="meta"><time datetime="2026-10-15">15 October 2026</time></p>
<ul>
<li><span class="badge">New</span> Upgrade points have no cap. Each level costs more, every stat has a ceiling, and presets spend points for you.</li>
<li><span class="badge">New</span> Crit, dodge and counter stats, plus vitality.</li>
<li><span class="badge">New</span> Legendary stat rolls with one free reroll, and <code>!stats</code> to see your fighter's numbers in chat.</li>
<li><span class="badge">New</span> Turning a picture into a sprite works without AI: PixFray finds the subject and drops the background.</li>
<li><span class="badge">Changed</span> Duels are ranked only while the stream is live. Streamers can also limit how often the same two fighters duel in one stream.</li>
<li><span class="badge">Fixed</span> The bot no longer stalls on an unreadable shop answer.</li>
</ul>
</section>

<section class="release" id="v0.6.2" aria-labelledby="v0.6.2-title">
<h2 id="v0.6.2-title"><span class="num">0.6.2</span> Under the hood</h2>
<p class="meta"><time datetime="2026-10-12">12 October 2026</time></p>
<ul>
<li><span class="badge">Under the hood</span> All of PixFray now runs on strict TypeScript, and everything it receives is checked before use.</li>
<li><span class="badge">Fixed</span> A stray empty slot after full build slots, and the mod page on a channel without an arena.</li>
</ul>
</section>

<section class="release" id="v0.6.1" aria-labelledby="v0.6.1-title">
<h2 id="v0.6.1-title"><span class="num">0.6.1</span> Ranks and backups</h2>
<p class="meta"><time datetime="2026-10-09">9 October 2026</time></p>
<ul>
<li><span class="badge">Fixed</span> Saving your fighter keeps your rank.</li>
<li><span class="badge">Fixed</span> The <code>!fray</code> link opens your channel instead of the channel picker.</li>
<li><span class="badge">New</span> Every channel is backed up daily and kept for 90 days, and a lost rank can be restored.</li>
</ul>
</section>

<section class="release" id="v0.6.0" aria-labelledby="v0.6.0-title">
<h2 id="v0.6.0-title"><span class="num">0.6.0</span> Viewer sprites and bot controls</h2>
<p class="meta"><time datetime="2026-10-07">7 October 2026</time></p>
<ul>
<li><span class="badge">New</span> Turn any picture into a pixel fighter, with an optional AI redraw. Mods review each one before it goes on stream.</li>
<li><span class="badge">New</span> <code>!fray off</code> and <code>!fray on</code> silence or wake the bot in a channel.</li>
<li><span class="badge">New</span> Mods add the bot's own text commands, with counters, and can turn on a timed <code>!fray</code> reminder.</li>
<li><span class="badge">New</span> <code>!give</code> sends dollars (<code>!pay</code> still works), and an unanswered challenge gets an expiry line.</li>
<li><span class="badge">Changed</span> The bot names the duel winner in chat, and the overlay no longer shows a winner banner.</li>
<li><span class="badge">Changed</span> Duels show 2D hit effects: glow, sparks, shake and a knockout push-in. The overlay option <code>fx=off</code> turns them off, and <code>bubbles=0</code> hides chat bubbles.</li>
<li><span class="badge">Changed</span> Duels with a brand-new Twitch account are unrated, and the same two fighters have a daily ranked limit.</li>
<li><span class="badge">Changed</span> The home page is the 3D tour, and the channel picker moved to <a href="/play/">/play/</a>.</li>
<li><span class="badge">Fixed</span> Lead moderators count as mods, and a fighter changed on the website updates on stream.</li>
</ul>
</section>

<section class="release" id="v0.5.0" aria-labelledby="v0.5.0-title">
<h2 id="v0.5.0-title"><span class="num">0.5.0</span> Open sign-up and the PixFray bot</h2>
<p class="meta"><time datetime="2026-10-06">6 October 2026</time></p>
<ul>
<li><span class="badge">New</span> Any streamer can turn PixFray on from <a href="/start/">/start/</a>, with no invite.</li>
<li><span class="badge">New</span> The PixFray bot answers duel commands in chat, so streamers need no other chat bot.</li>
<li><span class="badge">New</span> Search the channel picker for any channel running PixFray.</li>
<li><span class="badge">New</span> Mods can try <code>!checkin</code> for 15 minutes while offline.</li>
<li><span class="badge">New</span> Anyone can run their own copy of PixFray from one config file.</li>
<li><span class="badge">Changed</span> Shop prices cut to about a third.</li>
</ul>
</section>

<section class="release" id="v0.4.0" aria-labelledby="v0.4.0-title">
<h2 id="v0.4.0-title"><span class="num">0.4.0</span> PixFray</h2>
<p class="meta"><time datetime="2026-10-05">5 October 2026</time></p>
<ul>
<li><span class="badge">Changed</span> Mini Chat is now PixFray, and the help command is <code>!fray</code>.</li>
<li><span class="badge">New</span> Build slots and cosmetics, on a fighter page with tabs for the shop, Ranks and Rules.</li>
<li><span class="badge">New</span> A 3D preview of your fighter, and a 3D tour of how a duel plays out.</li>
<li><span class="badge">New</span> <code>!look</code> links straight to picking or changing your fighter.</li>
<li><span class="badge">Changed</span> Every page redesigned as a night arena.</li>
</ul>
</section>

<section class="release" id="v0.3.0" aria-labelledby="v0.3.0-title">
<h2 id="v0.3.0-title"><span class="num">0.3.0</span> Rematches and progression</h2>
<p class="meta"><time datetime="2026-10-04">4 October 2026</time></p>
<ul>
<li><span class="badge">New</span> <code>!rematch</code> challenges your last opponent.</li>
<li><span class="badge">New</span> <code>!checkin</code> and stream streaks.</li>
<li><span class="badge">New</span> Dollars, with <code>!wallet</code>, <code>!pay</code> and gifts from mods.</li>
<li><span class="badge">New</span> Pets and the shop.</li>
<li><span class="badge">Changed</span> Duel results stay out of chat until the stream has shown them.</li>
</ul>
</section>

<section class="release" id="v0.2.0" aria-labelledby="v0.2.0-title">
<h2 id="v0.2.0-title"><span class="num">0.2.0</span> Upgrades and more fighters</h2>
<p class="meta"><time datetime="2026-10-02">2 October 2026</time></p>
<ul>
<li><span class="badge">New</span> Upgrades earned from wins (power, guard and luck) and hats to earn.</li>
<li><span class="badge">New</span> 56 built-in characters, and up to 24 uploaded characters per channel.</li>
<li><span class="badge">New</span> <code>!top</code> and <code>!elo</code>, and a limit on how many fighters show on stream.</li>
<li><span class="badge">New</span> Streamer sign-up, with a setup checklist that ticks off each step as it starts working.</li>
<li><span class="badge">New</span> Optional duel announcements on the overlay.</li>
</ul>
</section>

<section class="release" id="v0.1.0" aria-labelledby="v0.1.0-title">
<h2 id="v0.1.0-title"><span class="num">0.1.0</span> First duels</h2>
<p class="meta"><time datetime="2026-10-01">1 October 2026</time></p>
<ul>
<li><span class="badge">New</span> Chatters walk on stream as pixel fighters through an OBS overlay.</li>
<li><span class="badge">New</span> Duels with <code>!challenge @name</code> and <code>!fight</code>, settled by alternating d6 rolls with crits.</li>
<li><span class="badge">New</span> Elo, wins and losses saved for every fighter.</li>
<li><span class="badge">New</span> The overlay replays each duel: the fighters meet, HP bars drop with each roll, and the loser is knocked out.</li>
<li><span class="badge">New</span> A fighter page for viewers and duel controls for mods.</li>
</ul>
</section>
</div>
</div>
</main>
<footer class="site-foot"><div class="site-foot-inner">
<a class="foot-brand" href="/"><svg class="mark" viewBox="0 0 20 20" aria-hidden="true"><path d="M2 2h6v6H2zM12 2h6v6h-6zM7 7h6v6H7zM2 12h6v6H2zM12 12h6v6h-6z"/></svg>PixFray</a>
<nav aria-label="More"><a href="/">See a duel</a><a href="/play/">Pick a channel</a><a href="/start/">For streamers</a><a href="/changelog/" aria-current="page">Changelog</a></nav>
<p>Duels for Twitch chat. Your fighter is saved per channel, and signing in shares only your public Twitch name.</p>
</div></footer>
</body></html>
2 changes: 2 additions & 0 deletions cloudflare.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ export default defineConfig(({ mode }) => {
"/start/*",
"/play",
"/play/*",
"/changelog",
"/changelog/*",
"/intro",
"/intro/*",
"/robots.txt",
Expand Down
6 changes: 4 additions & 2 deletions docs/CONTRACTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@ fighter (saving and buying stay closed).
## 2. HTTP routes

Pages (server/worker.ts `page()`): `/` is the intro (intro/index.html); `/?channel=x` is that channel's fighter page;
`/play/` is the channel picker (`/play/?channel=x` moves to `/?channel=x`, `/play` to `/play/`); `/intro/` moves to `/` (301).
`/play/` is the channel picker (`/play/?channel=x` moves to `/?channel=x`, `/play` to `/play/`); `/changelog/` is the release notes
(changelog/index.html, static; its newest release must equal `package.json` `version`, checked by tests/changelog.test.ts);
`/intro/` moves to `/` (301).
`/admin/` without `?channel=` sends a signed-in streamer whose own channel is set up (on or turned off) and who can manage
it to `/admin/?channel=<their login>` (302); anyone else
gets the page, which offers sign-in or `/start`. The intro's main buttons say "Back to <channel>" when the fighter page
Expand All @@ -70,7 +72,7 @@ everything else is revalidated.
| GET | `/api/session` | optional | none | `{user:{id,login,displayName}\|null, owner, configured, channels:["nesszerra","miolafff"] (the built-ins), productionEnabled:false}`. `productionEnabled` is a constant `false` left from the first rollout, when production stayed closed until the broadcaster was onboarded. Nothing reads it; use `channelState` instead. | 503 when secrets are missing |
| GET | `/api/channels` | none | none | `{channels:[login,...], defaultChannel}` (`defaultChannel` is what a URL without `?channel=` falls back to; the overlay uses it): the built-ins first, then the enabled (not paused) registry channels in sign-up order. Cached 60 s per isolate. The picker at `/play/` (the viewer page without `?channel=`) shows "Which stream are you watching?" with one button per channel; every link the site, sign-in and `!fray` hand out carries `?channel=` so a fighter is never saved to the wrong channel by default. Bot lines never put punctuation right after a link (Twitch chat takes it into the link), and the pages drop characters a login can't hold from the end of `?channel=` and show the clean address (`channelParam` in src/channel-param.ts), so `?channel=miolafff,` still opens miolafff | |
| GET | `/api/picker` | none | none | `{channels:[{login, top:[{displayName, username, elo, avatar}], catalog?}], catalog}`: the `/play/` picker in one request. Same channels and order as `/api/channels`; `top` is up to three fighters with at least one ranked duel, `catalog` per channel lists only the uploaded looks they wear, and the top-level `catalog` is the built-in list. Cached 60 s per isolate. | |
| GET | `/robots.txt`, `/sitemap.xml` | none | none | robots: `Disallow: /api/` and `/auth/` on the production host, `Disallow: /` on the staging and test hosts. sitemap: production host only, lists `/`, `/play/`, `/start/`; 404 elsewhere | |
| GET | `/robots.txt`, `/sitemap.xml` | none | none | robots: `Disallow: /api/` and `/auth/` on the production host, `Disallow: /` on the staging and test hosts. sitemap: production host only, lists `/`, `/play/`, `/start/`, `/changelog/`; 404 elsewhere | |
| POST (GET for export) | `/api/devtools/:channel/profile\|chat\|live\|shop\|export` | dev token (test site only) | as the matching site route; see docs/DEVTOOLS.md | the same room call as the matching site route; `export` returns the raw room tables | 400 `invalid_body` (`text`, `userId`, `username`, `displayName`, `live` or `streamId` of the wrong type), 400 `{error:"Invalid profile fields"}` (a profile field of the wrong type), 401 without the token (an owner session gets 404), 403 channel off |
| GET | `/api/health` | none | none | `{ok:true}`; nothing else, so the public answer reveals no version or configuration (the owner's `/api/dev/diagnostics` has `worker.version` and `twitchConfigured`) | 503 `{ok:false}` when secrets are missing |
| GET | `/api/access/:channel` | optional | none | `{owner, broadcaster, moderator, canManage, reason}` | 403 for a channel that isn't set up |
Expand Down
Loading
Loading