Re-TUI-Keys

Re:TUI Keyboard is a local-first Android IME built to match the Re:TUI launcher visual language while still behaving like a normal keyboard.

The project is intentionally offline. The keyboard has no INTERNET permission, does not call a hosted model, and keeps learned words in local app storage with manual backup and restore.

Current Status

• Version: 0.1.13
• Package: com.dvil.retui.keyboard
• Minimum Android version: API 26
• Target Android version: API 36
• Distribution: GitHub Releases

Tech Stack

• Kotlin
• Native Android InputMethodService
• Programmatic Android Views for the keyboard and settings UI
• Gradle Android Plugin 8.5.2
• Kotlin plugin 2.2.10
• Android SharedPreferences for local settings and dictionary storage
• Android Storage Access Framework for dictionary backup and restore
• org.json for the local dictionary export format

There are no Compose, webview, backend, telemetry, or online suggestion-model dependencies.

Features

• Re:TUI styled keyboard surface with terminal/cyberdeck-inspired panels.
• QWERTY, numeric, and symbol layouts.
• Shift supports one-shot capitalization and caps lock by double tap.
• Long-press alternate characters with preview popups.
• Local suggestion strip above the keyboard.
• User dictionary with visible local word list in settings.
• Manual dictionary add/remove, backup, and restore.
• Theme sync from the launcher through IME-private data.
• Optional number row, arrow row, quick period, haptics, sound, sizing, margins, key gaps, stroke width, and background image controls.

Local Suggestions

Suggestions are implemented entirely on-device in LocalDictionary.

The engine combines:

• a small built-in seed vocabulary for basic prefix suggestions;
• a local user dictionary stored as JSON in SharedPreferences;
• frequency and last-used timestamps for ranking learned words;
• case matching so suggestions follow the user's typed prefix.

When the user types, the IME reads the current word before the cursor and refreshes the suggestion strip. Tapping a suggestion replaces the current word and inserts a trailing space.

When the user finishes a custom word with a boundary such as space, punctuation, or enter, the keyboard can learn that word locally. Common built-in words are not added to the user dictionary automatically, which keeps the visible dictionary focused on custom vocabulary.

If the current word is valid but unknown, the strip can show a + word action. That action manually adds the word to the local dictionary. When there are no real suggestions or add-word actions, the strip stays empty instead of showing placeholder status chips.

Dictionary Settings

The settings screen includes a DICTIONARY section:

• LOCAL WORDS shows the number of learned user words.
• The add field lets users manually add a word.
• Each learned word is listed with its frequency and a remove button.
• BACKUP DICTIONARY writes a JSON file selected by the user.
• RESTORE DICTIONARY reads a JSON backup selected by the user.

Backup and restore are manual by design. The manifest disables Android backup and includes explicit backup/data extraction exclusion rules, so dictionary data stays local unless the user exports it.

Launcher Theme Bridge

The keyboard can receive Re:TUI launcher theme data through standard IME channels:

• InputMethodManager.sendAppPrivateCommand
• EditorInfo.extras
• EditorInfo.privateImeOptions

The IME reads color, border, typography, cyberdeck, CRT, and context values from those payloads, applies them to the keyboard surface, and persists the latest theme snapshot locally.

The keyboard still works without the launcher. In that case it uses its built-in terminal theme defaults.

Building

./gradlew assembleDebug

For a minified release build:

./gradlew assembleRelease

The debug APK is signed with the standard Android debug key and is suitable for sideload testing. The minified release APK is unsigned until a release signing configuration is added, so store distribution should use a properly signed release artifact.

Project Layout

• app/src/main/java/com/dvil/retui/keyboard/RetuiKeyboardService.kt: IME service, keyboard layouts, key handling, theme bridge, and suggestion strip.
• app/src/main/java/com/dvil/retui/keyboard/LocalDictionary.kt: local dictionary, ranking, learning, import, and export.
• app/src/main/java/com/dvil/retui/keyboard/KeyboardSettingsActivity.kt: settings UI, preview surface, dictionary management, and backup/restore.
• app/src/main/java/com/dvil/retui/keyboard/KeyboardPrefs.kt: persisted keyboard layout and typing preferences.
• app/src/debug/java/com/dvil/retui/keyboard/KeyboardProbeActivity.kt: debug-only probe activity for previewing the IME.

Privacy Model

• No network permission.
• No online suggestion service.
• No telemetry.
• No cloud backup.
• User dictionary backup and restore are explicit file-picker actions.

This keeps the keyboard aligned with the local-only Re:TUI launcher model.