Simple utility to turn swipes into words -- "plugin" for wvkbd to enable swipe-typing under wayland SXMO.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# swipeGuess

swipeGuess is a completion program intended to be used as a plugin for touchscreen-keyboards on mobile devices.

For each line input from stdin, it looks through a wordlist and outputs the first possible match for that gesture.

it's run like `input-program | swipeGuess.sh wordlist | output-program`

## input-program

The input program should output a stream of letters "swiped through", then a newline.

There's a WIP Merge Request towards proycon's wvkbd for an example of this.

=> https://github.com/proycon/wvkbd/pull/1

## wordlist

This should be a list of words, sorted by preferability of choice.

Good starting points can be found on the web, based on your language.

### Example English Word Lists

* http://www-personal.umich.edu/~jlawler/wordlist - 69,903 English words, including obscure words, missing common stems.
* http://www.mieliestronk.com/corncob_lowercase.txt - 58,110 English words with British spelling.
* https://raw.githubusercontent.com/dwyl/english-words/master/words.txt - 466,550 words, including many proper nouns like names.
* https://norvig.com/ngrams/count_1w.txt - 333,333 words, abbreviations, etc, sorted by popularity.
* https://www.keithv.com/software/wlist/index.php - page with several links providing intersections between english word lists (26,680 - 1,516,998 words)

### sorting tips

The most basic sorting technique would put longest words first, otherwise, it may be impossible to type them.

```
# Good autocompletion for terminal
ls $PATH | awk '{ print length, $0 }' | sort -nr | cut -d" " -f2- > binsSorted.txt

```

Smarter sorting would be keyboard-layout aware. mapscore.py can do that for you

```sh
./mapScore.py map.txt <words.txt | sort -nr | cut -f2 > wordsSorted.txt
```

map.txt uses tabs and newlines to create the grid-based layout.

### alternate formats

Alternatively, for performance, you can use a directory with the following format: each file is named with the first and last letters of the contained words.
The script `makeDir.sh` is provided to help create these.

## output-program

* `completelyTypeWord.sh` (included in this repository) will type the characters (besides the first character, which is already typed by wvkbd) using wtype.

# Installation/Usage with wvkbd

1. Be using a wayland-based graphical shell (such as sway)
2. copy swipeGuess.sh and completelyTypeWord.sh into your $PATH (`~/.local/bin/` or `/usr/local/bin/` for example)
3. `wvkbd-mobintl -O | swipeGuess.sh /path/to/words.txt | completelyTypeWord.sh`
	* In SXMO, `KEYBOARD_ARGS='-O | swipeGuess.sh /path/to/words.txt | completelyTypeWord.sh'` can be added to your ~/.profile to enable this (effective on restart).