tds3p-rsvp-reader/TODO.md

2.7 KiB
Raw Blame History

Project status and next steps

The converter writes TOC and book metadata at the book root, with chapter text and v3 RSVP sidecars in content/. It detects dialogue and marks it Other; the firmware displays those words in grey when Colors is on. Named speaker attribution and Maverick Coref remain outside the conversion flow and are used only in optional evaluation.

Reading profiles

Add selectable reading profiles for punctuation and paragraph pause lengths, long-word delay, unfamiliar-word timing, and WPM presets. Keep a plain/default profile that preserves the current cadence.

Replace fixed 2×/3× sidecar word-delay values with categorical timing tags. Map each category to a configurable delay in reader settings, so changing a delay does not require regenerating sidecars. Version the format change and keep existing v1/v2/v3 sidecars readable.

Dialogue and character colors

Attribute only high-confidence spans to a canonical entity and load a separate, editable per-book entity map that assigns each named entity a hue from 30 through 330 in 30-degree HSL steps at 100% saturation and 75% lightness. Include aliases so descriptions such as "mysterious man" can later resolve to a named entity, and report unresolved or ambiguous attribution for review rather than guessing.

Keep later entity assignments sparse: unassigned words have no sidecar record unless style or timing metadata requires one.

Add anti-aliased reader fonts

The current reader uses TFT_eSPI's bitmap FreeSans, FreeSerif, and FreeMono fonts. They are compact and fast, but their edges remain jagged at large sizes.

Use TFT_eSPI smooth-font (.vlw) assets for the reading view and font-setting previews.

  1. Generate or obtain licensed .vlw files for sans-serif, serif, and monospace faces at the seven supported reader sizes: 1, 1.5, 2, 2.5, 3, 3.5, and 4.
  2. Place the files in a dedicated SD-card directory, for example /fonts/<style>-<size>.vlw; document these required files alongside the existing /books/<book>/content/<chapter>.txt layout.
  3. Change Board to load the selected smooth font from SD when a font setting is applied, and fall back to the current bitmap font if the file is absent or cannot be loaded.
  4. Continue to clear only the union of the old and new word bounds. Smooth glyphs should be drawn with an explicit black background so anti-aliased edge pixels blend correctly without redrawing the status bar or dead space.
  5. Measure load time, RAM use, and word-to-word rendering latency on the T-Display-S3-Pro. Keep the cached active font in memory and avoid SD reads during normal word advances.
  6. Verify that chapter-title and The End cards use the same selected smooth font and remain aligned with normal words.