Skip to content

nestris-terminal Retroverse Terminal

Latest release CI Platform Input Beta

nestris-terminal is the self-service kiosk for players. It runs full screen on a touch PC with an RFID reader. There's no keyboard and no mouse: players register, get their personal card written, check their stats and rank, and replay their own games.

It is a pure client of NestrisLTM. It never touches the database, and it talks to the host only through a token-protected REST API.

Repository Download latest

What players see

Situation Screen
No card on the reader Main menu (attract mode): highscore of the active event, replays of other players, button "Neu anmelden"
Known card placed Player page: all-time stats, history per event, current event (rank, best score, gap to the next place), own games with replay, "Score eintragen"
Blank card placed Registration, with the card already attached
Older card with a name but unknown UID Matched by name, then the card is linked to the existing player
"Neu anmelden" without a card Guided flow: data → "Karte auflegen" → card is written → "Karte bitte entnehmen" → done
Card removed Player page closes after 3 s, or after 2 minutes without a touch
stateDiagram-v2
    direction LR
    [*] --> Menu
    Menu --> Player: known card
    Menu --> Register: blank card
    Menu --> Register: Neu anmelden
    Register --> WriteCard: data entered
    WriteCard --> Player: card written + verified
    Player --> Replay: select game
    Replay --> Player
    Player --> ScoreEntry: Score eintragen
    ScoreEntry --> Player
    Player --> Menu: card removed (3 s) / idle (2 min)

Registration asks for a nickname (required, unique, checked while typing), first and last name, and an e-mail address with a consent checkbox. Only the nickname is ever shown in public.

Self-reported scores (for example from a console without a station) count straight away but are flagged self_reported, so the crew can review or hide them.

Touch-first UI. It has a built-in on-screen keyboard and number pad, touch targets of at least 56 px, German by default and English selectable. Replays use the same NES renderer as NestrisLTM.

Architecture

flowchart LR
    U["<span style='color:#111111'>Touch UI<br/>Svelte 5</span>"]:::term <--> B["<span style='color:#111111'>Local bridge<br/>FastAPI 127.0.0.1:7991</span>"]:::term
    K["<span style='color:#111111'>Kiosk window<br/>PySide6 / QWebEngine</span>"]:::term --> U
    B <-- "USB serial · v2" --> R["<span style='color:#111111'>RFID reader</span>"]:::rfid
    B -- "REST + bearer token<br/>/api/terminal/v1" --> L["<span style='color:#111111'>NestrisLTM :7990</span>"]:::ltm

    classDef ltm fill:#f5b800,stroke:#7a5c00,color:#111,stroke-width:2px
    classDef term fill:#a78bfa,stroke:#6d28d9,color:#111,stroke-width:2px
    classDef rfid fill:#f472b6,stroke:#be185d,color:#111,stroke-width:2px
  • The bridge owns the reader and the host token. The browser UI only talks to 127.0.0.1.
  • The reader must speak protocol v2. Older firmware is refused with the message "Leser-Firmware veraltet".
  • A fake reader driver lets the crew test the whole flow without hardware.
  • A hidden, PIN-protected admin menu has three tabs: settings, reader (display size, brightness, rotation) and debug.

The API it uses is in the Terminal API reference.

Installation

  1. Download RetroverseTerminal-Setup-<version>.exe from the latest release. It installs per user and needs no admin rights.
  2. In the wizard, enter the NestrisLTM URL (for example http://192.168.1.10:7990) and a token with the terminal scope.
  3. Choose autostart and a desktop icon. Start menu entries: Retroverse Terminal (kiosk) and Retroverse Terminal (Fenster) (windowed).
  4. Plug in the reader. Its port is detected automatically (CP210x / CH340).

Kiosk hardening

For unattended use, enable automatic sign-in and disable sleep and notifications. Also disable the Windows edge swipe (AllowEdgeSwipe=0), so players cannot leave the kiosk.

Command line

Command Purpose
nestris-terminal configure --host … --token … Set the host, token and optionally the reader port, driver and language
nestris-terminal autostart on\|off\|status Start at sign-in
nestris-terminal set-pin Change the admin PIN
nestris-terminal config-path Print the config location
nestris-terminal --windowed Run in a window instead of full screen

Configuration

The config is %APPDATA%\NestrisTerminal\config.toml. Environment variables NESTRIS_TERMINAL__<SECTION>__<KEY> override it.

Key Default
host.url http://127.0.0.1:7990
host.token token with scope terminal
rfid.driver serial (or fake)
rfid.port empty = auto-detect
kiosk.lang de
kiosk.card_grace_s 3
kiosk.idle_timeout_s 120
http.port 7991 (local only)

Release artifacts

File Purpose
RetroverseTerminal-Setup-<v>.exe Per-user installer (German / English)
RetroverseTerminal-<v>-portable.zip Portable folder build
SHA256SUMS.txt / .sig Checksums and Ed25519 signature