Files
chess-endgame-trainer/GLOSSARY.md
T

166 lines
5.8 KiB
Markdown

# Chesstrainer
An endgame trainer: the user plays a stored endgame position against
tablebase-optimal defence and is graded on every move.
## Core model
**Endgame**:
A stored chess position (FEN) plus metadata — side to move, result, rating,
tags — that can be played as a puzzle.
_Avoid_: Position, puzzle
**Puzzle**:
A playable challenge derived from an endgame: play the winning (or drawing)
side correctly against tablebase-optimal defence. Each endgame currently
yields one puzzle.
_Avoid_: Endgame (the stored record), exercise
**Daily puzzle**:
The one endgame assigned to a UTC date and shared by every user; the
assignment is persisted so it stays stable for that day.
_Avoid_: Random puzzle, featured puzzle
**Attempt**:
A recorded playthrough of a puzzle by a user, ending solved or failed; a
per-user record, distinct from an endgame's global attempt and solve counts.
_Avoid_: Run, game
**Theme**:
A label describing an endgame's technique or goal, such as "mate in 2", "Lucena" or
"opposition"; an endgame can carry several.
_Avoid_: Tag, label, category, UI theme, colour mode
## Interface
**Colour mode**:
A user's display preference for the interface — `system`, `light` or `dark` — where
`system` follows the operating system setting. It is a per-browser preference,
independent of any user account.
_Avoid_: Theme, colour scheme, display theme
**Key**:
The canonical material signature of an endgame's starting position — which
pieces each side has, written strongest side first and colour-agnostic
(e.g. "KQ v KR"). Used to group and search endgames by material.
_Avoid_: Material signature, hash
**Public code**:
The short, stable identifier an endgame is played under in player-facing
links, distinct from its database id and safe to share.
_Avoid_: Slug, UUID, endgame id, token
## Identity & access
**User**:
A person who can sign in to the trainer, identified by a unique email address and a unique username.
_Avoid_: Account, player
**Role**:
A user's authority tier — `member`, `moderator`, `admin` or `super_admin` — deciding access to the admin area and the power to manage other users.
_Avoid_: Permission, access level
**Plan**:
A user's subscription tier — `free` or `premium` — independent of their role.
_Avoid_: Tier, subscription, membership
**Mailing list**:
Email addresses that opted in to occasional product updates, collected from the
landing-page form or the registration checkbox; a subscriber need not have an
account.
_Avoid_: Newsletter, subscription (reserved for the premium plan)
## Play
**Winning side**:
The side that can force a win from the position; the side the user plays in
win-type endgames.
**Drawing side**:
In draw endgames, the side that must hold the draw; the side the user plays.
_Avoid_: Defender
**Optimal move**:
The tablebase's best move for the side to move (sharpest win / hardest defence).
**Winning move**:
A move that keeps the win (the opponent is still lost). Passes.
_Avoid_: Good move, accurate move
**Losing move**:
A move that throws away the result (the position becomes drawn or lost).
Fails the puzzle.
_Avoid_: Blunder, mistake
**Conversion**:
The decisive zeroing move — a promotion — that ends a conversion-type puzzle.
**Cutoff**:
The terminal condition short of mate at which a puzzle counts as solved:
promotion (still winning) for conversion puzzles, mate otherwise.
**Session**:
One continuous spell of puzzle play, begun by choosing a difficulty, that
carries a start time and a rating baseline for the timer and rating-gain
monitor. Ephemeral — it lives only in the running LiveView, never persisted.
_Avoid_: Run, game, attempt
## Ratings
**Rating**:
A user's estimated solving skill, or an endgame's estimated difficulty, on a
scale that lets the two be compared.
_Avoid_: Score, ELO, rank
**Rating deviation**:
The uncertainty around a rating; it widens with inactivity and narrows with
rated results, so a less certain rating moves further per result.
_Avoid_: Error margin, variance
**Rating window**:
The minimum interval before the same user replaying the same endgame can change
either rating again.
_Avoid_: Cooldown (reserved for tablebase rate-limiting)
**Volatility**:
A measure of how erratic a competitor's recent results are, used by some rating
systems; the trainer deliberately does not track it.
_Avoid_: Variance, inconsistency
**Difficulty**:
A choice — `easy`, `medium` or `hard` — that selects which puzzles to serve
relative to the current user's rating: `medium` is near the user's rating,
`easy` below it, `hard` above it. The band width is a configured constant. It is
a property of a session, not of an endgame — the same endgame is easy for one
user and hard for another.
_Avoid_: Level, rank, tier
## Infrastructure
**Tablebase**:
A database of precomputed optimal outcomes for every position with at most
seven pieces. Positions with five or fewer pieces are answered from local
Syzygy files; six and seven piece positions come from the lichess API. The
trainer keeps only the outcome data it grades on — enough to tell a winning
move from a losing one — and caches API answers only; local answers are cheap
enough to refetch.
**Probe**:
A single lookup of one position in the tablebase, returning its result and its
legal moves. A probe is answered locally or by the API.
**Position key**:
The identity of a tablebase position — board, side to move, castling and
en-passant — excluding the move clocks. FENs that differ only in their clocks
share a position key.
_Avoid_: Full FEN
**Cooldown**:
Rate-limit state entered after a 429 from the lichess API, during which the
trainer blocks play for positions that need the API (six or seven pieces).
Local positions are unaffected.
**Cache sweep**:
The periodic halving of LFU cache frequencies (weekly) that lets rarely-used
entries age out.