luckyimnotanigger/HeliBoard
1
0
Fork 0
mirror of https://github.com/Helium314/HeliBoard.git synced 2025-04-18 21:32:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Customizable and privacy-conscious open-source keyboard
1003 commits 8 branches 54 tags 335 MiB
Java 39.9%
C++ 33.4%
Kotlin 26.1%
Makefile 0.3%
Python 0.2%
Find a file
Helium314 99cf72684d add layout infos for new parser, to be (re)moved after removing old parser
2023-11-30 11:01:03 +01:00
.github udpate issue templates 2023-10-26 07:54:21 +02:00
app add layout infos for new parser, to be (re)moved after removing old parser 2023-11-30 11:01:03 +01:00
fastlane 1.4.5 release 2022-08-05 18:22:32 +02:00
gradle/wrapper Update gradle and AGP (#218) 2023-10-20 17:02:58 +02:00
images update matrix qr 2021-05-17 08:19:30 +02:00
tools add some more layouts 2023-11-28 21:27:29 +01:00
.gitignore Update fastlane dir for v1.1 2020-01-15 13:30:44 +01:00
build.gradle add settings to backup 2023-11-04 12:05:01 +01:00
gradle.properties remove unused dependencies and compress native libraries 2023-08-29 07:52:18 +02:00
gradlew upgrade dependencies 2023-09-26 11:34:32 +02:00
gradlew.bat upgrade dependencies 2023-09-26 11:34:32 +02:00
layouts.md add layout infos for new parser, to be (re)moved after removing old parser 2023-11-30 11:01:03 +01:00
LICENSE-Apache-2.0 update license headers in java / kotlin code 2023-10-17 13:44:01 +02:00
LICENSE-GPL-3 update license headers in java / kotlin code 2023-10-17 13:44:01 +02:00
README.md update readme and todos 2023-11-21 12:30:22 +01:00
settings.gradle Added tools:make-emoji-tool module 2022-01-26 20:31:30 +01:00

README.md

OpenBoard upgrade, WIP

This is an attempt to integrate changes / improvements into OpenBoard that have been sitting around for a long time due to low dev activity. Might end up on F-Droid...

This is mostly a development version. On updates there may be changes that reset some settings. Consider all releases as beta quality at best and always have another keyboard installed in case of really bad bugs.

Features

  • Allow loading Glide typing library
    • not included in the app, as there is no compatible open source library
    • can be extracted from GApps packages (swypelibs), or downloaded here
  • Multilingual typing
  • Load external dictionaries
    • get them here, or in the experimental section (quality may vary)
    • add them in language settings (click on the language, then on + next to dictionary), or open the file in a file explorer
    • 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
  • Adjust keyboard themes (style and colors)
    • can follow the system's day/night setting on Android 10+ (and on some versions of Android 9)
  • Split keyboard (if the screen is large enough)
  • Number row
  • Number pad
  • Show all available extra characters on long pressing a key
  • Backup your learned word / history data
  • Adjustable bottom padding

Hidden functionality

Features that may go unnoticed

  • 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).
  • Press the Incognito icon to access the toolbar.
  • 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 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.
  • You can add dictionaries by opening them in a file explorer:
    • This only works with content-uris and not with file-uris, meaning that it may not work with some file explorers.
  • Debug APK only
    • Long-press a suggestion to show the source dictionary.
    • The Debug Settings are located within the Advanced Preferences, though the usability 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.
    • For users doing manual backups with root access: Starting at Android 7, the shared preferences file is not in the default location, because the app is using device protected storage. This is necessary so the settings can be read before the device is unlocked, e.g. at boot. The file is located in /data/user_de/0/package_id/shared_prefs/, though this may depend on the device and Android version.

Important differences and changes to OpenBoard

The rough plan/todo before "full" release

  • Finish keyboard parsing upgrades
    • In the end, layouts should be defined in either simple text files, or json files, ideally in same format as used by FlorisBoard
    • Users should be allowed to add their own layouts
  • Overhaul the view system
    • Have a fixed height common to all views (keyboard, emoji, clipboard)
    • Should allow for more flexible one-handed mode (though the actual one-handed mode changes may be implemented later)
    • Should allow for background images that don't resize or get cut off when switching between views
  • Internal clean up (xml files, unused resources, some todos in code)
  • Solve some issues requiring a lot of work

Once above is done, we can think about properly releasing the app:

  • Work on issues with the when ready label
  • Rename app, package and this repository
  • New icon
  • Use a translation tool (probably weblate)
  • Release on F-Droid
  • Maybe add a version that does not allow providing a glide typing library, for people concerned about security

Further ideas

  • More customizable theming
  • Improved / less bad suggestions in some specific situations
  • Sliding key input for toolbar, numpad and emojis (like ?123 and shift sliding input)
  • More tunable behavior, e.g for delete and spacebar swipe, for toolbar, for spell checker,...
  • Adjust arrangement of settings, maybe hide settings irrelevant for most users behind some "more settings mode"
  • Migrate to internally use language tags (problematic due to lack of support on older Android versions)
  • More customizable toolbar
  • Support providing background images (for keyboard, and possibly also for keys)
  • and general bug fixing

readme for original version of OpenBoard below

OpenBoard

100% FOSS keyboard, based on AOSP.

GitHub Workflow Status Translation status Matrix

GitHub release (latest by date) F-Droid Version Google Play Version GitHub Release Date GitHub commits since latest release (by date)

Get it on F-Droid Get it on Google Play

Table of content

Community

Join our [matrix] channel here.

Matrix QR Code

Contribution ❤

Issue reporting

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

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.
  • Is the issue still relevant ? Make sure your issue is not already fixed in the latest version of OpenBoard.
  • Did you use the issue template ? It is important to make life of our kind contributors easier by avoiding issues that miss key informations to their resolution.

Please avoid opening issues to ask for a release date, for PR reviews/merges, for more activity on the project, or worth for more contributors. If you have any interrogations on these topics, read this comment from issue #619.

Translation

You can help in translating OpenBoard in your language through our Weblate project.

Translation status

Dictionary creation

To create or update a dictionary for your language, you can use this tool. You will need a wordlist, as described here. The output .dict file must be put in res/raw, and its wordlist in dictionaries.

For your dictionary to be merged into OpenBoard, you must provide the wordlist you used, as well as its license if any.

Code contribution

Getting started

OpenBoard project is based on Gradle and Android Gradle Plugin. To get started, you'll just need to install Android Studio, and import project 'from Version Control / Git / Github' by providing this git repository URL (or git SSH URL).

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

Guidelines

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

  • 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 the lowest footprint possible. OpenBoard code has been written by android experts (AOSP/Google engineers). It has been tested and runned on millions of devices. Thus, existing code will always be safer than new code. The less we alter existing code, the more OpenBoard will stay stable. Especially in the input logic scope.
  • 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.
  • Complies with the user privacy principle OpenBoard follows.

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

Current TODO list

In no particular order, here is the non-exhaustive list of known wanted features :

  • Updated emoji support
  • MaterialYou (M3) support
  • One-handed mode feature
  • Android autofill support
  • Clipboard history feature
  • Text navigation/selection panel
  • Multi-locale typing
  • Emoji search
  • Emoji variant saving
  • Glide typing

Tooling

Edit keyboards content

Keyboards content is often a complex concatenation of data from global to specific locales. For example, additional keys of a given key, also known as 'more keys' in code, are determined by concatenating infos from : common additional keys for a layout (eg. numbers), global locale (eg. common symbols) and specific locale (eg. accents or specific letters).

To edit these infos, you'll need to generate the KeyboardTextsTable.java file. To do so :

  1. Make your modifications in tools/make-keyboard-text/src/main/resources/values-YOUR LOCALE.
  2. Generate the new version of KeyboardTextsTable.java by running Gradle task 'makeText' : 
    ./gradlew tools:make-keyboard-text:makeText

Update emojis

See make-emoji-keys tool README.

License

OpenBoard project 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.

Credits