plugins/minesweeper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

difficulty and replay panels in the left column

Browse Source 
Top panel: Expert / Intermediate / Beginner. Bottom: that difficulty's saved
games, best first, click to play one on the board.

── the selection lives in the URL ──

`/minesweeper/expert`, not a channel and not panel state. It survives a
refresh, it can be linked, and the two panels never pass anything between
themselves — both read `useParams`. The plugin section route already existed;
nothing had used it.

The side effect hangs off the URL too: an effect on the selected level posts
the difficulty, so arriving at `/minesweeper/expert` by click, deep link or
back button all leave the game on expert. `POST /difficulty` verifies and is
idempotent, so a repeat changes nothing. One `<Navigate replace>` after the
hooks canonicalises both the bare route and a bogus section, and it waits for
`/status` so the URL lands on what the game IS rather than a guess — which is
why `difficulty` is now part of that payload.

Levels are NavLinks so cmd-click works and the active style comes from the
router. Replay rows are buttons, because they do not navigate anywhere, they
make the game do something. That is the line navigation-audit.md draws.

── two things on the server ──

`GET /replays` reads the directory rather than any index, because the filename
IS the metadata — Minesweeper X names a recording `<Lvl> <secs> - <date>.mvr`
and keeps no catalogue. A name that does not parse is skipped rather than
guessed at. Ordering is the server's: a loss is never "best" however short it
was, so wins rank by time and losses fall to the end, still watchable.

`POST /replay` drives Extras > Play Recording... and TYPES the filename into a
file dialog, which is why it only accepts a name `isKnownReplay` just matched
against the directory. An unchecked client string reaching `xdotool type` can
carry a path, a wildcard, or a newline that submits something else. Verified by
the dialog closing, not by the window size — a beginner replay leaves the
window beginner-sized, which is also what nothing-happened looks like.

Verified end to end against the running session: the expert list comes back
ranked 58.63 through 82.06 with losses after, playing 58.63 starts on the
board, and `{"file":"../../../etc/passwd"}` is a 404.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Officer-Session: de3ed4e6-f88a-429c-94e6-a760336ba83b
This commit is contained in:
pastilhas
2026-08-23 23:23:44 +00:00
co-authored by Claude Opus 5
parent b94c1a6557
commit 5d62668883
8 changed files with 343 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
web/LevelsPanel.tsx
+75
View File
@@ -0,0 +1,75 @@
import { useEffect, useRef } from 'react';
import { useQuery } from '@tanstack/react-query';
import { Navigate, NavLink, useParams } from 'react-router';
import { toast } from 'sonner';
import { useClient } from 'hooks/useClient';
import { LEVELS, isLevel, type Level } from './levels';
/**
* The difficulty list — and the URL is what holds the choice.
*
* `/minesweeper/expert` rather than a channel or panel state, because it is exactly the kind of thing
* `docs/navigation-audit.md` calls addressable: it survives a refresh, it can be linked, and the replay
* panel reads it from the URL instead of having it passed across. Rows are real `NavLink`s, so cmd-click
* and middle-click behave and the active style comes from the router rather than a hand-rolled compare.
*
* The SIDE EFFECT hangs off the URL too. An effect on the selected level posts the difficulty, so
* arriving at `/minesweeper/expert` by any route — click, deep link, back button — leaves the game on
* expert. `POST /difficulty` verifies and is idempotent, so a repeat costs a round trip and changes
* nothing.
*/
export const LevelsPanel = () => {
const { section } = useParams();
const client = useClient();
// useClient() returns fresh verbs every render; a ref keeps the effect below from re-running forever.
const clientRef = useRef(client);
clientRef.current = client;
const selected = isLevel(section) ? section : null;
const { data: status } = useQuery({
queryKey: ['minesweeper', 'status'],
queryFn: () => client.get<{ difficulty: Level | null; running: boolean }>('/minesweeper/status'),
});
useEffect(() => {
if (!selected) return;
clientRef.current
.post('/minesweeper/difficulty', { level: selected })
.catch(() => toast.error(`Could not switch the game to ${selected}.`));
}, [selected]);
// After the hooks, never before: one guard canonicalising both the bare route and a bogus section.
// It waits for status so the URL lands on what the game IS rather than on a guess.
if (!selected) {
if (!status) return <Shell />;
return <Navigate to={`/minesweeper/${status.difficulty ?? 'beginner'}`} replace />;
}
return (
<Shell>
{LEVELS.map((level) => (
<NavLink
key={level.key}
to={`/minesweeper/${level.key}`}
// Re-asserting the level it is already on is the point: a replay leaves the board at the
// replay's size, and clicking the current level is the obvious way back.
onClick={() => {
if (level.key === selected) void clientRef.current.post('/minesweeper/difficulty', { level: level.key });
}}
className={({ isActive }) =>
`rounded-md px-3 py-2 text-sm transition-colors ${
isActive ? 'bg-accent font-medium text-accent-foreground' : 'text-muted-foreground hover:bg-accent/50'
}`
}
>
{level.label}
</NavLink>
))}
</Shell>
);
};
const Shell = ({ children }: { children?: React.ReactNode }) => (
<div className="flex size-full flex-col gap-1 p-2">{children}</div>
);
web/ReplaysPanel.tsx
+81
View File
@@ -0,0 +1,81 @@
import { useMutation, useQuery } from '@tanstack/react-query';
import { Loader2, Play, Trophy } from 'lucide-react';
import { useParams } from 'react-router';
import { toast } from 'sonner';
import { useClient } from 'hooks/useClient';
import { isLevel, type Replay } from './levels';
/**
* The saved games for whichever difficulty the URL names, best first.
*
* Rows are BUTTONS, not links, and that is a rule rather than a preference: a row here does not navigate
* anywhere, it makes the game do something. `docs/navigation-audit.md` draws exactly that line — a control
* that mutates stays a button, and only one that opens an addressable thing is an anchor. Which difficulty
* is showing IS addressable, and that is the panel next door.
*
* Ordering comes from the server, which is where it belongs: a loss is never "best" however short it was,
* so wins rank by time and losses fall to the end. Re-sorting here would be a second place to disagree.
*/
export const ReplaysPanel = () => {
const { section } = useParams();
const client = useClient();
const level = isLevel(section) ? section : null;
const { data, isLoading } = useQuery({
queryKey: ['minesweeper', 'replays', level],
queryFn: () => client.get<{ replays: Replay[] }>(`/minesweeper/replays?level=${level}`),
enabled: !!level,
});
const play = useMutation({
mutationFn: (file: string) => client.post('/minesweeper/replay', { file }),
onError: () => toast.error('The game would not open that recording.'),
});
const replays = data?.replays ?? [];
return (
<div className="flex size-full flex-col overflow-hidden">
<div className="px-3 py-2 text-xs font-medium text-muted-foreground">
{level ? `${replays.length} saved ${replays.length === 1 ? "game" : "games"}` : "Replays"}
</div>
<div className="min-h-0 flex-1 overflow-y-auto px-2 pb-2">
{isLoading ? (
<p className="px-1 py-2 text-xs text-muted-foreground">Loading…</p>
) : replays.length === 0 ? (
<p className="px-1 py-2 text-xs text-muted-foreground">No recordings for this level yet.</p>
) : (
replays.map((replay, index) => {
const pending = play.isPending && play.variables === replay.file;
return (
<button
key={replay.file}
type="button"
onClick={() => play.mutate(replay.file)}
disabled={play.isPending}
className="group flex w-full items-center gap-2 rounded-md px-2 py-1.5 text-left transition-colors hover:bg-accent/50 disabled:opacity-60"
>
{pending ? (
<Loader2 className="size-3.5 shrink-0 animate-spin text-muted-foreground" />
) : (
<Play className="size-3.5 shrink-0 text-muted-foreground opacity-0 transition-opacity group-hover:opacity-100" />
)}
{/* A rank only means anything while the list is ranked, so losses do not get one. */}
<span className="w-4 shrink-0 text-right text-xs tabular-nums text-muted-foreground">
{replay.lost ? "" : index + 1}
</span>
<span className={`shrink-0 text-sm tabular-nums ${replay.lost ? "text-muted-foreground" : ""}`}>
{replay.time.toFixed(2)}s
</span>
{index === 0 && !replay.lost ? <Trophy className="size-3.5 shrink-0 text-amber-500" /> : null}
{replay.lost ? <span className="shrink-0 text-[10px] text-muted-foreground">lost</span> : null}
<span className="ml-auto truncate text-[11px] text-muted-foreground">{replay.played}</span>
</button>
);
})
)}
</div>
</div>
);
};
web/layout.ts
+7 -7
View File
@@ -3,11 +3,11 @@ import type { LayoutNode } from 'officerdev';
// Two panels stacked on the left, the game on the right — the same arrangement Atelier uses, and the one
// the rest of the app reads as "controls beside a surface".
//
// The left column is EMPTY on purpose. `appType: null` is a state of the framework rather than a missing
// app, and `normalizeLayout` allows it explicitly, so these survive the plugin's own allow-list instead of
// being rewritten to the fallback — which on a one-panel plugin would have rendered three Minesweepers.
// The screen is `locked`, so an empty panel here is a plain bordered box with no app picker. That is the
// intended look until something goes in them.
// Difficulty on top, that difficulty's saved games below. 30/70 because the top panel holds exactly three
// rows and the bottom one is a list that wants the room.
//
// Which difficulty is selected lives in the URL (`/minesweeper/expert`), not here and not in a channel, so
// the two panels never pass it between themselves — they both read `useParams`.
//
// The game panel keeps the id `minesweeper` it had when this was a single panel, so any per-panel state
// already keyed on it survives the change.
@@ -22,8 +22,8 @@ export const defaultLayout: LayoutNode = {
id: 'minesweeper-side',
direction: 'vertical',
children: [
{ node: { type: 'panel', id: 'minesweeper-side-top', appType: null }, size: 50 },
{ node: { type: 'panel', id: 'minesweeper-side-bottom', appType: null }, size: 50 },
{ node: { type: 'panel', id: 'minesweeper-side-top', appType: 'minesweeper-levels' }, size: 30 },
{ node: { type: 'panel', id: 'minesweeper-side-bottom', appType: 'minesweeper-replays' }, size: 70 },
],
},
// 25 rather than Atelier's 30: the board is drawn at a whole-number scale, so the panel losing a
web/levels.ts
+13
View File
@@ -0,0 +1,13 @@
/** The three standard difficulties, in the order the panel lists them: hardest first. */
export const LEVELS = [
{ key: 'expert', label: 'Expert' },
{ key: 'intermediate', label: 'Intermediate' },
{ key: 'beginner', label: 'Beginner' },
] as const;
export type Level = (typeof LEVELS)[number]['key'];
export const isLevel = (value: string | undefined): value is Level =>
!!value && LEVELS.some((l) => l.key === value);
export type Replay = { file: string; level: Level; time: number; played: string; lost: boolean };
web/panels.ts
+5 -1
View File
@@ -1,10 +1,14 @@
// `panels.ts`, not `.tsx` — discovery checks for that exact name.
import { Bomb } from 'lucide-react';
import { Bomb, Film, ListOrdered } from 'lucide-react';
import type { AppRegistryMeta } from 'officerdev';
import { MinesweeperPanel } from './MinesweeperPanel';
import { LevelsPanel } from './LevelsPanel';
import { ReplaysPanel } from './ReplaysPanel';
// Minesweeper X on a virtual display, streamed over RFB. The client is ./rfb.ts — a few hundred lines
// rather than a vendored noVNC, because we control the server and need two encodings out of ten.
export const appRegistryMetas: AppRegistryMeta[] = [
{ key: 'minesweeper', name: 'Minesweeper', icon: Bomb, component: MinesweeperPanel, availableOnPanel: false },
{ key: 'minesweeper-levels', name: 'Difficulty', icon: ListOrdered, component: LevelsPanel, availableOnPanel: false },
{ key: 'minesweeper-replays', name: 'Replays', icon: Film, component: ReplaysPanel, availableOnPanel: false },
];