Inx is a community firmware for Xteink e-paper readers. It is focused on a cleaner reading experience, better EPUB support, native image rendering, SD-card fonts, and practical device tools.
This project is a fork of CrossPoint and is not affiliated with Xteink.
What You Can Do
Read EPUB, XTC / XTCH, TXT, and MD files.
Browse books from Recent, Library, Settings, File Transfer, and Statistics tabs.
Use EPUB features such as bookmarks, annotations, dictionary lookup, go-to-percent, table of contents, footnotes, per-book settings, and KOReader sync.
Render JPEG, PNG, and BMP images directly.
Use 1-bit or 2-bit image rendering.
Cache rendered images and system data for faster repeat loads.
Use custom sleep screens, recent-book sleep screens, transparent cover sleep screens, or date/time sleep screens on supported devices.
Install reader fonts from the SD card instead of baking large fonts into firmware.
Connect to Wi-Fi, Calibre, OPDS catalogs, KOReader sync, and the local web file manager.
Tune reader layout, buttons, fonts, status bar, refresh behavior, image quality, and display options.
Main Features
Reader
EPUB paging with saved progress.
EPUB layout support for tables, drop caps, borders, images, lists, blockquotes, superscript/subscript, and common CSS spacing/alignment.
EPUB text annotation and highlight support.
EPUB dictionary lookup using StarDict dictionaries stored on the SD card.
EPUB bookmarks.
Go to a specific percentage in an EPUB.
Table of contents, bookmark, annotation, and footnote navigation from the in-book menu.
EPUB menu tools for deleting cache/progress, deleting a book, generating full data, and regenerating thumbnails.
Per-book reader settings and reader presets.
Reading statistics.
KOReader sync support.
TXT / MD reader.
XTC / XTCH reader with chapter selection.
Auto page turn support for EPUB and XTC reading.
Images
Native JPEG rendering.
Native PNG rendering.
BMP rendering.
1-bit and 2-bit image modes.
Low, medium, and high image quality options for reader images.
Low, medium, and high sleep image quality options.
Display cache for faster repeated image draws.
Improved image scaling and dithering.
Cover, thumbnail, and sleep-screen rendering options.
Thumbnail generation for EPUB and XTC books.
Library
Recent books page.
Folder-based library browser.
Flat all-books view.
Cover shelf view for EPUB and XTC books.
Tag view when the library index is enabled.
Favorites.
Sort options by title, group/folder, reading state, and tag.
Optional indexed library mode for faster browsing and tag management.
List and grid library modes.
Display
Text anti-aliasing.
Configurable refresh frequency.
Optional half refresh when opening main tabs.
Sleep screen modes:
Dark
Light
Custom image
Recent book
Transparent cover
None
Date/time on supported devices
Custom sleep images from /sleep/, /sleep.bmp, /sleep.jpg, or /sleep.jpeg.
Sync & Network
Join Wi-Fi networks.
Create a hotspot.
Connect to Calibre.
Browse OPDS catalogs.
Use KOReader sync.
Upload files through the local web interface.
Settings
Settings are split into simple System and Reader panels.
System settings include:
Sleep screen.
Sleep image picker.
Recent page mode.
Library mode.
Button layout.
Power button behavior.
Time to sleep.
Library indexing.
Library custom sort.
Cache clearing.
Thumbnail generation.
KOReader, OPDS, Calibre, and OTA update tools.
About page with device memory information.
Reader settings include:
Font family and size.
SD-card font families.
Line height and word spacing.
Screen margins.
Paragraph alignment.
CSS indentation.
Reading orientation.
Hyphenation.
Bionic Reading.
Page navigation mapping.
Long-press chapter or page skipping.
Auto page turn.
Text anti-aliasing.
Image grayscale / 2-bit rendering.
Smart refresh on image-heavy pages.
Status bar layout.
Web Interface
The local web interface includes:
Dashboard: device status, IP address, Wi-Fi strength, memory, uptime, and quick links.
Files: browse folders, upload files, create folders, delete files, upload cover art to /sleep, and set folder thumbnails.
Flash the firmware using the OTA fast flash controls.
To return to the official firmware, flash the latest official firmware from xteink.dve.al or use the debug page to swap boot partitions.
Development
Requirements
PlatformIO Core (pio) or VS Code with PlatformIO.
Python 3.8 or newer.
USB-C cable.
SDL2 for simulator builds.
Clone
bash
git clone --recursive https://github.com/obijuankenobiii/inx
cd inx
If you already cloned without submodules:
bash
git submodule update --init --recursive
Build
bash
pio run
Flash
bash
pio run --target upload
Web Assets
The firmware embeds the HTML and JS from src/network/html and data/js.
bash
python3 scripts/build_html.py
pio run also regenerates these files before compiling.
Simulator
Inx includes two native simulator targets based on the CrossPoint simulator.
For the full SDL/device UI simulator:
bash
CROSSPOINT_SIM_SD=./fs_ pio run -e simulator -t run_simulator
For dashboard-only testing:
bash
CROSSPOINT_SIM_SD=./fs_ pio run -e simulator_web -t run_simulator
The simulator stores its SD-card data in the folder passed through CROSSPOINT_SIM_SD. The firmware web server is exposed at http://127.0.0.1:8080/ when the simulated device starts a hotspot or local network server.