HeliBoard is a privacy-conscious and customizable open-source keyboard, based on AOSP / OpenBoard. Does not use internet permission, and thus is 100% offline.

• Features
  • FAQ / Common Issues
  • Hidden Functionality
• Contributing
  • Reporting Issues
  • Translation
  • Dictionary Creation
  • Code Contribution
• To-do
• License
• Credits

• Add dictionaries for suggestions and spell check
  • build your own, or get them here, or in the experimental section (quality may vary)
  • additional dictionaries for emojis or scientific symbols can be used to provide suggestions ("emoji search")
  • note that for Korean layouts, suggestions only work using this dictionary, the tools in the dictionary repository are not able to create working dictionaries
• Customize keyboard themes (style, colors and background image)
  • can follow the system's day/night setting on Android 10+ (and on some versions of Android 9)
  • can follow dynamic colors for Android 12+
• Customize keyboard layouts (only when disabling use system languages)
• Multilingual typing
• Glide typing (only with closed source library)
  • library not included in the app, as there is no compatible open source library available
  • can be extracted from GApps packages ("swypelibs"), or downloaded here
  • if you are concerned about security implications of loading user-provides libraries, please use the nouserlib build variant, which removes this option. If HeliBoard is installed as system app, and swypelibs are available for the system, they will be used.
  • If the app is installed as a system app and swypelibs are available, glide typing will be available independent of the version.
• Clipboard history
• One-handed mode
• Split keyboard (if the screen is large enough)
• Number pad
• Backup and restore your learned word / history data

• Add a dictionary: First download the dictionary file, e.g. from here. Then go to language settings, click on the language, then on + next to dictionary the add and select the file. Alternatively you can open a .dict file in a file explorer with HeliBoard and then select the language. Note that the latter method does not work with all file explorers.

• Emoji search: You can get addon dictionaries for emoji suggestions in the dictionaries repo. An actual search function does not exist yet.

• Cannot switch choose layout: This is only possible when use system languages is disabled.

• No suggestions for some language: Check dictionaries repo whether a dictionary is available. If there is one, download it and add it in the language settings for this language.

• No suggestions in some app / text field: This app respects the no suggestions flag set by some input fields, i.e. the developer does not want you to see suggestions here. Best do in issue report for that app if you think this behavior is wrong. Alternatively you can enable the always show suggestions setting that overrides the no suggestions flag.

• How to enable glide typing: There is no glide typing built into this app, but you can load compatible libraries: Go to advanced settings -> load gesture typing library and point to a file (setting not available in nouserlib version). You can extract the file from GApps packages ("swypelibs"), or download one here. Make sure to use the correct version (app will tell you in the dialog to load the library).

• What is the nouserlib version?: The normal version (release) allows the user to provide a library for glide typing. Running code that isn't supplied with the app is dynamic code loading, which is a security risk. Android Studio warns about this:

  Dynamically loading code from locations other than the application's library directory or the Android platform's built-in library directories is dangerous, as there is an increased risk that the code could have been tampered with. Applications should use loadLibrary when possible, which provides increased assurance that libraries are loaded from one of these safer locations. Application developers should use the features of their development environment to place application native libraries into the lib directory of their compiled APKs.

  The app checks the SHA256 checksum of the library and warns the user if it doesn't match with known library versions. A mismatch indicates the library was modified, but may also occur if the user intentionally provides a different library than expected (e.g. a self-built variant).

• (to be expanded...)

Features that may go unnoticed, and further potentially useful information

• Long-pressing the Clipboard Key (the optional one in the suggestion strip) pastes system clipboard contents.
• Long-pressing keys in the suggestion strip toolbar pins them to the suggestion strip.
• Long-press the Comma-key to access Clipboard View, Emoji View, One-handed Mode, Settings, or Switch Language:
  • Emoji View and Language Switch will disappear if you have the corresponding key enabled;
  • For some layouts it's not the Comma-key, but the key at the same position (e.g. it's q for Dvorak layout).
• When incognito mode is enabled, no words will be learned, and no emojis will be added to recents.
• Sliding key input: Swipe from shift to another key to type a single uppercase key
  • This also works for the ?123 key to type a single symbol from the symbols keyboard, and for related keys.
• Long-press the ?123 from main view to directly open numpad.
• Long-press a suggestion in the suggestion strip to show more suggestions, and a delete button to remove this suggestion.
• Swipe up from a suggestion to open more suggestions, and release on the suggestion to select it.
• Long-press an entry in the clipboard history to pin it (keep it in clipboard until you unpin).
• Swipe left in clipboard view to remove an entry (except when it's pinned)
• You can add dictionaries by opening the file
  • This only works with content-uris and not with file-uris, meaning that it may not work with some file explorers.
• When using debug mode / debug APK
  • Long-press a suggestion in the suggestion strip twice to show the source dictionary.
  • When using debug APK, you can find Debug Settings within the Advanced Preferences, though the usefulness is limited except for dumping dictionaries into the log.
  • In the event of an application crash, you will be prompted whether you want the crash logs when you open the Settings.
  • When using multilingual typing, space bar will show an confidence value used for determining the currenly used language.
  • Suggestions will have some tiny numbers on top showing some internal score and source dictionary (can be disabled)
• For users doing manual backups with root access: Starting at Android 7, some files and the main shared preferences file are not in the default location, because the app is using device protected storage. This is necessary so the settings and layout files can be read before the device is unlocked, e.g. at boot. The files are usually located in /data/user_de/0/<package_id>/, though the location may depend on the device and Android version.

Whether you encountered a bug, or want to see a new feature in HeliBoard, you can contribute to the project by opening a new issue here. Your help is always welcome!

Before opening a new issue, be sure to check the following:

• Does the issue already exist? Make sure a similar issue has not been reported by browsing existing issues. Please search open and closed issues.
• Is the issue still relevant? Make sure your issue is not already fixed in the latest version of HeliBoard.
• Did you use the issue template? It is important to make life of our kind contributors easier by avoiding issues that miss key information to their resolution. Note that issues that that ignore part of the issue template will likely get treated with very low priority, as often they are needlessly hard to read or understand (e.g. huge screenshots, or addressing multiple topics).

Translations can be added using Weblate. You will need an account to update translations and add languages. Add the language you want to translate to in Languages -> Manage translated languages in the top menu bar. Updating translations in a PR will not be accepted, as it may cause conflicts with Weblate tranlations.

There will not be any further dictionaries bundled in this app. However, you can add dictionaries to the dictionaries repository. To create or update a dictionary for your language, you can use this tool. You will need a wordlist, as described here and in the repository readme.

HeliBoard project is based on Gradle and Android Gradle Plugin. To get started, you can install Android Studio, and import project 'from Version Control / Git / Github' by providing this git repository URL (or git SSH URL). Of course you can also use any other compatible IDE, or work with text editor and command line.

Once everything is up correctly, you're ready to go!

HeliBoard is a complex application, when contributing, you must take a step back and make sure your contribution:

• Is actually wanted. Best check related open issues before you start working on a PR. Issues with "PR" and "contributor needed" labels are accepted, but still it would be good if you announced that you are working on it. If there is no issue related to your intended contribution, it's a good idea to open a new one to avoid disappointment of the contribution not being accepted. For small changes or fixing obvious bugs this step is not necessary.
• Is only about a single thing. Mixing unrelated contributions into a single PR is hard to review and can get messy.
• Has a proper description. What your contribution does is usually less obvious to reviewers than for yourself. A good description helps a lot for understanding what is going on, and for separating wanted from unintended changes in behavior.
• Uses already in-place mechanism and take advantage of them. In other terms, does not reinvent the wheel or uses shortcuts that could alter the consistency of the existing code.
• Has a low footprint. Some parts of the code are executed very frequently, and the keyboard should stay responsive even on older devices.
• Does not bring any non-free code or proprietary binary blobs. This also applies to code/binaries with unknown licenses. Make sure you do not introduce any closed-source library from Google. If your contribution contains code that is not your own, provide a link to the source.
• Complies with the user privacy principle HeliBoard follows.

In addition to previous elements, HeliBoard must stick to F-Droid inclusion guidelines.

See layouts.md for how to add new layouts to the app.

See make-emoji-keys tool README.

See make-dict-list tool README.

Planned features and improvements

• Customizable functional key layout
  • Will likely result in having the same functional key layout for alphabet and symbols layouts
  • Requires adjusting names and codes for compatibility with FlorisBoard layouts
• Support for "special keys" like alt and ctrl (#479)
• Less complicated addition of languages (e.g. #519)
• Additional and customizable key swipe functionality
  • Some functionality will not be possible when using glide typing
• Ability to enter all emojis independent of Android version (optional, #297)
• (limited) support for customizing all internally used colors
• Add and enable emoji dictionaries by default (if available for language)
• Clearer / more intuitive arrangement of settings
  • Maybe hide some less used settings by default (similar to color customization)
• Bug fixes

HeliBoard (as a fork of OpenBoard) is licensed under GNU General Public License v3.0.

Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.

See repo's LICENSE file.

Since the app is based on Apache 2.0 licensed AOSP Keyboard, an Apache 2.0 license file is provided too.

• Icon by Marco TLS
• OpenBoard
• AOSP Keyboard
• LineageOS
• Simple Keyboard
• Indic Keyboard
• FlorisBoard
• Our contributors