https://github.com/valderman/squeekboard-sway
Sway-friendly mod of the original Squeekboard keyboard
https://github.com/valderman/squeekboard-sway
onscreen-keyboard squeekboard swaywm wayland
Last synced: 11 months ago
JSON representation
Sway-friendly mod of the original Squeekboard keyboard
- Host: GitHub
- URL: https://github.com/valderman/squeekboard-sway
- Owner: valderman
- License: gpl-3.0
- Created: 2020-08-28T20:09:17.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2020-08-28T20:19:07.000Z (almost 6 years ago)
- Last Synced: 2025-04-01T07:38:59.202Z (about 1 year ago)
- Topics: onscreen-keyboard, squeekboard, swaywm, wayland
- Language: Rust
- Homepage:
- Size: 2.14 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
- Authors: AUTHORS
Awesome Lists containing this project
README
squeekboard-sway
================
*Squeekboard* is a virtual keyboard supporting Wayland, built primarily for the *Librem 5* phone.
It squeaks because some Rust got inside.
*Squeekboard-Sway* is a small set of experimental modifications to Squeekboard.
The modifications are intended to facilitate using the [Sway](https://swaywm.org) window manager
with an on-screen keyboard.
It adds the following features compared to upstream:
* The height of the on-screen keyboard can be forced by setting the `SQUEEKBOARD_HEIGHT`
environment variable to the desired keyboard height (in pixels)
* Shift and Mod4 (AKA super/logo/meta/windows key) are now valid modifier keys
* Modifier keys are cleared after performing a modifier key combo (such as Mod4+Shift+q)
* Swedish keyboard layout with Shift and Mod4 modifiers
Features
--------
### Present
- GTK3
- Custom yaml-defined keyboards
- DBus interface to show and hide
- Use Wayland input method protocol to show and hide
- Use Wayland virtual keyboard protocol
### Temporarily dropped
- A settings interface
### TODO
- Use Wayland input method protocol
- Pick up DBus interface files from /usr/share
Building
--------
### Dependencies
See `.gitlab-ci.yml`.
### Build from git repo
```
$ git clone https://source.puri.sm/Librem5/squeekboard.git
$ cd squeekboard
$ mkdir ../build
$ meson ../build/
$ cd ../build
$ ninja test
$ ninja install
```
Running
-------
```
$ phoc # if no compatible Wayland compositor is running yet
$ cd ../build/
$ src/squeekboard
```
Developing
----------
See [`doc/hacking.md`](doc/hacking.md) for this copy, or the [official documentation](https://developer.puri.sm/projects/squeekboard/) for the current release.