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
./mapScore.py map.tsv <words.txt | sort -nr | cut -f2 > wordsSorted.txt
map.tsv uses tabs and newlines to create the grid-based layout. See map.qwerty.simplegrid.tsv for a sample of how to format this file.
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
- Be using a wayland-based graphical shell (such as sway)
- copy swipeGuess.sh and completelyTypeWord.sh into your $PATH (
~/.local/bin/or/usr/local/bin/for example) 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).
- In SXMO,