42 lines
1.9 KiB
Markdown
42 lines
1.9 KiB
Markdown
# Aladeen
|
|
This is a program for dictating text to you for practising writing, typing, stenography or whatever<br/>
|
|
You can configure the playback speed, language and mode (timed, words, quote or file).<br/>
|
|
|
|
## Command line options
|
|
All these options overide configuration in config.json<br/>
|
|
c,f,h,i,l,m,o,q,t,u,v,w<br/>
|
|
**--wpm, -w <int>**<br/>
|
|
set the rate of dictation, defaults to 50, note: this is not exact as it measures the time between words in order to avoid a very short gap after a long word.<br/>
|
|
**--mode, -m <mode>**<br/>
|
|
Sets a mode, one of 'timed', 'words','quote' or 'file' followed by an optional modifier representing either the time (in seconds) or the number of words, or the quote ID, or the file name.<br/>
|
|
**--filename, -f <filename>**<br/>
|
|
Passes a filename as parameter for the file mode<br/>
|
|
**--words, -o <number of words>**<br/>
|
|
Number of words for words mode<br/>
|
|
**--time, -t <time>**<br/>
|
|
Time in seconds for timed mode<br/>
|
|
**--quote, -q <time>**<br/>
|
|
Specify a quote ID for quotes mode, see all quotes in your selected language with -u<br/>
|
|
**--language, -l <language>**<br/>
|
|
Selects a language, defaults to english, must be a listed language in -i<br/>
|
|
**--voice, -v <voice id>**<br/>
|
|
Selects a voice to use, defaults to gwm/en in config.json<br/>
|
|
**--list-voices, -c**<br/>
|
|
Lists all the available voices you can use, also see [voices.txt](voices.txt)<br/>
|
|
**--list-quotes, -u**<br/>
|
|
Lists the available quotes and exits<br/>
|
|
**--list-languages, -i**<br/>
|
|
Lists the installed languages and exits<br/>
|
|
**--help, -h**<br/>
|
|
Output's this help text and exits<br/>
|
|
|
|
## Languages
|
|
Current languages: English or Spanish, I plan to add more though.<br/>
|
|
The languages were downloaded from monkeytype.com
|
|
|
|
## Quotes
|
|
The english quotes were downloaded from [here](https://gist.github.com/nasrulhazim/54b659e43b1035215cd0ba1d4577ee80)
|
|
|
|
## Collaboration
|
|
You're free to open a PR for features, new languages or quotes :)
|