HeliBoard Documentation

File: README.md Copy Chapter

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.

Table of Contents Copy Chapter

• Features
• Contributing
  • Reporting Issues
  • Translations
  • To Community
  • Code Contribution
• Links
• License
• Credits
  • Funding

Features

<li>build your own, or get them  [here](https://codeberg.org/Helium314/aosp-dictionaries#dictionaries) (quality may vary)</li>
<li>additional dictionaries for emojis or scientific symbols can be used to provide suggestions (similar to "emoji search")</li>
<li>note that for Korean layouts, suggestions only work using [this dictionary](https://github.com/openboard-team/openboard/commit/83fca9533c03b9fecc009fc632577226bbd6301f), the tools in the dictionary repository are not able to create working dictionaries</li>

<li>can follow the system's day/night setting on Android 10+ (and on some versions of Android 9)</li>
<li>can follow dynamic colors for Android 12+</li>

<li>library not included in the app, as there is no compatible open source library available</li>
<li>can be extracted from GApps packages ("*swypelibs*"), or downloaded [here](https://github.com/erkserkserks/openboard/tree/46fdf2b550035ca69299ce312fa158e7ade36967/app/src/main/jniLibs) (click on the file and then "raw" or the tiny download button)</li>

For FAQ, hidden features and more information about the app and features, please visit the wiki

Contributing ❤

Reporting Issues Copy Chapter

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. In case of feature requests you could also check the FAQ and 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
  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 Copy Chapter

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 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 Copy Chapter

There is the discussions on GitHub, or if you prefer a more open network there is Lemmy.
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
  • there are theme collections available at Star-Trowa/heliboard-themes and 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 for details
  • you can share custom layouts in a separate discussion section
  • Roccobot's Layout Maker is a browser-based editor for json layout files
• Creating dictionaries is a little more work
  • first you will need a wordlist, as described here and in the repository readme
  • the you need to compile the dictionary using external tools
  • 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

Code Contribution Copy Chapter

See Contribution Guidelines

Links

• Info
  • Wiki, including FAQ, help on customizing layouts, and gesture data gathering
  • Layout documentation (more technical info regarding layout customization)
  • For creating custom dictionaries (see also top of the linked readme)
• Community
  • Lemmy
  • Reddit
  • GitHub discussions
• Other
  • Translations
  • Dictionaries
  • k3lp is a WIP library for keyboard layout parsing that will be implemented in HeliBoard when ready (created by FlorisBoard maintainers)
  • 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 file.

Since the app is based on Apache 2.0 licensed AOSP Keyboard, an Apache 2.0 license file is provided.
The icon is licensed under Creative Commons BY-SA 4.0. A license file is also included.

Credits

• Icon by Fabian OvrWrt with contributions from The Eclectic Dyslexic
• OpenBoard
• AOSP Keyboard
• LineageOS
• Simple Keyboard
• Indic Keyboard
• FlorisBoard
• Our contributors

Funding Copy Chapter

This project is funded through NGI Mobifree Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet program. Learn more at the NLnet project page.

Further the project benefits from donations provided by many users (thank you all!).

File: tools/make-emoji-keys/README.md Copy Chapter

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 Copy Section

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 Copy Section

• 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 and name it as a decimal number corresponding to Unicode's version.
• Update 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