How majbyr/komi-keyboard-ios works
Project type and purpose
• This is an iOS keyboard application (“Komi keyboard”) composed of two deliverables in a single Xcode workspace:
a) A host iOS app (“mainapp”) for setup/configuration and App Store distribution
b) A keyboard extension (“keyboard”) implementing custom Komi layouts with prediction models
• Supporting modules generate and package statistical language models for different scripts (cyrillic, latin, anbur)
File structure
• Top-level directories:
– anbur, cyrillic, latin: each defines a script’s Info.plist (keyboard identifier), KeyboardLayouts.swift, and locale strings
– keyboard: the actual extension target – UI components (KeyRow, KeyBase, KeyPopup), controller (KeyboardViewController), PredictionEngine, assets
– mainapp: the container iOS app – AppDelegate, SceneDelegate, ViewController, UI for user settings & install instructions
– models_create: Python scripts (prepare.py, optimize.py) to build JSON language‐model artifacts under cyrillic/models
• Build/deployment:
– komikeyboard.xcodeproj ties together mainapp and keyboard extension; Info.plist configurations, asset catalogs, localization folders
– .xcshareddata and schemes define build targets for the host app and extension
README for additional insights
• Confirms iOS 13+ target, Xcode 12.5+ requirement
• Describes the app and points to App Store and screenshots (no architecture details)
a. Main components:
1) Host iOS App (“mainapp”)
2) Keyboard Extension (“keyboard”)
3) Language‐Model Generator Scripts (“models_create”)
4) Script Modules (anbur, cyrillic, latin) each providing layout code and locale bundles
5) JSON Model Artifacts (unigram, bigram, trigram, cap_patterns, completion)
6) iOS System Services (InputMethodKit, App Group / UserDefaults for settings)
b. Relationships & interactions:
– models_create → JSON artifacts → bundled into keyboard extension
– each script module → compiled resource in extension (Info.plist, .xcstrings, KeyboardLayouts.swift)
– mainapp ↔ UserDefaults (or App Group) ↔ keyboard extension for user preferences (enabled layouts, predictions toggle)
– keyboard extension UI (KeyboardViewController) uses PredictionEngine → loads JSON models → makes suggestions
– KeyboardView emits text input events → delivered to host app through standard iOS input APIs
c. Architectural patterns & design principles:
– iOS App‐Extension pattern: separation of host app vs extension sandbox
– MVC for host app (ViewController, extensions.swift helpers)
– Modular layout definition per script for extensibility (anbur, latin, cyrillic)
– Data‐driven prediction engine leveraging precomputed probability tables
d. Key technologies/frameworks:
– Swift, UIKit, InputMethodKit
– Info.plist localization (.xcstrings) for multilingual support
– Python for offline model generation
Essential details to capture
– Distinct boundaries: Host App vs Extension vs External Scripts
– Model artifact lifecycle (generation → bundling → runtime usage)
– iOS system dependencies (InputMethodKit hooks, App Group)