A touch-typing trainer.
Touch-typing enables one to be in flow while interfacing with a computer.
In contrast to reading alone, typing while reading engages the visual, linguistic, and especially motor (coordinative, tactile) faculties, which enhances understanding and memory.
Available as vscode tasks.
docker-compose up
# Site now available on http://localhost:8080Alternatively, if you need to disable caching when working behind a reverse proxy:
docker-compose -f docker-compose.traefik.yml up
# Site now available on http://localhost:8080The project started out simple, but grew just enough to require a custom frontend framework. Most parts of are is still in pure HTML, CSS, JS.
Here are some resources (libraries, collections, and books) you may like to use for practice:
Use the ESC key to navigate between Home and Environment (i.e. settings).
In Environment:
-
Use the
TABkey to navigate between settings. -
Use
ARROWkeys to navigate between dropdown entries. -
Use
ENTERorSPACEkeys to select or toggle settings.
The red boxes in the Trainer's speech are indications of errors present in the Student response.
Ensure each text you want to practice is available as a URL.
In touchtypie, go to Environment, and click + beside BOOKS, paste a URL and hit enter. Do this for each URL you want to practice.
To save your practice environment, see this answer.
Note: You may like to use the official practice resources for practice, see here.
To save the practice session, go to Environment, and under FAVORITE click:
Lbutton to favorite the current Library with your custom settingsCbutton to favorite the current Collection with your custom settingsBbutton to favorite the current Book with your custom settings
A touchtypie URL is saved to your clipboard. You may now bookmark, save, or share that touchtypie URL to practice anytime you want.
See this answer.
Check that the URL is valid. Invalid URLs cannot be fetched.
If the URL is indeed valid, the failure to fetch the URL is because that website is protecting that resource from being shared. See this answer. You may try another URL.
The browser is subject to a policy called Cross-Origin Resource Sharing (CORS) which limits the browser from consuming resources from a website other than the current website (i.e. touchtypie).
In order for the browser to consume resources of another website, that website's server must return a HTTP header access-control-allow-origin: *. However we have no control over that website's server.
Hence, the solution is to host our library, collection and book file(s) ourselves. This can easily be done by using Github Pages as discussed in this answer, or uploading to your own web server.
Alternatively, another solution is to use a proxy server which fetches the content of that page directly, and returns the content with a HTTP header access-control-allow-origin: *. This can be done by using Cloudflare Workers.
See this answer.
Ensure each collection you want to practice is available as a URL.
In touchtypie, go to Environment, and click + beside COLLECTIONS, paste a collection URL and hit enter. Do this for each collection you want to practice.
To save your practice environment, see this answer.
Ensure each collection you want to practice is available as a URL.
In touchtypie, go to Environment, and click + beside LIBRARIES, paste a library URL and hit enter. Do this for each library you want to practice.
To save your practice environment, see this answer.
All of the available libraries for practice. Use the + to add a custom library.
All of the available collections for practice. Use the + to add a custom collection.
All of the available books for practice. Use the + to add a custom book.
The playmode defines how the next book will be retrieved. Much like how a next song is played in a media player.
There are 4 playmodes:
shuffleglobal- Shuffle across libraries.shuffle- Shuffle within a collection.repeat- Cycle within a collection.repeatone- Repeat the current book.
The default playmode is shuffleglobal.
As its name implies, meditation declutters the touchtypie user interface to help the Student reach a state of meditation - a state of singularity of the Mind on the book.
As its name implies, perfection enforces that the Student response (what is typed) must match the Trainer's speech (what is shown) for progress to be made in a book training session.
When perfection is turned on, the book training session starts from scratch. In perfection, errors continue to be tracked in statistics.
As its name implies, jumble simply jumbles the words present in a book.
As its name implies, scramble simply scrambles the characters present in a book.
As its name implies, statistics simply shows statistics summaries on the Home scene.
Even when statistics is turned off, it continues being collected. Statistics are collated into a virtue at the end of each training session.
As its name implies, ambience is the background of the training setting.
As its name implies, virtue is the measure of a Student's performance for a particular training session.
A global virtue is a measure of a Student's overall performance across all training sessions.
As its name implies, a favorite is a touchtypie URL that is copied to your clipboard containing your training settings, which you may save, bookmark, or share with others to practice on one particular book or books.
A book is a URL. Its content is the content at that URL.
A collection is a URL. Its content is a list of book URLs.
A library is a URL. Its content is a list of collection URLs.
The Trainer is the touchtypie who prepares training sessions for you.
The Trainer's speech is the text displayed for you to read and type.
The Student is the player of touchtypie who is you.
The Student's response is the text you typed.
Home is the main scene of touchtypie where the Trainer and Student are.
Environment is the settings scene of touchtypie.
Supply GET query parameter book_ids=<URL> (URL-encoding is not required) when accessing touchtypie. For example:
https://play.touchtypie.com?book_ids=https://touchtypie.github.io/touchtypie-libraries/books/keyboard-qwerty-letters.txt
To practice on multiple books, use multiple GET query parameter book_ids=<URL> separated by &. For example:
https://play.touchtypie.com?book_ids=https://touchtypie.github.io/touchtypie-libraries/books/keyboard-qwerty-letters.txt&book_ids=https://touchtypie.github.io/touchtypie-libraries/books/keyboard-qwerty-numbers.txt
To practice on one collection, use GET query parameter book_collection_ids=<URL> (URL-encoding is not required) when accessing touchtypie. For example:
https://play.touchtypie.com?book_collection_ids=https://touchtypie.github.io/touchtypie-libraries/collections/keyboard-qwerty.txt
To practice on multiple collections, use multiple GET query parameter book_collection_ids=<URL> separated by &. For example:
https://play.touchtypie.com?book_collection_ids=https://touchtypie.github.io/touchtypie-libraries/collections/keyboard-qwerty.txt&book_collection_ids=https://touchtypie.github.io/touchtypie-libraries/collections/plants.txt
To practice on one library, use GET query parameter book_library_ids=<URL> (URL-encoding is not required) when accessing touchtypie. For example:
https://play.touchtypie.com?book_library_ids=https://touchtypie.github.io/touchtypie-libraries/libraries/daily.txt
To practice multiple libraries, use multiple GET query parameter book_library_ids=<URL> separated by &. For example:
https://play.touchtypie.com?book_library_ids=https://touchtypie.github.io/touchtypie-libraries/libraries/daily.txt&book_library_ids=https://touchtypie.github.io/touchtypie-libraries/libraries/nature.txt
Simply put, a library, a collection, or a book is a .txt file, available as a URL.
- Library contains collection URL(s), one entry per line.
- Collection contains book URL(s), one entry per line.
- Book contains text
An easy way to host library, collection, and book files is to use Github Pages, by:
- Creating a new repository
- Enabling Github Pages in repository settings on the
masterorgh-pagesbranch - Committing library, collection and book files to the repository's
masterorgh-pagesbranch - Each file will be available as
https://yourname.github.io/your-repository/<file.txt>, where<file.txt>is the name of the committed file.
Once your library URL is up, in touchtypie, go to Environment, click + beside libraries dropdown box, and paste the URL of the library and press enter. The library will be retreived and the practice will start. You may also share the library with others to practice on.
For instance, you want to create a library about nature.
- The library URL will be
https://yourname.github.io/your-repository/nature.txt. - A collection URL will be
https://yourname.github.io/your-repository/plants.txt. - A book URL will be
https://yourname.github.io/your-repository/apple.txt.
Content of https://yourname.github.io/your-repository/nature.txt library (contains collection URLs, one entry per line).
https://yourname.github.io/your-repository/plants.txt
Content of collection https://yourname.github.io/your-repository/plants.txt (contains book URLs, one entry per line).
https://yourname.github.io/your-repository/apple.txt
Content of book https://yourname.github.io/your-repository/apple.txt:
An apple tree grows apple fruits, which are nice to eat.
Apples are said to keep one healthy.
An apple a day keeps the doctor away.
See this library in the official touchtypie-libraries repository.
For instance, you want to create a library about animals
- The library URL will be
https://yourname.github.io/your-repository/animals.txt. - A collection URL will be
https://yourname.github.io/your-repository/dog.txt. - A collection URL will be
https://yourname.github.io/your-repository/cat.txt. - A book URL will be
https://yourname.github.io/your-repository/cocker-spaniel.txt. - A book URL will be
https://yourname.github.io/your-repository/poodle.txt. - A book URL will be
https://yourname.github.io/your-repository/ragdoll.txt. - A book URL will be
https://yourname.github.io/your-repository/persian.txt.
Content of library https://yourname.github.io/your-repository/animals.txt (contains collection URLs, one entry per line).
https://yourname.github.io/your-repository/dog.txt
https://yourname.github.io/your-repository/cat.txt
Content of collection https://yourname.github.io/your-repository/dog.txt (contains book URLs, one entry per line).
https://yourname.github.io/your-repository/cocker-spaniel.txt
https://yourname.github.io/your-repository/poodle.txt
Content of collection https://yourname.github.io/your-repository/cat.txt (contains book URLs, one entry per line).
https://yourname.github.io/your-repository/ragdoll.txt
https://yourname.github.io/your-repository/persian.txt
Content of book https://yourname.github.io/your-repository/cocker-spaniel.txt
Cocker spaniels are the cutest of all dogs.
They have long droopy ears.
Content of book https://yourname.github.io/your-repository/poodle.txt
Poodles are so cute, they look like plushies.
They have short and curly fur.
Content of book https://yourname.github.io/your-repository/ragdoll.txt
Ragdolls are the cutest all all cats.
Their fluff make them look like plushies.
Content of book https://yourname.github.io/your-repository/persian.txt
Persian are the most exotic of all cats.
They carry thmeselves with class.
See this library in the official touchtypie-libraries repository.
It is part of the roadmap to support fetching of .json files as libraries. This will eliminate the need for creating multiple .txt files for libraries, collections, and books.