# Technical Documentation: HeliBorg/HeliBoard > ℹ️ **Provenance:** Multi-Tier Ingestion · [CodeWiki Reference](https://codewiki.google/github.com/HeliBorg/HeliBoard) ### Overview (`README.md`) # HeliBoard HeliBoard is a privacy-conscious and customizable open-source keyboard, based on AOSP / OpenBoard. Does not use internet permission, and thus is 100% offline. [Get it on F-Droid](https://f-droid.org/packages/helium314.keyboard/) [Get APK from GitHub](https://github.com/HeliBorg/HeliBoard/releases/latest) [Get it on IzzyOnDroid](https://apt.izzysoft.de/fdroid/index/apk/helium314.keyboard) ## Table of Contents - [Features](#features) - [Contributing](#contributing-) * [Reporting Issues](#reporting-issues) * [Translations](#translations) * [To Community](#to-community) * [Code Contribution](CONTRIBUTING.md) - [Links](#links) - [License](#license) - [Credits](#credits) * [Funding](#funding) # Features For [FAQ](https://github.com/HeliBorg/HeliBoard/wiki/FAQ), [hidden features](https://github.com/HeliBorg/HeliBoard/wiki/9.-Hidden-features) and more information about the app and features, please visit the [wiki](https://github.com/HeliBorg/HeliBoard/wiki) # Contributing ❤ ## Reporting Issues 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](https://github.com/HeliBorg/HeliBoard/issues). 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](https://github.com/HeliBorg/HeliBoard/issues?q=). Please search open and closed issues. In case of feature requests you could also check the [FAQ](https://github.com/HeliBorg/HeliBoard/wiki/FAQ) and [hidden features](https://github.com/HeliBorg/HeliBoard/wiki/9.-Hidden-features). - **Is the issue still relevant?** Make sure your issue is not already fixed in the latest version of HeliBoard. - **Is it a single topic?** If you want to suggest multiple things, open multiple issues. - **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. - **Is it written by a human?** Do not use LLMs or similar to generate issues. Having LLMs help with translation or similar is acceptable, but must be disclosed. See also [AI_USAGE.md](AI_USAGE.md) 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, not providing a proper description, or addressing multiple topics). Blatant violation of the guidelines may result in the issue getting closed. If you're interested, you can read the following useful text about effective bug reporting (a bit longer read): https://www.chiark.greenend.org.uk/~sgtatham/bugs.html ## Translations Translations can be added using [Weblate](https://translate.codeberg.org/projects/heliboard/). 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 translations. Some notes on translations * when translating metadata, translating the changelogs is rather useless. It's available as it was requested by translators. * the `hidden_features_message` is horrible to translate with Weblate, and serves little benefit as it's just a copy of what's already in the wiki: https://github.com/HeliBorg/HeliBoard/wiki/9.-Hidden-features. It's been made available in the app on user request/contribution. ## To Community There is the [discussions on GitHub](https://github.com/HeliBorg/HeliBoard/discussions), or if you prefer a more open network there is [Lemmy](https://lemmy.world/c/Heliboard). You can share your themes, layouts and dictionaries with other people: * Themes can be saved and loaded using the menu on top-right in the _adjust colors_ screen * you can share custom colors in a separate [discussion section](https://github.com/HeliBorg/HeliBoard/discussions/categories/custom-colors) * there are theme collections available at [Star-Trowa/heliboard-themes](https://github.com/Star-Trowa/heliboard-themes) and [PickleHik3/droid-tings](https://github.com/PickleHik3/droid-tings) * Custom keyboard layouts are text files whose content you can edit, copy and share * this applies to main keyboard layouts and to special layouts adjustable in advanced settings * see [layouts.md](layouts.md) for details * you can share custom layouts in a separate [discussion section](https://github.com/HeliBorg/HeliBoard/discussions/categories/custom-layout) * [Roccobot's Layout Maker](https://roccobot.github.io/HeliBoard-RLM/) is a browser-based editor for json layout files * Creating dictionaries is a little more work * first you will need a wordlist in the format from [here](https://codeberg.org/Helium314/aosp-dictionaries/src/branch/main/wordlists/sample.combined) and in the repository readme * you can load the wordlist dictionary directly in HeliBoard like you would load a dictionary, but other AOSP keyboard forks will likely need the .dict file * then you need to compile the dictionary using [external tools](https://github.com/remi0s/aosp-dictionary-tools) * when you want to add the dictionary to the [repository](https://codeberg.org/Helium314/aosp-dictionaries/), no need to compile to a .dict file * the resulting file (and ideally the wordlist too) can be shared with other users * note that there will not be any further dictionaries added to this app, but you can add dictionaries to the [dictionaries repository](https://codeberg.org/Helium314/aosp-dictionaries) ## Code Contribution See [Contribution Guidelines](CONTRIBUTING.md) # Links * Info * [Wiki](https://github.com/HeliBorg/HeliBoard/wiki), including FAQ, help on customizing layouts, and gesture data gathering * [Layout documentation](layouts.md) (more technical info regarding layout customization) * [For creating custom dictionaries](https://codeberg.org/Helium314/aosp-dictionaries#wordlist-information) (see also top of the linked readme) * Community * [Lemmy](https://lemmy.world/c/Heliboard) * [Reddit](https://www.reddit.com/r/HeliBoard) * GitHub [discussions](https://github.com/HeliBorg/HeliBoard/discussions) * Other * [Translations](https://translate.codeberg.org/projects/heliboard/) * [Dictionaries](https://codeberg.org/Helium314/aosp-dictionaries) * [k3lp](https://codeberg.org/k3lp/k3lp) is a WIP library for keyboard layout parsing that will be implemented in HeliBoard when ready (created by [FlorisBoard](https://github.com/florisboard/florisboard/) maintainers) * [swipe-o-scope](https://codeberg.org/eclexic/swipe-o-scope) for visualizing gesture data as created when using gesture data gathering # License 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](/LICENSE) file. Since the app is based on Apache 2.0 licensed AOSP Keyboard, an [Apache 2.0](LICENSE-Apache-2.0) license file is provided. The icon is licensed under [Creative Commons BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/). A [license file](LICENSE-CC-BY-SA-4.0) is also included. # Credits - Icon by [Fabian OvrWrt](https://github.com/FabianOvrWrt) with contributions from [The Eclectic Dyslexic](https://github.com/the-eclectic-dyslexic) - [OpenBoard](https://github.com/openboard-team/openboard) - [AOSP Keyboard](https://android.googlesource.com/platform/packages/inputmethods/LatinIME/) - [LineageOS](https://review.lineageos.org/admin/repos/LineageOS/android_packages_inputmethods_LatinIME) - [Simple Keyboard](https://github.com/rkkr/simple-keyboard) - [Indic Keyboard](https://gitlab.com/indicproject/indic-keyboard) - [FlorisBoard](https://github.com/florisboard/florisboard/) - Our [contributors](https://github.com/HeliBorg/HeliBoard/graphs/contributors) ## Funding This project is funded through [NGI Mobifree Fund](https://nlnet.nl/mobifree), a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) program. Learn more at the [NLnet project page](https://nlnet.nl/project/GestureTyping). [NLnet foundation logo](https://nlnet.nl) Further the project benefits from donations provided by many users (thank you all!). --- ### Overview (`tools/make-emoji-keys/README.md`) # make-emoji-keys This module takes care of generating emoji data bundled with HeliBoard. Basically data is generated in three steps: 1. Unicode emoji table provides code points and grouping plus ordering. 2. Local file lists every new emojis supported for every android version since 4.4. 3. Emoji sequences are merged with their base version and formatted into android resource file. ### Generate emoji-categories.xml A gradle task called 'makeEmoji' builds and runs this tool to generate android resource file which. Path to HeliBoard's res directory is automatically set so the file is ready to be bundled at build. ### Update to latest emoji version * Get new emoji data from Unicode official repository located here: https://unicode.org/Public/emoji. * Create a new directory in [/src/main/resources/emoji/ucd](/tools/make-emoji-keys/src/main/resources/emoji/ucd) and name it as a decimal number corresponding to Unicode's version. * Update [android-emoji-support.txt](/tools/make-emoji-keys/src/main/resources/emoji/android-emoji-support.txt) with new emojis supported in latest Android versions. * Build the jar necessary for emoji update (`./gradlew jar`) * Either run `./gradlew tools:make-emoji-keys:makeEmoji` or start the `makeEmoji` task via the IDE --- --- METRICS --- - Files Extracted: 2 - Estimated Token Budget: ~3107 tokens - Canonical Reference: https://codewiki.google/github.com/HeliBorg/HeliBoard