feat: cap compressed group size at 64 KB#1913
Conversation
Add GROUP_MAX_UNCOMPRESSED_BYTES=65536 on top of the existing script- based grouping. When adding the next glyph would push a group past the cap, the group is closed and a new one started with the same script ID. Without the cap, the size of a script group is bounded only by however many glyphs the font supplies in that block. Dense scripts (CJK, Vietnamese precomposed, user-supplied fonts with large Unicode blocks) can produce a single group whose uncompressed size exceeds what fits in the embedded decompressor's transient malloc on the ESP32-C3, which manifests as a runtime allocation failure instead of a build error. The 64 KB ceiling is large enough to hold any single built-in script group with headroom and small enough to be a comfortable transient allocation on-device. The check uses byte-aligned size (4-pixel-aligned row stride × height), which is what the decompressor actually consumes — not the packed on-disk length. A defensive guard rejects any single glyph whose own size exceeds the cap with a clear error pointing at the offending codepoint.
|
ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📜 Recent review details⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
📝 WalkthroughWalkthroughThis PR constrains DEFLATE compression group formation in the font converter by introducing a hard 65536-byte cap on uncompressed bitmap data per group. The script now tracks byte-aligned buffer sizes, closes groups when the threshold is exceeded, and raises an error if any single glyph exceeds the cap. ChangesDEFLATE Group Size Constraining
🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@lib/EpdFont/scripts/fontconvert.py`:
- Around line 845-850: The ValueError raised when glyph_aligned_size >
GROUP_MAX_UNCOMPRESSED_BYTES is not actionable; change the message in the
ValueError raised in fontconvert.py (the block referencing glyph_aligned_size,
props.code_point and GROUP_MAX_UNCOMPRESSED_BYTES) to suggest concrete remedies
(e.g., increase GROUP_MAX_UNCOMPRESSED_BYTES, reduce the font/glyph pixel size
or complexity, or switch to a different encoding/compression) and remove "split
the glyph" so users see viable next steps and can act on the error.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 61824674-f2b3-4ae8-994e-7de8c2aca774
📒 Files selected for processing (1)
lib/EpdFont/scripts/fontconvert.py
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: build
- GitHub Check: clang-format
- GitHub Check: cppcheck
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-02-23T19:55:03.054Z
Learnt from: martinbrook
Repo: crosspoint-reader/crosspoint-reader PR: 1136
File: scripts/patch_jpegdec.py:20-23
Timestamp: 2026-02-23T19:55:03.054Z
Learning: In the crosspoint-reader project, enable Python linters (e.g., Ruff or Flake8) in CI for all Python scripts. Run linting as part of the CI workflow and fix reported issues to maintain code quality. Do not skip linting for any Python files.
Applied to files:
lib/EpdFont/scripts/fontconvert.py
🔇 Additional comments (3)
lib/EpdFont/scripts/fontconvert.py (3)
795-803: LGTM! Clear documentation of the size cap behavior.The comment accurately explains the layered cap on top of script-based grouping and provides good rationale for the constraint. This helps future maintainers understand why groups might split within a single script block.
821-824: LGTM! Well-chosen constant with clear rationale.The 64 KB cap is appropriately documented and follows Python naming conventions. The value balances accommodation of dense script groups against embedded device memory constraints.
836-862: LGTM! Correct implementation of size-capped group formation.The logic correctly:
- Tracks byte-aligned uncompressed size matching the
to_byte_aligned()buffer format (lines 843-844 match line 769)- Closes groups when adding the next glyph would exceed the cap (line 851)
- Handles edge cases: empty glyphs contribute 0 size, first glyph starts a new group, last group is appended after the loop
- Preserves existing script-based grouping behavior when the cap is not hit
The OR condition on line 853 ensures groups split on either script boundaries or size overflow, maintaining both constraints.
|
@znelson Can you review this PR |
## Summary This release adds SD card fonts — the most-requested feature since launch — brings the X3 to first-class status, redesigns the on-screen keyboard, overhauls OPDS, and ships SD-card firmware updates. 144 changes from 53 contributors, 32 of whom are new to the project. **🔠 SD Card Fonts** Custom fonts are here. A complete font subsystem lets you install and use fonts beyond the three built-in families. A new `.cpfont` binary format packs multiple styles (regular, bold, italic, bold-italic) into a single file per size, with on-demand glyph loading from the SD card. A two-pass prewarm renderer bulk-reads glyphs per page, achieving near-flash performance for Latin text and viable CJK rendering. Fonts can be downloaded over WiFi directly from the device, uploaded via the web interface, or copied manually to the SD card. The build pipeline ships a 17-family font library (serif, sans, mono, accessibility) with CI distribution via a dedicated crosspoint-fonts repository. As a bonus, CJK characters no longer get spurious hyphens at line breaks, and an advance-table cache eliminates 30+ second stalls during CJK section indexing. **📱 X3 Comes of Age** The X3 graduates from initial bring-up to a proper target. Grayscale antialiasing is sharper, EPUB images render correctly, OTA updates work, and sleep screen dimensions are dialed in. The headline addition: gyroscope-based tilt page turning via the QMI8658 IMU — tilt the device to turn pages hands-free. SD-card firmware update support and X3 bootloader compatibility mean users can update without a USB connection. **⌨️ Redesigned On-Screen Keyboard** The keyboard has been completely redesigned with improved layout, better key feedback, and a fix for the space key barely moving the cursor. Text entry across WiFi setup, OPDS search, and KOSync login is noticeably smoother. **👁️ Focus Reading** A new reading mode bolds the initial characters of each word (similar to Bionic Reading) to create artificial fixation points, helping improve reading speed and focus. The bolding ratio is 45%, with a minimum of 1 character and a maximum of 9, applied dynamically during indexing. **📚 OPDS Overhaul** OPDS gains in-catalog search with next/prev page navigation, support for multiple servers, correct handling of relative paths and query parameters (fixing CopyParty compatibility), and KOReader-compatible download filenames. **🔤 Text Rendering Refinements** Combining marks (diacritics) now use font metrics for positioning instead of heuristics, proportional numeral spacing is supported, and differential rounding eliminates uneven inter-glyph gaps. Hyphenation now recognizes ISO 639-2 language codes, nested block-level CSS styles are tracked correctly, and horizontal CSS insets are capped at 2em to prevent runaway margins. Bookerly has been replaced with Noto Serif for licensing reasons. **🎨 New Theme: RoundedRaff** A new rounded theme joins the theme picker, with fixes for sleep cover crop grid artifacts. **🔋 Battery & Power** Battery percentage smoothing on the X4 eliminates jittery readings. A short press on the power button can be set to trigger a manual screen refresh — handy for clearing ghosting. **📶 WiFi & Networking** WiFi connections now self-heal from transient drops without manual intervention, and a dBm signal strength indicator appears during web server sessions. WiFi networks can be edited directly from the web UI. **🔄 KOSync** Reading position sync is significantly more accurate. The old character-offset approach frequently landed on the wrong paragraph after syncing between devices — the new xpath-based mapping syncs at the paragraph level, matching KOReader's own behavior. A separate fix switches the HTTP layer to `esp_http_client`, and the reader now releases ~65KB of EPUB heap before the TLS handshake — together these eliminate the out-of-memory crashes that plagued KOSync on large books. **🛡️ Stability** Two memory leaks patched, a wild pointer crash in JPEGDEC MCU_SKIP handling fixed, boot loops with large XTC files eliminated, legacy XTC headers supported, the OTA updater now streams GitHub release JSON instead of buffering it in RAM, and a JPEG downscaler y-axis scale factor bug is corrected. **🌐 Languages** Slovenian is new. Russian, Ukrainian, Swedish, Italian, and Spanish translations received significant updates. --- Also in this release: **SD-card firmware updates without USB**, **file extensions in the file browser**, **full path bar navigation**, **end-of-book navigation improvements**, **XTC status bar**, **smarter "Cover + Custom" sleep screens**, **set sleep cover from the BMP viewer**, **orientation-aware popups**, **page turn buttons that follow orientation**, **long-press delete for directories**, **context-aware screenshot filenames with book title**, **crash reason displayed on boot**, **empty line rendering in the TXT reader**, **wallpaper recency buffer to prevent clustering**, **font family deletion from the device**, **next/prev labels in the BMP viewer**, **non-breaking space justification fix**, **README guidance for USB-locked third-party Xteink units**, and a long tail of web UI polish, i18n memory optimizations, and code quality improvements. ## What's Changed ### Features * feat: add SD card font support with on-device download and web management by @adriancaruana, @znelson, @itsthisjustin, @jpirnay, and @mcrosson * feat: Initial support for the x3 by @itsthisjustin in #875 * feat: X3 grayscale antialiasing improvements by @juicecultus in #1607 * feat: X3 gyroscope-based tilt page turning via QMI8658 IMU by @juicecultus in #1636 * feat(update): SD-card firmware update + X3 bootloader compatibility by @eunchurn in #1786 * feat: self-heal from transient WiFi loss, add dBm indicator during WebServerActivity by @jeremydk in #1780 * feat: edit wifi networks in webui by @osteotek in #1743 * feat: add OPDS search support & next/prev page navigation by @rxmmah in #1462 * feat: Support for multiple OPDS servers by @osteotek in #1209 * feat: Adjust Navigation at End of Book by @nscheung in #1425 * feat: Display file extensions in File Browser by @CaptainFrito in #1019 * feat: show full path bar in file browser by @zgredex in #1411 * feat: enable manual screen refresh on power button short press by @bdeshi in #1626 * feat: Rework "Cover + Custom" sleep screens to show covers only when currently reading by @iandchasse in #1256 * feat: Set sleep cover from BMP viewer by @el in #1104 * feat: show crash reason on boot by @ngxson in #1453 * feat: Support for proportional numeral spacing by @znelson in #1414 * feat: add orientation-aware popups for reader activities by @mrtnvgr in #1428 * feat: smooth battery percentage for x4 by @jonvex in #1635 * feat: context-aware screenshot filenames with book title by @jonstieglitz in #1589 * feat(theme): add roundedraff theme and fix sleep cover crop grid artifacts by @bunsoootchi in #918 * feat: Page turn button orientation change by @mchuck in #1069 * feat: Status bar for XTC files by @leecming82 in #1849 * feat: enhance long press action to delete both files and directories by @WuTofu in #1803 * feat: Added Slovenian translation by @thehijacker in #1551 * feat: focus reading by @vjapolitzer in #1670 * feat: add next / prev labels to bmp viewer by @Telemaniaka in #1852 * feat: add font family deletion functionality by @WuTofu in #1919 * feat: separate into "Download All" and "Update All" in font manager by @WuTofu in #1955 * feat: verify CRC32 checksum for font files by @WuTofu in #1904 * feat: increase default weight of Bitter font for improved rendering by @uxjulia in #1922 * feat: allow unnamed intervals by @steka in #1903 ### Fixes * fix: epub images not rendering correctly on x3 by @itsthisjustin in #1572 * fix: OTA update on x3 and progress bar on x4 and x3 by @itsthisjustin in #1805 * fix: boot looping when opening large XTC files by @itsthisjustin in #1648 * fix: Wild pointer crash in JPEGDEC MCU_SKIP handling by @itsthisjustin in #1627 * fix: two small memory leaks by @Uri-Tauber in #1628 * fix: use esp_http_client for KOSync to prevent TLS OOM on ESP32-C3 by @trilwu in #1381 * fix: Read GH release JSON as stream in OTA updater by @znelson in #1810 * fix: support legacy XTC file headers where pageTableOffset=48 by @uxjulia in #1816 * fix: Use font metrics for combining mark positioning by @znelson in #1310 * fix: Use differential rounding for consistent inter-glyph spacing by @znelson in #1413 * fix: Support hyphenation for EPUBs using ISO 639-2 language codes by @znelson in #1461 * fix: Track block style stack for nested styles by @daveallie in #1582 * fix: cap per-side horizontal CSS inset at 2em by @rhoopr in #1694 * fix: increase loadable epub size by @CSCMe in #1638 * fix: Switch to xpath map for paragraph level syncing in KOSync by @itsthisjustin in #1686 * fix: free Epub RAM and simplify KOSync navigation via ActivityManager by @wylanswets in #1860 * fix: improve KOSync bidirectional position matching accuracy by @wylanswets in #1897 * fix: Fix failing very first wifi connection attempt by @jpirnay in #1521 * fix: avoid skipping chapter after screenshot by @Mraulio in #1625 * fix: back navigation from BMPViewer by @Telemaniaka in #1597 * fix: Fix ghosting on exit of BMPViewer by @jpirnay in #1432 * fix: make footnotes consider orientation for gutters by @Telemaniaka in #1665 * fix: footnote link text by @steka in #1666 * fix: Erroneous navigation with long filenames in footnote links by @CSCMe in #1723 * fix: prevent wallpaper clustering with 16-entry recency buffer by @zgredex in #1606 * fix: webserver /delete API backward compatibility by @DianaNites in #1475 * fix: relative opds paths and query param with copyparty by @philips in #1535 * fix: use same file name as KOReader for OPDS downloads by @spfenwick in #1286 * fix: pressing space barely moves input cursor (#1729) by @pablohc in #1733 * fix: keyboard feedback #1644 by @pablohc in #1697 * fix: pluralize folder/file counts correctly in file list summary by @fain182 in #1701 * fix: rendering bug of scrollbar in RoundedRaff theme by @Uri-Tauber in #1814 * fix: two roundedraff bugs by @Uri-Tauber in #1851 * fix: overlap in download font list layout by @pablohc in #1900 * fix: remove duplicate 'Download Fonts' menu entry and improve navigation by @zgredex in #1893 * fix: Add common ligatures to SD font conversion ranges by @znelson * fix: capture instantiateVariableFont return value by @jpirnay in #1911 * fix: Roundraff theme home menu offset with no recent books by @znelson in #1845 * fix: Missing navigation button labels in Roundedraff theme by @Uri-Tauber in #1905 * fix: gracefully resolve fonts missing variants by @Uri-Tauber in #1921 * fix: distribute justifyExtra to non-breaking space tokens by @prawnwhoyawns in #1783 * fix: remove percent rendering from activities by @mcrosson in #1901 * fix: Restore performance in fontconvert_sdcard.py by @znelson in #1924 * fix: Prepare SD card font caches from txt reader by @znelson in #1973 * fix: make script help paths lightweight by @sabraman in #1937 * fix: Replaced Bookerly with Noto Serif for licensing reasons by @znelson in #1736 * fix: incorrect y-axis scale factor in jpeg nearest-neighbor downscaler by @WuTofu in #1807 * fix: display empty lines in txt reader by @Uri-Tauber in #1841 * fix: short-press power action triggered after screenshot combo release by @pablohc in #1853 * fix: correct Russian auto-turn translations by @a-ignatev in #1566 * fix: Update Ukrainian translations for footnotes (issue 1409) by @mirus-ua in #1585 * fix: missing swedish translations by @steka in #1667 * fix: Add swedish keyboard translations by @steka in #1726 * fix: swedish translations by @steka in #1762 * fix: swedish translation by @steka in #1829 * fix: swedish translation by @steka in #1888 * fix: Polish translation by @th0m4sek in #1909 * fix: Ukrainian-translation by @KymAndriy in #1946 * fix: Ukrainian translation by @KymAndriy in #1939 * fix: python requirements files by @steka in #1768 * fix: missing requirement by @steka in #1896 * fix: Use LOG_ macros in loc functions by @znelson in #1794 ### Internal * refactor: redesign on-screen keyboard by @pablohc in #1644 * refactor: replace picojpeg with JPEGDEC for cover art conversion by @jpirnay in #1517 * refactor: Refactor drawArc / fillArc for faster execution by @jpirnay in #1540 * perf: replace i18n pointer tables with offset tables, strip unused strings by @jpirnay in #1408 * refactor: Store only unique localization strings in offset buffers by @znelson in #1802 * refactor: Move language setting into JSON settings by @znelson in #1796 * refactor: Use C++20 'requires' in ActivityResult constructor by @znelson in #1420 * refactor: Use default member initializers for JpegContext and PngContext by @znelson in #1435 * refactor: logPrintf and predefined log level strings by @CSCMe in #1546 * refactor: RAII scoped open/close for ZipFile by @znelson in #1433 * refactor: Deduplicated BMP header writing in Xtc by @znelson in #1439 * refactor: Added shared XML parser teardown helper by @znelson in #1438 * refactor: Removed redundant FsFile close() calls by @znelson in #1434 * refactor: Deduplicate battery drawing code and fix Lyra charging indicator by @znelson in #1437 * refactor: Deduplicate Roundraff battery drawing by @znelson in #1847 * refactor: Simplify sort in GfxRenderer::fillPolygon by @znelson in #1817 * refactor: Avoid vector for page turn rates list by @znelson in #1818 * refactor: Use std::size instead of sizeof/sizeof by @znelson in #1819 * refactor: Use fixed-size integers for BookMetadataCache data by @znelson in #1844 * refactor: Simplify isReaderActivity bookkeeping by @znelson in #1838 * refactor: Simplify XtcReaderActivity with detectPageTurn by @znelson in #1837 * refactor: change ukrainian translation to adaptation and add missing lines by @KymAndriy in #1828 * chore: drop JPEGDEC patch in favour of upstream fix by @martinbrook in #1465 * chore: clang-format.fix.ps1 script: Add .venv to list of path exclusions by @jpirnay in #1515 * chore: Updating sleep screen dimensions for X3 by @jensechu in #1688 * chore: Clarify X3 RTC in SCOPE.md by @znelson in #1687 * chore: Improved Italian translations by @znelson in #1685 * chore: change ukrainian translation to adaptation by @KymAndriy in #1684 * chore: Update spanish.yaml by @mvidelatraduc in #1717 * chore: One Italian translation tweak by @znelson in #1718 * chore: git pre-commit hook for format fix by @osteotek in #1730 * chore: Update SDK to fork in CrossPoint org by @znelson in #1836 * chore: Added RAM to firmware_size_history.py script by @znelson in #1830 * chore: Updated docs to reflect DESTRUCTOR_CLOSES_FILE=1 by @znelson in #1878 * feat: cap compressed group size at 64 KB by @jpirnay in #1913 * fix: build-script bug fixes for fontconvert{,_sdcard}.py by @jpirnay in #1910 * feat: include short SHA in CROSSPOINT_VERSION by @osteotek in #1728 * feat: show long branch names by @steka in #1727 * feat: enable pio build cache by @Uri-Tauber in #1769 * style: put page name first in browser titles by @fain182 in #1703 * style: unify page headers across web UI by @fain182 in #1702 * style: move file type badges into Type column by @fain182 in #1793 * style: align action buttons vertically with page title by @fain182 in #1795 * docs: Update README with firmware flashing instructions by @ryneches in #1654 * docs: fix typos by @kianmeng in #1705 * docs: update README.md to reflect the current state of crosspoint by @Uri-Tauber in #1812 * docs: Add documentation for USB-locked Xteink devices by @itsthisjustin in #1990 * docs: expand first use of OPDS acronym and provide a wikipedia link by @sizezero in #1824 * docs: fix KOReader sync guide link by @sabraman in #1930 * docs: fix hyphenation updater script name by @sabraman in #1931 * fix: sd font download urls in docs by @mcrosson in #1945 * fix: sd font folder paths in documentation by @mcrosson in #1944 * chore: Add verbose mode to build-sd-fonts.py by @znelson in #1923 ## New Contributors * @a-ignatev made their first contribution in #1566 * @CSCMe made their first contribution in #1546 * @thehijacker made their first contribution in #1551 * @Telemaniaka made their first contribution in #1597 * @Mraulio made their first contribution in #1625 * @rxmmah made their first contribution in #1462 * @bdeshi made their first contribution in #1626 * @DianaNites made their first contribution in #1475 * @ryneches made their first contribution in #1654 * @zgredex made their first contribution in #1411 * @jonvex made their first contribution in #1635 * @KymAndriy made their first contribution in #1684 * @jensechu made their first contribution in #1688 * @kianmeng made their first contribution in #1705 * @philips made their first contribution in #1535 * @fain182 made their first contribution in #1701 * @mvidelatraduc made their first contribution in #1717 * @bunsoootchi made their first contribution in #918 * @rhoopr made their first contribution in #1694 * @spfenwick made their first contribution in #1286 * @trilwu made their first contribution in #1381 * @jonstieglitz made their first contribution in #1589 * @uxjulia made their first contribution in #1816 * @mchuck made their first contribution in #1069 * @sizezero made their first contribution in #1824 * @leecming82 made their first contribution in #1849 * @jeremydk made their first contribution in #1780 * @WuTofu made their first contribution in #1803 * @wylanswets made their first contribution in #1860 * @sabraman made their first contribution in #1930 * @prawnwhoyawns made their first contribution in #1783 * @mcrosson made their first contribution as co-author on SD card font support **Full Changelog**: 1.2.0...release/1.3.0 --------- Co-authored-by: Justin Mitchell <justin@jmitch.com> Co-authored-by: Chun Ming Lee <95391408+leecming82@users.noreply.github.com> Co-authored-by: Uri Tauber <uritaube@gmail.com>
* fix: Prepare SD card font caches from txt reader (crosspoint-reader#1973) ## Summary SD card font fixes: - `TxtReaderActivity` needs to call `renderer.ensureSdCardFontReady` to build the advance lookup table to support rendering with SD card fonts. This revealed that `TxtReaderActivity` was inconsistently performing layout with `getTextWidth`, when the renderer actually uses `getTextAdvanceX`, which can lead to minor inconsistencies in alignment. - Avoid allocating one big `allText` string in `ParsedText::layoutAndExtractLines`. Instead, pass the vector of word strings directly to `SdCardFont::buildAdvanceTable`, where the algorithm just needs to iterate codepoints anyway. --- ### AI Usage While CrossPoint doesn't have restrictions on AI tools in contributing, please be transparent about their usage as it helps set the right context for reviewers. Did you use AI tools to help write this code? _**PARTIALLY**_ --------- Co-authored-by: Justin Mitchell <justin@jmitch.com> * fix: Add documentation for USB-locked Xteink devices (crosspoint-reader#1990) Document the Xteink Unlocker tool requirement for third-party purchased xteink units that ship with USB flashing locked. Include warnings about bricking risks when flashing unsupported firmwares (e.g. Papyrix) on locked devices, as they may permanently lock the device with no recovery path. * fix: update README.md to reflect the current state of crosspoint (crosspoint-reader#1812) ## Summary As noted in [crosspoint-reader#1680](crosspoint-reader#1680 (comment)), the README hasn't been updated in a while and has fallen behind the actual firmware. This PR brings it up to date. Beyond the feature list, I added a section acknowledging community forks worth knowing about. I also took some deliberate editorial choices around how CrossPoint is framed — I think it has the potential to be more than just "an alternative Xteink firmware", and the wording reflects that. A note on process: I wrote the bulk of the text myself, but used AI tools to scan the codebase and catch features I might have missed, and to clean up my English (I'm fluent but not a native speaker). If any line reads as unnatural or AI-sounding, please flag it — I'd rather fix it than leave it. --- One thing outside the scope of this PR: I think the cover photo could use a refresh, ideally replaced with a small gallery showing different CrossPoint screens. If you have a professional camera and an Xteink device and want to help with that, let me know. --------- Co-authored-by: Zach Nelson <zach@zdnelson.com> * chore: Update version to 1.3.0 (crosspoint-reader#1827) ## Summary This release adds SD card fonts — the most-requested feature since launch — brings the X3 to first-class status, redesigns the on-screen keyboard, overhauls OPDS, and ships SD-card firmware updates. 144 changes from 53 contributors, 32 of whom are new to the project. **🔠 SD Card Fonts** Custom fonts are here. A complete font subsystem lets you install and use fonts beyond the three built-in families. A new `.cpfont` binary format packs multiple styles (regular, bold, italic, bold-italic) into a single file per size, with on-demand glyph loading from the SD card. A two-pass prewarm renderer bulk-reads glyphs per page, achieving near-flash performance for Latin text and viable CJK rendering. Fonts can be downloaded over WiFi directly from the device, uploaded via the web interface, or copied manually to the SD card. The build pipeline ships a 17-family font library (serif, sans, mono, accessibility) with CI distribution via a dedicated crosspoint-fonts repository. As a bonus, CJK characters no longer get spurious hyphens at line breaks, and an advance-table cache eliminates 30+ second stalls during CJK section indexing. **📱 X3 Comes of Age** The X3 graduates from initial bring-up to a proper target. Grayscale antialiasing is sharper, EPUB images render correctly, OTA updates work, and sleep screen dimensions are dialed in. The headline addition: gyroscope-based tilt page turning via the QMI8658 IMU — tilt the device to turn pages hands-free. SD-card firmware update support and X3 bootloader compatibility mean users can update without a USB connection. **⌨️ Redesigned On-Screen Keyboard** The keyboard has been completely redesigned with improved layout, better key feedback, and a fix for the space key barely moving the cursor. Text entry across WiFi setup, OPDS search, and KOSync login is noticeably smoother. **👁️ Focus Reading** A new reading mode bolds the initial characters of each word (similar to Bionic Reading) to create artificial fixation points, helping improve reading speed and focus. The bolding ratio is 45%, with a minimum of 1 character and a maximum of 9, applied dynamically during indexing. **📚 OPDS Overhaul** OPDS gains in-catalog search with next/prev page navigation, support for multiple servers, correct handling of relative paths and query parameters (fixing CopyParty compatibility), and KOReader-compatible download filenames. **🔤 Text Rendering Refinements** Combining marks (diacritics) now use font metrics for positioning instead of heuristics, proportional numeral spacing is supported, and differential rounding eliminates uneven inter-glyph gaps. Hyphenation now recognizes ISO 639-2 language codes, nested block-level CSS styles are tracked correctly, and horizontal CSS insets are capped at 2em to prevent runaway margins. Bookerly has been replaced with Noto Serif for licensing reasons. **🎨 New Theme: RoundedRaff** A new rounded theme joins the theme picker, with fixes for sleep cover crop grid artifacts. **🔋 Battery & Power** Battery percentage smoothing on the X4 eliminates jittery readings. A short press on the power button can be set to trigger a manual screen refresh — handy for clearing ghosting. **📶 WiFi & Networking** WiFi connections now self-heal from transient drops without manual intervention, and a dBm signal strength indicator appears during web server sessions. WiFi networks can be edited directly from the web UI. **🔄 KOSync** Reading position sync is significantly more accurate. The old character-offset approach frequently landed on the wrong paragraph after syncing between devices — the new xpath-based mapping syncs at the paragraph level, matching KOReader's own behavior. A separate fix switches the HTTP layer to `esp_http_client`, and the reader now releases ~65KB of EPUB heap before the TLS handshake — together these eliminate the out-of-memory crashes that plagued KOSync on large books. **🛡️ Stability** Two memory leaks patched, a wild pointer crash in JPEGDEC MCU_SKIP handling fixed, boot loops with large XTC files eliminated, legacy XTC headers supported, the OTA updater now streams GitHub release JSON instead of buffering it in RAM, and a JPEG downscaler y-axis scale factor bug is corrected. **🌐 Languages** Slovenian is new. Russian, Ukrainian, Swedish, Italian, and Spanish translations received significant updates. --- Also in this release: **SD-card firmware updates without USB**, **file extensions in the file browser**, **full path bar navigation**, **end-of-book navigation improvements**, **XTC status bar**, **smarter "Cover + Custom" sleep screens**, **set sleep cover from the BMP viewer**, **orientation-aware popups**, **page turn buttons that follow orientation**, **long-press delete for directories**, **context-aware screenshot filenames with book title**, **crash reason displayed on boot**, **empty line rendering in the TXT reader**, **wallpaper recency buffer to prevent clustering**, **font family deletion from the device**, **next/prev labels in the BMP viewer**, **non-breaking space justification fix**, **README guidance for USB-locked third-party Xteink units**, and a long tail of web UI polish, i18n memory optimizations, and code quality improvements. ## What's Changed ### Features * feat: add SD card font support with on-device download and web management by @adriancaruana, @znelson, @itsthisjustin, @jpirnay, and @mcrosson * feat: Initial support for the x3 by @itsthisjustin in crosspoint-reader#875 * feat: X3 grayscale antialiasing improvements by @juicecultus in crosspoint-reader#1607 * feat: X3 gyroscope-based tilt page turning via QMI8658 IMU by @juicecultus in crosspoint-reader#1636 * feat(update): SD-card firmware update + X3 bootloader compatibility by @eunchurn in crosspoint-reader#1786 * feat: self-heal from transient WiFi loss, add dBm indicator during WebServerActivity by @jeremydk in crosspoint-reader#1780 * feat: edit wifi networks in webui by @osteotek in crosspoint-reader#1743 * feat: add OPDS search support & next/prev page navigation by @rxmmah in crosspoint-reader#1462 * feat: Support for multiple OPDS servers by @osteotek in crosspoint-reader#1209 * feat: Adjust Navigation at End of Book by @nscheung in crosspoint-reader#1425 * feat: Display file extensions in File Browser by @CaptainFrito in crosspoint-reader#1019 * feat: show full path bar in file browser by @zgredex in crosspoint-reader#1411 * feat: enable manual screen refresh on power button short press by @bdeshi in crosspoint-reader#1626 * feat: Rework "Cover + Custom" sleep screens to show covers only when currently reading by @iandchasse in crosspoint-reader#1256 * feat: Set sleep cover from BMP viewer by @el in crosspoint-reader#1104 * feat: show crash reason on boot by @ngxson in crosspoint-reader#1453 * feat: Support for proportional numeral spacing by @znelson in crosspoint-reader#1414 * feat: add orientation-aware popups for reader activities by @mrtnvgr in crosspoint-reader#1428 * feat: smooth battery percentage for x4 by @jonvex in crosspoint-reader#1635 * feat: context-aware screenshot filenames with book title by @jonstieglitz in crosspoint-reader#1589 * feat(theme): add roundedraff theme and fix sleep cover crop grid artifacts by @bunsoootchi in crosspoint-reader#918 * feat: Page turn button orientation change by @mchuck in crosspoint-reader#1069 * feat: Status bar for XTC files by @leecming82 in crosspoint-reader#1849 * feat: enhance long press action to delete both files and directories by @WuTofu in crosspoint-reader#1803 * feat: Added Slovenian translation by @thehijacker in crosspoint-reader#1551 * feat: focus reading by @vjapolitzer in crosspoint-reader#1670 * feat: add next / prev labels to bmp viewer by @Telemaniaka in crosspoint-reader#1852 * feat: add font family deletion functionality by @WuTofu in crosspoint-reader#1919 * feat: separate into "Download All" and "Update All" in font manager by @WuTofu in crosspoint-reader#1955 * feat: verify CRC32 checksum for font files by @WuTofu in crosspoint-reader#1904 * feat: increase default weight of Bitter font for improved rendering by @uxjulia in crosspoint-reader#1922 * feat: allow unnamed intervals by @steka in crosspoint-reader#1903 ### Fixes * fix: epub images not rendering correctly on x3 by @itsthisjustin in crosspoint-reader#1572 * fix: OTA update on x3 and progress bar on x4 and x3 by @itsthisjustin in crosspoint-reader#1805 * fix: boot looping when opening large XTC files by @itsthisjustin in crosspoint-reader#1648 * fix: Wild pointer crash in JPEGDEC MCU_SKIP handling by @itsthisjustin in crosspoint-reader#1627 * fix: two small memory leaks by @Uri-Tauber in crosspoint-reader#1628 * fix: use esp_http_client for KOSync to prevent TLS OOM on ESP32-C3 by @trilwu in crosspoint-reader#1381 * fix: Read GH release JSON as stream in OTA updater by @znelson in crosspoint-reader#1810 * fix: support legacy XTC file headers where pageTableOffset=48 by @uxjulia in crosspoint-reader#1816 * fix: Use font metrics for combining mark positioning by @znelson in crosspoint-reader#1310 * fix: Use differential rounding for consistent inter-glyph spacing by @znelson in crosspoint-reader#1413 * fix: Support hyphenation for EPUBs using ISO 639-2 language codes by @znelson in crosspoint-reader#1461 * fix: Track block style stack for nested styles by @daveallie in crosspoint-reader#1582 * fix: cap per-side horizontal CSS inset at 2em by @rhoopr in crosspoint-reader#1694 * fix: increase loadable epub size by @CSCMe in crosspoint-reader#1638 * fix: Switch to xpath map for paragraph level syncing in KOSync by @itsthisjustin in crosspoint-reader#1686 * fix: free Epub RAM and simplify KOSync navigation via ActivityManager by @wylanswets in crosspoint-reader#1860 * fix: improve KOSync bidirectional position matching accuracy by @wylanswets in crosspoint-reader#1897 * fix: Fix failing very first wifi connection attempt by @jpirnay in crosspoint-reader#1521 * fix: avoid skipping chapter after screenshot by @Mraulio in crosspoint-reader#1625 * fix: back navigation from BMPViewer by @Telemaniaka in crosspoint-reader#1597 * fix: Fix ghosting on exit of BMPViewer by @jpirnay in crosspoint-reader#1432 * fix: make footnotes consider orientation for gutters by @Telemaniaka in crosspoint-reader#1665 * fix: footnote link text by @steka in crosspoint-reader#1666 * fix: Erroneous navigation with long filenames in footnote links by @CSCMe in crosspoint-reader#1723 * fix: prevent wallpaper clustering with 16-entry recency buffer by @zgredex in crosspoint-reader#1606 * fix: webserver /delete API backward compatibility by @DianaNites in crosspoint-reader#1475 * fix: relative opds paths and query param with copyparty by @philips in crosspoint-reader#1535 * fix: use same file name as KOReader for OPDS downloads by @spfenwick in crosspoint-reader#1286 * fix: pressing space barely moves input cursor (crosspoint-reader#1729) by @pablohc in crosspoint-reader#1733 * fix: keyboard feedback crosspoint-reader#1644 by @pablohc in crosspoint-reader#1697 * fix: pluralize folder/file counts correctly in file list summary by @fain182 in crosspoint-reader#1701 * fix: rendering bug of scrollbar in RoundedRaff theme by @Uri-Tauber in crosspoint-reader#1814 * fix: two roundedraff bugs by @Uri-Tauber in crosspoint-reader#1851 * fix: overlap in download font list layout by @pablohc in crosspoint-reader#1900 * fix: remove duplicate 'Download Fonts' menu entry and improve navigation by @zgredex in crosspoint-reader#1893 * fix: Add common ligatures to SD font conversion ranges by @znelson * fix: capture instantiateVariableFont return value by @jpirnay in crosspoint-reader#1911 * fix: Roundraff theme home menu offset with no recent books by @znelson in crosspoint-reader#1845 * fix: Missing navigation button labels in Roundedraff theme by @Uri-Tauber in crosspoint-reader#1905 * fix: gracefully resolve fonts missing variants by @Uri-Tauber in crosspoint-reader#1921 * fix: distribute justifyExtra to non-breaking space tokens by @prawnwhoyawns in crosspoint-reader#1783 * fix: remove percent rendering from activities by @mcrosson in crosspoint-reader#1901 * fix: Restore performance in fontconvert_sdcard.py by @znelson in crosspoint-reader#1924 * fix: Prepare SD card font caches from txt reader by @znelson in crosspoint-reader#1973 * fix: make script help paths lightweight by @sabraman in crosspoint-reader#1937 * fix: Replaced Bookerly with Noto Serif for licensing reasons by @znelson in crosspoint-reader#1736 * fix: incorrect y-axis scale factor in jpeg nearest-neighbor downscaler by @WuTofu in crosspoint-reader#1807 * fix: display empty lines in txt reader by @Uri-Tauber in crosspoint-reader#1841 * fix: short-press power action triggered after screenshot combo release by @pablohc in crosspoint-reader#1853 * fix: correct Russian auto-turn translations by @a-ignatev in crosspoint-reader#1566 * fix: Update Ukrainian translations for footnotes (issue 1409) by @mirus-ua in crosspoint-reader#1585 * fix: missing swedish translations by @steka in crosspoint-reader#1667 * fix: Add swedish keyboard translations by @steka in crosspoint-reader#1726 * fix: swedish translations by @steka in crosspoint-reader#1762 * fix: swedish translation by @steka in crosspoint-reader#1829 * fix: swedish translation by @steka in crosspoint-reader#1888 * fix: Polish translation by @th0m4sek in crosspoint-reader#1909 * fix: Ukrainian-translation by @KymAndriy in crosspoint-reader#1946 * fix: Ukrainian translation by @KymAndriy in crosspoint-reader#1939 * fix: python requirements files by @steka in crosspoint-reader#1768 * fix: missing requirement by @steka in crosspoint-reader#1896 * fix: Use LOG_ macros in loc functions by @znelson in crosspoint-reader#1794 ### Internal * refactor: redesign on-screen keyboard by @pablohc in crosspoint-reader#1644 * refactor: replace picojpeg with JPEGDEC for cover art conversion by @jpirnay in crosspoint-reader#1517 * refactor: Refactor drawArc / fillArc for faster execution by @jpirnay in crosspoint-reader#1540 * perf: replace i18n pointer tables with offset tables, strip unused strings by @jpirnay in crosspoint-reader#1408 * refactor: Store only unique localization strings in offset buffers by @znelson in crosspoint-reader#1802 * refactor: Move language setting into JSON settings by @znelson in crosspoint-reader#1796 * refactor: Use C++20 'requires' in ActivityResult constructor by @znelson in crosspoint-reader#1420 * refactor: Use default member initializers for JpegContext and PngContext by @znelson in crosspoint-reader#1435 * refactor: logPrintf and predefined log level strings by @CSCMe in crosspoint-reader#1546 * refactor: RAII scoped open/close for ZipFile by @znelson in crosspoint-reader#1433 * refactor: Deduplicated BMP header writing in Xtc by @znelson in crosspoint-reader#1439 * refactor: Added shared XML parser teardown helper by @znelson in crosspoint-reader#1438 * refactor: Removed redundant FsFile close() calls by @znelson in crosspoint-reader#1434 * refactor: Deduplicate battery drawing code and fix Lyra charging indicator by @znelson in crosspoint-reader#1437 * refactor: Deduplicate Roundraff battery drawing by @znelson in crosspoint-reader#1847 * refactor: Simplify sort in GfxRenderer::fillPolygon by @znelson in crosspoint-reader#1817 * refactor: Avoid vector for page turn rates list by @znelson in crosspoint-reader#1818 * refactor: Use std::size instead of sizeof/sizeof by @znelson in crosspoint-reader#1819 * refactor: Use fixed-size integers for BookMetadataCache data by @znelson in crosspoint-reader#1844 * refactor: Simplify isReaderActivity bookkeeping by @znelson in crosspoint-reader#1838 * refactor: Simplify XtcReaderActivity with detectPageTurn by @znelson in crosspoint-reader#1837 * refactor: change ukrainian translation to adaptation and add missing lines by @KymAndriy in crosspoint-reader#1828 * chore: drop JPEGDEC patch in favour of upstream fix by @martinbrook in crosspoint-reader#1465 * chore: clang-format.fix.ps1 script: Add .venv to list of path exclusions by @jpirnay in crosspoint-reader#1515 * chore: Updating sleep screen dimensions for X3 by @jensechu in crosspoint-reader#1688 * chore: Clarify X3 RTC in SCOPE.md by @znelson in crosspoint-reader#1687 * chore: Improved Italian translations by @znelson in crosspoint-reader#1685 * chore: change ukrainian translation to adaptation by @KymAndriy in crosspoint-reader#1684 * chore: Update spanish.yaml by @mvidelatraduc in crosspoint-reader#1717 * chore: One Italian translation tweak by @znelson in crosspoint-reader#1718 * chore: git pre-commit hook for format fix by @osteotek in crosspoint-reader#1730 * chore: Update SDK to fork in CrossPoint org by @znelson in crosspoint-reader#1836 * chore: Added RAM to firmware_size_history.py script by @znelson in crosspoint-reader#1830 * chore: Updated docs to reflect DESTRUCTOR_CLOSES_FILE=1 by @znelson in crosspoint-reader#1878 * feat: cap compressed group size at 64 KB by @jpirnay in crosspoint-reader#1913 * fix: build-script bug fixes for fontconvert{,_sdcard}.py by @jpirnay in crosspoint-reader#1910 * feat: include short SHA in CROSSPOINT_VERSION by @osteotek in crosspoint-reader#1728 * feat: show long branch names by @steka in crosspoint-reader#1727 * feat: enable pio build cache by @Uri-Tauber in crosspoint-reader#1769 * style: put page name first in browser titles by @fain182 in crosspoint-reader#1703 * style: unify page headers across web UI by @fain182 in crosspoint-reader#1702 * style: move file type badges into Type column by @fain182 in crosspoint-reader#1793 * style: align action buttons vertically with page title by @fain182 in crosspoint-reader#1795 * docs: Update README with firmware flashing instructions by @ryneches in crosspoint-reader#1654 * docs: fix typos by @kianmeng in crosspoint-reader#1705 * docs: update README.md to reflect the current state of crosspoint by @Uri-Tauber in crosspoint-reader#1812 * docs: Add documentation for USB-locked Xteink devices by @itsthisjustin in crosspoint-reader#1990 * docs: expand first use of OPDS acronym and provide a wikipedia link by @sizezero in crosspoint-reader#1824 * docs: fix KOReader sync guide link by @sabraman in crosspoint-reader#1930 * docs: fix hyphenation updater script name by @sabraman in crosspoint-reader#1931 * fix: sd font download urls in docs by @mcrosson in crosspoint-reader#1945 * fix: sd font folder paths in documentation by @mcrosson in crosspoint-reader#1944 * chore: Add verbose mode to build-sd-fonts.py by @znelson in crosspoint-reader#1923 ## New Contributors * @a-ignatev made their first contribution in crosspoint-reader#1566 * @CSCMe made their first contribution in crosspoint-reader#1546 * @thehijacker made their first contribution in crosspoint-reader#1551 * @Telemaniaka made their first contribution in crosspoint-reader#1597 * @Mraulio made their first contribution in crosspoint-reader#1625 * @rxmmah made their first contribution in crosspoint-reader#1462 * @bdeshi made their first contribution in crosspoint-reader#1626 * @DianaNites made their first contribution in crosspoint-reader#1475 * @ryneches made their first contribution in crosspoint-reader#1654 * @zgredex made their first contribution in crosspoint-reader#1411 * @jonvex made their first contribution in crosspoint-reader#1635 * @KymAndriy made their first contribution in crosspoint-reader#1684 * @jensechu made their first contribution in crosspoint-reader#1688 * @kianmeng made their first contribution in crosspoint-reader#1705 * @philips made their first contribution in crosspoint-reader#1535 * @fain182 made their first contribution in crosspoint-reader#1701 * @mvidelatraduc made their first contribution in crosspoint-reader#1717 * @bunsoootchi made their first contribution in crosspoint-reader#918 * @rhoopr made their first contribution in crosspoint-reader#1694 * @spfenwick made their first contribution in crosspoint-reader#1286 * @trilwu made their first contribution in crosspoint-reader#1381 * @jonstieglitz made their first contribution in crosspoint-reader#1589 * @uxjulia made their first contribution in crosspoint-reader#1816 * @mchuck made their first contribution in crosspoint-reader#1069 * @sizezero made their first contribution in crosspoint-reader#1824 * @leecming82 made their first contribution in crosspoint-reader#1849 * @jeremydk made their first contribution in crosspoint-reader#1780 * @WuTofu made their first contribution in crosspoint-reader#1803 * @wylanswets made their first contribution in crosspoint-reader#1860 * @sabraman made their first contribution in crosspoint-reader#1930 * @prawnwhoyawns made their first contribution in crosspoint-reader#1783 * @mcrosson made their first contribution as co-author on SD card font support **Full Changelog**: crosspoint-reader/crosspoint-reader@1.2.0...release/1.3.0 --------- Co-authored-by: Justin Mitchell <justin@jmitch.com> Co-authored-by: Chun Ming Lee <95391408+leecming82@users.noreply.github.com> Co-authored-by: Uri Tauber <uritaube@gmail.com> * Add package settings UI --------- Co-authored-by: Zach Nelson <zach@zdnelson.com> Co-authored-by: Justin Mitchell <justin@jmitch.com> Co-authored-by: Uri Tauber <uritaube@gmail.com> Co-authored-by: Chun Ming Lee <95391408+leecming82@users.noreply.github.com>
Add GROUP_MAX_UNCOMPRESSED_BYTES=65536 on top of the existing script- based grouping. When adding the next glyph would push a group past the cap, the group is closed and a new one started with the same script ID.
Without the cap, the size of a script group is bounded only by however many glyphs the font supplies in that block. Dense scripts (CJK, Vietnamese precomposed, user-supplied fonts with large Unicode blocks) can produce a single group whose uncompressed size exceeds what fits in the embedded decompressor's transient malloc on the ESP32-C3, which manifests as a runtime allocation failure instead of a build error.
The 64 KB ceiling is large enough to hold any single built-in script group with headroom and small enough to be a comfortable transient allocation on-device.
The check uses byte-aligned size (4-pixel-aligned row stride × height), which is what the decompressor actually consumes — not the packed on-disk length. A defensive guard rejects any single glyph whose own size exceeds the cap with a clear error pointing at the offending codepoint.
Summary
Additional Context
specific areas to focus on).
AI Usage
While CrossPoint doesn't have restrictions on AI tools in contributing, please be transparent about their usage as it
helps set the right context for reviewers.
Did you use AI tools to help write this code? < YES | PARTIALLY | NO >