{"id":13740898,"url":"https://github.com/divvun/kbdgen","last_synced_at":"2025-07-16T04:06:56.225Z","repository":{"id":146364263,"uuid":"461815595","full_name":"divvun/kbdgen","owner":"divvun","description":"The next iteration of a Rust keyboard layout generator","archived":false,"fork":false,"pushed_at":"2025-06-18T14:05:56.000Z","size":549,"stargazers_count":21,"open_issues_count":12,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-18T15:24:01.972Z","etag":null,"topics":["android","chromeos","generator","ios","keyboard","linux","macos","svg","windows"],"latest_commit_sha":null,"homepage":"https://divvun.github.io/kbdgen/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/divvun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-02-21T10:43:18.000Z","updated_at":"2025-06-18T14:06:00.000Z","dependencies_parsed_at":null,"dependency_job_id":"eed10718-bfa9-4040-9e9a-775386fe55be","html_url":"https://github.com/divvun/kbdgen","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/divvun/kbdgen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divvun%2Fkbdgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divvun%2Fkbdgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divvun%2Fkbdgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divvun%2Fkbdgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/divvun","download_url":"https://codeload.github.com/divvun/kbdgen/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divvun%2Fkbdgen/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265480760,"owners_count":23773781,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","chromeos","generator","ios","keyboard","linux","macos","svg","windows"],"created_at":"2024-08-03T04:00:53.377Z","updated_at":"2025-07-16T04:06:56.159Z","avatar_url":"https://github.com/divvun.png","language":"Rust","funding_links":[],"categories":["Software"],"sub_categories":["Utilities"],"readme":"# kbdgen\n\n[![](https://divvun-tc.thetc.se/api/github/v1/repository/divvun/kbdgen/main/badge.svg)](https://divvun-tc.thetc.se/api/github/v1/repository/divvun/kbdgen/main/latest)\n\nA tool to build keyboard packages for a multitude of platforms using a single, simple text file definition. Supported outputs:\n\n- Linux (X11, m17n)\n- macOS\n- Windows\n- ChromeOS\n- iOS/iPadOS\n- Android\n- SVG\n- hit-error correction model as an [FST](https://en.wikipedia.org/wiki/Finite-state_machine), to be used with our spellers\n- [CLDR keyboard definitions](https://cldr.unicode.org/index/keyboard-workgroup) is presently missing, but is in the pipeline\n\nWe think it's pretty cool.\n[Documentation](https://divvun.github.io/kbdgen/) (under construction -- [how to update](DEV.md#asciidoc)).\n\n## Runtime dependency\n\nkbdgen uses `convert` which is part of `imagemagick`\n\nFor Mac: `brew install imagemagick`\nFor Linux: `\u003cpkg-manager\u003e install imagemagick`\n\n## Installation\n\n1. get [Rust](https://www.rust-lang.org/learn/get-started)\n1. clone this repo: `git clone https://github.com/divvun/kbdgen.git`\n1. `cd kbdgen`\n1. `cargo install --path .` (this installs `kbdgen` to the path)\n\n**Alternatively** - download a precompiled binary from nightly builds:\n\n- [Linux](https://pahkat.uit.no/devtools/download/kbdgen?channel=nightly\u0026platform=linux) (x86_64)\n- [macOS](https://pahkat.uit.no/devtools/download/kbdgen?channel=nightly\u0026platform=macos) (x86_64)\n- [Windows](https://pahkat.uit.no/devtools/download/kbdgen?channel=nightly\u0026platform=windows) (i686)\n\nExtract the archive, and move the binary to somewhere on your `$PATH`.\n\n## Example Usage\n\n`cargo run -- target --bundle-path C:\\Projects\\Divvun\\keyboards\\keyboard-sme\\sme.kbdgen --output-path C:\\KbdgenBuilds\\sme_mac macos generate`\n\nLet's build an android app. There's two. [divvun-dev-keyboard](https://github.com/divvun/divvun-dev-keyboard) and [divvun-keyboard](https://github.com/divvun/divvun-keyboard). The former is the unstable one where we do all the testing. The latter one gets pushed to production. Both are deployed as separate apps in google playstore.\n\nAlas, I digress.\n\nWe want to build divvun-dev-keyboard. Clone divvun-dev-keyboard.\n\n```bash\ncd source/divvun\ngit clone git@github.com:divvun/divvun-dev-keyboard.git\ncd ../kbdgen\ncargo run -- fetch -b /Users/srdkvr/source/divvun/divvun-dev-keyboard/divvun-dev.kbdgen #fetches deps\ncargo run -- target --bundle-path /Users/srdkvr/source/divvun/divvun-dev-keyboard/divvun-dev.kbdgen --output-path ~/source/divvun/android_keyboard android build\n```\n\nNote - you will need imagemagick to run converting of images - so\n\n```\n$ brew install imagemagick@6\n$ echo 'export PATH=\"/opt/homebrew/opt/imagemagick@6/bin:$PATH\"' \u003e\u003e ~/.zshrc\n```\n\nYour typical commands are\n\n- ... `android clone` # Clones the base android repository\n- ... `android generate` # Generates all the layouts and speller configs, but doesn't clone stuff\n- ... `android build` # Both of the above.\n\n### TL;DR Android\n\nYour\n\nFor Android run two commands:\n\n```\nkbdgen target --bundle-path C:\\Projects\\Divvun\\keyboards\\keyboard-sme\\sme.kbdgen --output-path C:\\KbdgenBuilds\\sme_android android clone\nkbdgen target --bundle-path C:\\Projects\\Divvun\\keyboards\\keyboard-sme\\sme.kbdgen --output-path C:\\KbdgenBuilds\\sme_android android generate\n```\n\n## License\n\nThis project is licensed under either of\n\n- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)\n- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)\n\nat your option.\n\n## Contribution\n\nFork and PR on Github.\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any\nadditional terms or conditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdivvun%2Fkbdgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdivvun%2Fkbdgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdivvun%2Fkbdgen/lists"}