README.md in fusuma-2.0.4 vs README.md in fusuma-2.0.5
- old
+ new
@@ -1,11 +1,11 @@
# Fusuma [](https://badge.fury.io/rb/fusuma) [](https://travis-ci.com/iberianpig/fusuma) [](https://coveralls.io/github/iberianpig/fusuma?branch=master) [](http://inch-ci.org/github/iberianpig/fusuma)
Fusuma is multitouch gesture recognizer.
This gem makes your linux able to recognize swipes or pinchs and assign commands to them.
-
+
襖(Fusuma) means sliding door used to partition off rooms in a Japanese house.
## Features
@@ -81,11 +81,11 @@
$ sudo pacman -S ruby
```
#### 3. Install Fusuma
-**Note:** By default in Arch Linux, when running ```gem```, gems are installed per-user (into ```~/.gem/ruby/```), instead of system-wide (into ```/usr/lib/ruby/gems/```). This is considered the best way to manage gems on Arch, because otherwise they might interfere with gems installed by Pacman. (From Arch Wiki)
+**Note:** By default in Arch Linux, when running `gem`, gems are installed per-user (into `~/.gem/ruby/`), instead of system-wide (into `/usr/lib/ruby/gems/`). This is considered the best way to manage gems on Arch, because otherwise they might interfere with gems installed by Pacman. (From Arch Wiki)
To install gems system-wide, see any of the methods listed on [Arch Wiki](https://wiki.archlinux.org/index.php/ruby#Installing_gems_system-wide)
```zsh
$ sudo gem install fusuma
@@ -119,11 +119,11 @@
$ sudo gem update fusuma
```
## Customize Gesture Mapping
-You can customize the settings for gestures to put and edit `~/.config/fusuma/config.yml`.
+You can customize the settings for gestures to put and edit `~/.config/fusuma/config.yml`.
**NOTE: You will need to create the `~/.config/fusuma` directory if it doesn't exist yet.**
```bash
$ mkdir -p ~/.config/fusuma # create config directory
$ nano ~/.config/fusuma/config.yml # edit config file.
@@ -133,16 +133,19 @@
### Available gestures
* `swipe:`
* support `3:`, `4:` fingers
* support `left:`, `right:`, `up:`, `down:` directions
+ * support `begin:`, `update:`, `end:` events
* `pinch:`
* support `2:`, `3:`, `4:` fingers
* support `in:`, `out:` directions
+ * support `begin:`, `update:`, `end:` events
* `rotate:`
* support `2:`, `3:`, `4:` fingers
* support `clockwise:`,`counterclockwise:` directions
+ * support `begin:`, `update:`, `end:` events
### About YAML Basic Syntax
- Comments in YAML begins with the `#` character.
- Comments must be separated from other tokens by whitespaces.
@@ -155,11 +158,11 @@
```yaml
swipe:
3:
left:
- command: "xdotool key alt+Right" # History forward
+ command: "xdotool key alt+Right" # History forward
right:
command: "xdotool key alt+Left" # History back
up:
command: "xdotool key super" # Activity
down:
@@ -189,10 +192,12 @@
- [i3](https://github.com/iberianpig/fusuma/wiki/i3)
- [KDE to mimic MacOS](https://github.com/iberianpig/fusuma/wiki/KDE-to-mimic-MacOS)
- [POP OS with Cinnamon](https://github.com/iberianpig/fusuma/wiki/POP-OS-with-Cinnamon)
- [PopOS Default Gnome](https://github.com/iberianpig/fusuma/wiki/PopOS-Default-Gnome)
- [Ubuntu OS to mimic Mac a little](https://github.com/iberianpig/fusuma/wiki/Ubuntu-OS-to-mimic-Mac-a-little)
+- [3 fingers Drag (OS X Style)](https://github.com/iberianpig/fusuma/wiki/3-fingers-Drag-(OS-X-Style))
+- [3 fingers Alt Tab Switcher(Windows Style)](https://github.com/iberianpig/fusuma/wiki/3-fingers-Alt-Tab-Switcher(Windows-Style))
If you have a nice configuration, please share `~/.config/fusuma/config.yml` with everyone.
### Threshold and Interval
@@ -206,23 +211,23 @@
### Example of `threshold:` / `interval:` settings
```yaml
swipe:
- 3:
- left:
+ 3:
+ left:
command: 'xdotool key alt+Right' # threshold: 0.5, interval: 0.75
threshold: 0.5
- right:
+ right:
command: 'xdotool key alt+Left' # threshold: 0.5, interval: 0.75
threshold: 0.5
- up:
+ up:
command: 'xdotool key super' # threshold: 1, interval: 0.75
- down:
+ down:
command: 'xdotool key super' # threshold: 1, interval: 0.75
pinch:
- 2:
+ 2:
in:
command: "xdotool keydown ctrl click 4 keyup ctrl" # threshold: 0.5, interval: 0.5
out:
command: "xdotool keydown ctrl click 5 keyup ctrl" # threshold: 0.5, interval: 0.5
@@ -232,11 +237,11 @@
interval:
swipe: 0.75
pinch: 0.5
```
-There are three priorities of `threshold:` and `interval:`.
+There are three priorities of `threshold:` and `interval:`.
The individual `threshold:` and `interval:` settings (under "direction") have a higher priority than the global one (under "root")
1. child elements in the direction (left/right/down/up → threshold/interval)
1. root child elements (threshold/interval → swipe/pinch)
1. default value (= 1)
@@ -278,11 +283,11 @@
- Wayland compatible
- `xte`
- [xte(1) - Linux man page](https://linux.die.net/man/1/xte)
- install with `sudo apt xautomation`
-
+
- [ydotool](https://github.com/ReimuNotMoe/ydotool)
- Wayland compatible
- Needs more maintainers.
- Requires only replacing `xdotool` with `ydotool` in fusuma conf.
@@ -290,11 +295,10 @@
- `-c`, `--config=path/to/file` : Use an alternative config file
- `-d`, `--daemon` : Daemonize process
- `-l`, `--list-devices` : List available devices
- `-v`, `--verbose` : Show details about the results of running fusuma
-- `--device="Device name"` : Open the given device only (DEPRECATED)
- `--version` : Show fusuma version
### Specify touchpads by device name
Set the following options to recognize multi-touch gestures only for the specified touchpad device.
@@ -320,11 +324,11 @@
- Adding new gestures or combinations
- Features for specific Linux distributions
- Setting different gestures per applications
-### Installation of fusuma plugins
+### Installation of Fusuma plugins
Fusuma plugins are provided with the `fusuma-plugin-XXXXX` naming convention and hosted on [RubyGems](https://rubygems.org/search?utf8=%E2%9C%93&query=fusuma-plugins).
`$ sudo gem install fusuma-plugin-XXXXX`
@@ -338,19 +342,19 @@
| [fusuma-plugin-tap](https://github.com/iberianpig/fusuma-plugin-tap) |  | Detects Tap and Hold gestures |
| [fusuma-plugin-appmatcher](https://github.com/iberianpig/fusuma-plugin-appmatcher) |  | Configure app-specific gestures |
## Tutorial Video
-[](http://www.youtube.com/watch?v=bn11Iwvf29I "Multitouch Touchpad Gestures in Linux with Fusuma")
+[](http://www.youtube.com/watch?v=bn11Iwvf29I "Multitouch Touchpad Gestures in Linux with Fusuma")
[Multitouch Touchpad Gestures in Linux with Fusuma](http://www.youtube.com/watch?v=bn11Iwvf29I) by [Eric Adams](https://www.youtube.com/user/igster75)
## Support
I'm a Freelance Engineer in Japan and working on these products after finishing my regular work or on my holidays.
Currently, my open-source contribution times is not enough.
If you like my work and want to contribute and become a sponsor, I will be able to focus on my projects.
-- [GitHub Sponsors](https://github.com/sponsors/iberianpig) (Zero fee!)
+- [GitHub Sponsors](https://github.com/sponsors/iberianpig)
- [Patreon](https://www.patreon.com/iberianpig)
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/iberianpig/fusuma. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.