wmkeyboard README

README проекта с github.com/wasi-master/wmkeyboard. Одним файлом markdown: README.md.

WM Keyboard. Type anything. Share nothing.

Private. Offline. Yours.

An open source multilingual Android keyboard with prediction, glide typing, transliteration, emoji search and an 89-tool toolbox that all run on the phone and never phone home.

Latest release Google Play F-Droid Downloads CI Docs Telegram Group Sponsor on SupportKori MIT license

Install · Tour · Languages · Privacy · Builds · FAQ · Build · Read the docs


https://github.com/user-attachments/assets/3bd063a9-6701-4ccd-82ef-edd40a42b8e0

Why I built this

A keyboard is the one app that sees everything you write. Your messages, your passwords, your half-typed thoughts you deleted before sending. Somewhere along the way the popular keyboards decided that was a business model. The prediction got better, and the price for that was a copy of your keystrokes getting sent to somebody else's server.

The keyboards that refused that deal were mostly forks of the same decade-old Android code. Good bones, honest intentions, but no glide typing without a proprietary blob, no real toolbox, and nothing for the language I actually type in. Bangla was an afterthought everywhere: either a phonetic engine bolted on with no prediction, or a layout with no smart features behind it.

So I wanted a keyboard that did three things at once. Type Bangla the way Avro taught a whole country to type it. Carry the features I reach for all day, clipboard, snippets, translate, calculator, scanner, without leaving the text field. And keep all of that on the phone, where it belongs. This is that keyboard. It is written from scratch in Kotlin and Jetpack Compose, keyboard surface included, and the whole intelligence layer runs offline.

A few screenshots

A keyboard that does so much more: feature chips around the keyboard Type it how it sounds: ami valo achi becomes আমি ভালো আছি Everything here runs on your phone: voice typing and AI in airplane mode Rewrite, translate, fix, right on your phone: the AI panel with on-device models A clipboard with superpowers: history, pins, one-time codes Stop switching apps: calculator, dictionary and the toolbox Make it unmistakably yours: emoji search and themes It does that, too: a wall of feature chips

It starts by understanding how you spell

Type a word the way it sounds in Latin letters, and the keyboard finds the word you meant. Every one of these runs on the device, with no network and no delay.

You type You get Engine
ami valo achi আমি ভালো আছি Avro-compatible Bangla phonetic, with a lenient index: asi, achi and achhi all reach আছি
namaste नमस्ते Hindi phonetic with a map of how people actually romanise Hindi
aap kaise ho آپ کیسے ہو Urdu phonetic, folding to the consonant skeleton the script itself spells with
vanakkam, nenu, 3arabi Tamil, Telugu, Arabic script Phonetic layouts for eleven more languages, Arabizi digits included
nihao 你好 Pinyin, including a T9 nine-key variant
konnichiwa こんにちは Romaji to kana with conversion candidates
xin chaof xin chào Vietnamese Telex

The same prediction engine sits behind every one of them, so glide typing, autocorrect and next-word suggestions work in Bangla exactly as they do in English.

The tour

The features the keyboard has

Typing

Typing basics · Glide · Gestures · Modes · Autocorrect

Languages

Languages overview · Bengali · CJK · Custom layouts

Emoji, GIFs and stickers

Emoji picker · Stickers

The toolbox

89 tools sit one tap behind the toolbar, and you drag the ones you use onto it. Most of them work in airplane mode.

Text Clipboard with history, pins, search and screenshot capture. Snippets with {date} and {clip} variables. Text expansion. Undo and redo. Selection mode. A trackpad. Fancy text. Notes.
Numbers A calculator in the suggestion strip. Unit and currency conversion. Calendars, with events you can add and edit.
Words Dictionary, Wikipedia and Look up cards. Translate on device with ML Kit, Firefox Translations or NLLB-200. Grammar check with Harper, fully offline. Vocabulary practice.
Camera Text scan with ML Kit, Tesseract for 100+ languages, or PaddleOCR. QR and barcode with ML Kit or zxing-cpp. Document scanner, Google's or the keyboard's own.
Phone Media controls. An app launcher. KDE Connect. Smart home controls. Sending files. Flashlight. One-time codes caught from notifications.
Voice Android's recogniser with a continuous mode, or offline engines: Whisper on whisper.cpp, Whistle, Asr4All, Parakeet, Moonshine, Sherpa and Omnilingual. A transcription server of your own works too.
Writing AI rewrite, summarise, translate and fix. On-device with LiteRT-LM or GGUF models on llama.cpp, or bring your own key for any provider that speaks the OpenAI shape. Nothing is enabled behind your back.

The toolbar · Clipboard · Whisper · AI tools

Themes

Themes · The editor

Privacy

The typing engine has no network code in it. Prediction, autocorrect, glide, layouts and learning behave identically with the radio off.

Privacy at a glance · Network policy · Your data on device

Extend it

Addons · Plugins · Repository format

The full inventory, if you want numbers

FEATURES.md tracks the surface across 12 areas, three levels deep.

Area Families Features Capabilities
Typing core: prediction, autocorrect, learning, spell check 9 50 205
Input behaviour: glide, gestures, cursor, editing, keys 11 80 220
Languages, scripts, layouts, transliteration 11 65 220
Themes and appearance 14 73 183
Emoji, GIFs, stickers, kaomoji 16 96 94
Toolbar and the tool set 10 88 364
Clipboard, snippets, text expansion 7 37 191
AI, voice, handwriting, scanning 12 81 168
Privacy, backup, storage, statistics 14 70 180
Accessibility, form factors, platform integration 13 61 111
Extensibility: addons, plugins, imports, formats 5 35 164
Modes, rows, field adaptation, runtime 12 97 203
Total 134 830 2,288

Entries marked RARE there are things few or no mainstream keyboards ship. There are over 500.

Builds

One app, three builds. Everything about typing, prediction, themes, languages and privacy is identical. Up to 0.6.2 there were two editions, Full and Lite; from 0.6.3 there is no Lite, and the optional feature libraries download the first time a feature needs them instead.

Standard F-Droid Offline
Where Google Play, GitHub F-Droid GitHub
Handwriting ML Kit, 126 languages zinnia for Chinese and Japanese, PaddleOCR for nine other scripts ML Kit, 126 languages
Text scan ML Kit, Tesseract, PaddleOCR PaddleOCR ML Kit, Tesseract, PaddleOCR
QR and barcode ML Kit or zxing-cpp zxing-cpp ML Kit or zxing-cpp
Document scanner Google's or the built-in one built-in Google's or the built-in one
Grammar check (Harper) ✓ ✓ ✓
Offline Whisper (whisper.cpp), Asr4All, Parakeet, Moonshine, Sherpa, Omnilingual ✓ ✓ ✓
Whisper on LiteRT, Whistle ✓ ✓
On-device AI LiteRT-LM and GGUF GGUF LiteRT-LM and GGUF
On-device translate ML Kit, Firefox Translations, NLLB-200 Firefox Translations, NLLB-200 ML Kit, Firefox Translations, NLLB-200
Google libraries on the compile classpath ML Kit, LiteRT none ML Kit, LiteRT
Feature libraries downloaded on first use downloaded once you allow it in the APK
Internet permission ✓ ✓

The UI-language choice only affects the words the settings app shows you. Every layout and dictionary is in every build.

Which build you have

Install

Get it on Google Play Get it on F-Droid Get the APK from GitHub Get it on Obtainium

Install it, open the app, follow the setup card. Android will warn you that a third-party keyboard can see what you type. It says that about every keyboard, Gboard included, because that is what a keyboard is. F-Droid and GitHub builds share a signing key from 0.5.10 on, so moving between them is an ordinary update. Google Play signs its copy with its own key, so moving between Play and the other two takes a backup, an uninstall and a restore.

Needs Android 7.0 or newer.

Installation · Setup · A two-minute tour

FAQ

Is anything sent to the cloud?
Not by typing, ever. Prediction, autocorrect, glide and the dictionaries all run on the device, and there is no analytics SDK in the app. What needs the internet is a handful of tools that are online services by nature: weather, translate (unless you download the on-device languages), currency rates, Wikipedia, GIF search, web search, and any AI provider you set up with your own key. Each one makes a request only while you are using it. Link previews are the one opt-in background fetch, and it is off by default. Network policy lists every request, tool by tool.
Which build?
The standard one, from Play or GitHub, unless you want F-Droid's (no Google library at all, at the cost of handwriting outside Chinese and Japanese, ML Kit's readers in the scanners, and the LiteRT models for Whisper and on-device AI) or the offline one (no internet permission, everything inside a much larger APK). The GitHub and F-Droid builds share a signing key, so installing one over the other keeps all your data.
Why doesn't glide typing work in my language?
It has no word list installed yet. A swipe is decoded against the active language's dictionary. English and Bangla ship with one. Every other language downloads its list from the language's own settings page, and the suggestion strip offers the download the first time you need it.
Android says "install unknown apps" or Play Protect complains.
Standard behaviour for any APK from outside Google Play. Grant the install permission to whichever app you opened the file with. If you would rather not, F-Droid installs it for you.
Does it use much battery or memory?
Very little. Nothing runs in the background out of the box. The heaviest things it can hold are a Whisper model and a local LLM, and both are released the moment Android signals memory pressure. A dedicated power-saving mode trims per-keystroke work further and can follow Android's battery saver.
Where are my learned words, and how do I wipe them?
In a plain JSON file in the app's private storage. The Personal dictionary screen lets you delete them one at a time. Privacy → Your data → Learned words wipes all 13 learning files in one pass, and a running keyboard drops its in-memory copies the moment you close it.
I installed from F-Droid before 0.5.12 and it won't update.
Those builds were signed with F-Droid's own key, and Android will not update across keys. Export a backup, uninstall, reinstall from F-Droid, import the backup. Every update after that is ordinary.

The docs have a longer FAQ and a troubleshooting page.

Documentation

wmkeyboard.pages.dev is the full manual: pages with screenshots, a settings reference for every screen, and a "verify every claim in code" rule for the people who write it. The wiki mirrors the same pages for reading on GitHub.

Start here Go deeper
Install and set up Architecture
A two-minute tour Building from source
Languages and layouts Dictionary formats
The toolbar Plugin API
Privacy Hosting an addon repository
Settings reference File formats

The source lives in docs/ and runs on Astro Starlight. npm run dev in that folder gives you a local preview.

Community

Build it yourself

You need a JDK 17 or newer to launch Gradle, and the Android SDK with compileSdk 37. Gradle provisions its own toolchain through Foojay on the first build. Android Studio's bundled JBR works well as JAVA_HOME.

./gradlew assembleIntlDebug       # every UI language
./gradlew assembleEnDebug -Pwmkb.enableFdroid=true   # what F-Droid builds, English UI
./gradlew unitTests               # the whole suite, ~9,500 tests
./gradlew staticAnalysis          # detekt + Android Lint, 20+ minutes

The task name is the UI-language build, then the build type. Two flags in local.properties matter: the build channel (Play versus direct download), which decides whether the ML models and LLM runtime ship inside the APK or download on demand, and a no-internet switch that strips the permission entirely.

Project layout

27 Gradle modules in every build, layered bottom-up, plus one Play feature module per native gate when building for Play. Every dependency points downward, and the engines under core/ keep android.* out of the files that do the real work, so they test on a plain JVM.

app/                  Settings app, manifest, resources, bundled assets, most unit tests
feature/
├── ime/              WMKeyboardService and the Compose keyboard UI (the keyboard itself)
├── addons/           Addon install, reconcile, download
├── tools/            Network tool clients: AI, GIF and sticker, search, link preview
└── <gate>/           23 on-demand Play modules, one per native gate (llm, translate, speech,
                      onnx, llama, bergamot, rime, mozc, zxing, ...), listed in native/gates.json
core/
├── settings/         SettingsRepository (DataStore), KeyboardSettings, modes, power saving
├── intelligence/     Grammar, on-device AI, translation, handwriting, scanners, spell checker service
├── feedback/         Key sounds and haptics
├── voice/            SpeechRecognizer plus the offline dictation engines
├── plugins/          Lua plugin sandbox
├── addons/           Addon store and repository data layer
├── content/          Clipboard, snippets, fonts, media, stickers
├── tools/            Offline tool engines: calc, units, currency, symbols, calendars
├── kdeconnect/       KDE Connect client
├── send/             Send (Firefox Send fork) client: encrypted file links
├── homeassistant/    Home Assistant client
├── smarthome/        The smart home tool's other providers
├── icons/            Icon packs and the SVG parser
├── theme/            ThemeSpec, palettes, rendering
├── emoji/            Catalog loader, semantic search, usage tracking
├── prediction/       Trie, SuggestionEngine, UserLexicon, dictionaries, gestures
├── input/            Composers (CJK, cluster scripts) and the input pipeline
├── keyman/           Keyman keyboard import
├── language/         Scripts, layouts, transliteration
├── common/           Utilities, direct boot, debug log, shared contracts
└── config/           Build flags and API keys
tools/dictc/          Host-side dictionary compiler, shares :core:prediction sources
tools/architecture/   Konsist architecture rules over the whole source tree
native/               wm-engine (the Rust text engines, shared with WMK Desktop) and its JNI bridge,
                      plus the JNI builds behind every gate; gates.json lists them all
docs/                 The documentation site (Astro Starlight)

Building · Testing · Architecture

Contributing

The easiest first contributions are testing out the app and submitting bug reports or feature requests, not code. You can also update the data which lives in a companion repository, wasi-master/wmkeyboard-data:

For code: commits follow Conventional Commits, type(scope): summary. Run unitTests and staticAnalysis before you open a pull request, since CI runs only the first. Open an issue first for anything larger than a fix so we can agree on the shape of it.

Contributing guide

Credits

WM Keyboard stands on a lot of open work. The in-app About screen carries the full licence text for each of these, and app/src/main/assets/licenses/ holds the same files.

How this was made

This keyboard was developed entirely by me, with the assistance of Generative AI for certain planning tasks and more tedious aspects of the development process.

For most features, I write the code myself, occasionally using AI-assisted code completion within my editor. For more complex features, I use Claude Code with Anthropic’s frontier models to assist with planning and, where appropriate, generate boilerplate code. For particularly repetitive or time-consuming tasks, I may delegate the implementation to Claude Code in its entirety.

Regardless of how AI is used, I remain involved throughout the development process. I review everything it generates, make the necessary decisions and adjustments, and test the resulting implementation whenever possible. AI is an assistant in the workflow, not a replacement for my involvement or responsibility for the code.

If AI-assisted code is a boundary you are unwilling to cross, I completely respect that position. There are some quite good keyboards developed without AI assistance. However, I believe it is increasingly difficult to disregard AI as a valuable and increasingly integral part of modern software development workflows. Whether we welcome it or not, AI-assisted development is here to stay.

License

MIT. See LICENSE.

wmkeyboard (wasi-master/wmkeyboard)

Ищем в базе…

Что это такое?Открытая многоязычная клавиатура для Android с предсказанием слов, вводом свайпом, транслитерацией, поиском эмодзи и набором инструментов из 89 утилит. Всё работает на телефоне, и ничего не отправляется на сервер.
Это полноценное приложение-клавиатура или просто дополнение к раскладке?Полноценное приложение-клавиатура, написанное с нуля на Kotlin и Jetpack Compose, включая сам экран клавиатуры. Это метод ввода для Android, поэтому переключаться на него нужно прямо во время набора текста.
Какую сборку выбрать?Выбирайте Standard, если нужен Google Play и все функции ML Kit, F-Droid, если не нужны библиотеки Google вообще, или Offline, если нужен APK без разрешения на доступ в интернет.
Все функции полностью приватны?Не совсем. В стандартной сборке рукописный ввод и сканеры работают на ML Kit от Google, который отправляет Google собственную диагностику. В сборках F-Droid и Offline этого нет.
Работает ли набор текста без интернета?Да. Предсказание, автоисправление, ввод свайпом, раскладки и обучение работают так же при выключенной сотовой связи и Wi-Fi.
Собирает ли приложение данные и нужна ли учётная запись?Нет SDK для аналитики, нет отчётов о сбоях и нет учётной записи. Выученные слова, история буфера обмена и статистика набора хранятся в памяти приложения и стираются одним нажатием.
Хорошо ли поддерживается набор на бенгальском?Да. Доступны раскладки Avro phonetic, Probhat, Jatiya и Khipro, backspace, который учитывает конъюнкты, и смешивание бенгальского с английским в одном поле.
Функции ИИ включены по умолчанию?Нет. Переписывание, краткое изложение, перевод и исправление с ИИ работают на устройстве с моделями LiteRT-LM или GGUF либо с вашим ключом для провайдера, совместимого с OpenAI. Ничего не включается без вашего ведома.
Есть ли темы и наборы стикеров?Да. Есть полный редактор тем, Material You, AMOLED и 32 встроенные темы, а также наборы стикеров, которые можно создать из собственных фотографий.
Какие есть похожие проекты?CyIME, WowType, vivi-music, xsime, nectarlink, blockads-android, msime-windows, AhSilence
Автор
wasi-master
Размер
688.5 MB
Звёзды
1K
Возраст
3 мес
Коммиты · 90 дней