Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New layout format and User data migration capability! #142

Closed
wants to merge 4 commits into from

Conversation

mominul
Copy link
Member

@mominul mominul commented Apr 26, 2020

Here I present version 2 of the keyboard method layout format of OBK version 2! 🎉

This layout format uses Zstandard compression algorithm for compressing the images and uses a custom variant of Base91 for decoding the binary bytes into textual format. Base91 is 6% more efficient than Base64 which we currently use. As a result, the layout files we distribute altogether have their sizes shrunken to 58% 🎉

With the new layout format, we now support system keyboard layout other than Qwerty(#36) without any hackery in the parser and with additional number keys. I have also added a heavy test for the parser which will prevent further typo bugs(#98) from happening.

I have also changed the names of two layouts:

  • Bornona to Borno. (This was the real name, I don't know why Avro team had changed it.).
  • Munir Optima (uni) to Munir Optima.

This PR also adds User data migration capability to OBK. It also includes a converter for the new format. So the next release of OBK will be no longer a breaking version. 🎉

@mominul mominul self-assigned this Apr 26, 2020
@mominul
Copy link
Member Author

mominul commented Apr 26, 2020

cc @Adyel @bdeshi

This fixes the CI.
Update ReadMe
@mominul
Copy link
Member Author

mominul commented May 2, 2020

Opened a new PR #143 because of the conflicting submodule change.

@mominul mominul closed this May 2, 2020
@mominul mominul deleted the new_layout branch May 2, 2020 07:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant