README.md in fusuma-0.3.5 vs README.md in fusuma-0.3.7
- old
+ new
@@ -1,9 +1,9 @@
# Fusuma [](https://badge.fury.io/rb/fusuma) [](https://travis-ci.org/iberianpig/fusuma)
Fusuma is multitouch gesture recognizer.
-This gem makes your linux PC able to recognize swipes or pinchs and assign shortcuts to them.
+This gem makes your linux PC able to recognize swipes or pinchs and assign commands to them.
[](https://gyazo.com/757fef526310b9d68f68e80eb1e4540f)
襖(Fusuma) means sliding door used to partition off rooms in a Japanese house.
@@ -18,11 +18,11 @@
You need libinput release 1.0 or later. Install libinput-tools:
$ sudo apt-get install libinput-tools
-For sending shortcuts:
+For sending shortcuts(optional):
$ sudo apt-get install xdotool
Install Fusuma:
@@ -45,48 +45,77 @@
## Customize
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.
+### `Command: ` property
+On fusuma version 1.0 `Command: ` property is available!
+You can assign any command each gestures.
-### Sample (default keymap for Elementary OS)
+**`shortcut: ` property is deprecated**, **it will be removed on fusuma version 1.0**.
+You need to replace to `command: ` property.
+
+#### before
+
```yaml
swipe:
3:
left:
shortcut: 'alt+Left'
right:
shortcut: 'alt+Right'
+```
+
+#### after
+
+```yaml
+swipe:
+ 3:
+ left:
+ command: 'xdotool key alt+Left'
+ right:
+ command: 'xdotool key alt+Right'
+```
+
+### Sample (default keymap for Elementary OS)
+
+```yaml
+swipe:
+ 3:
+ left:
+ command: 'xdotool key alt+Left'
+ right:
+ command: 'xdotool key alt+Right'
up:
- shortcut: 'ctrl+t'
+ command: 'xdotool key ctrl+t'
down:
- shortcut: 'ctrl+w'
+ command: 'xdotool key ctrl+w'
4:
left:
- shortcut: 'super+Left'
+ command: 'xdotool key super+Left'
right:
- shortcut: 'super+Right'
+ command: 'xdotool key super+Right'
up:
- shortcut: 'super+a'
+ command: 'xdotool key super+a'
down:
- shortcut: 'super+s'
+ command: 'xdotool key super+s'
pinch:
in:
- shortcut: 'ctrl+plus'
+ command: 'xdotool key ctrl+plus'
out:
- shortcut: 'ctrl+minus'
+ command: 'xdotool key ctrl+minus'
threshold:
swipe: 1
pinch: 1
interval:
swipe: 1
pinch: 1
```
-if `shortcut: ` is blank, the swipe/pinch doesn't trigger a keyevent.
+if `command: ` properties are blank, the swipe/pinch doesn't trigger command.
`threshold:` is sensitivity to swipe/pinch. Default value is 1.
If the swipe's threshold is `0.5`, shorten swipe-length by half.
`interval:` is delay between swipes/pinches. Default value is 1.