https://github.com/kamirus/typing-training
https://github.com/kamirus/typing-training
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kamirus/typing-training
- Owner: Kamirus
- Created: 2017-03-25T17:58:51.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-19T13:57:16.000Z (over 7 years ago)
- Last Synced: 2025-02-14T01:17:28.564Z (8 months ago)
- Language: Python
- Size: 23.4 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Main idea / What is does?
Tool/Game providing a way to practise typing without looking at the keyboard or just speed and correctness.
# How to run?
**in development, so keep in mind that whole project can change dramaticly**
Clone or fork this repo. Both python 2.X and 3.X should work. Windows does not have curses module - only Linux or Mac. In order to run this on Windows 10 take a look at (beta) BashOnWindows. Use 'typingtraining' as an entry point. Pick one:
$ python3 typingtraining
$ python typingtraining
$ ./typingtraining
# How to use?
## Options:
1. without any : displays random text from textlist.json file
2. -d or --difficulty [{0,1,2}, ...] : specify difficulty
3. -r or --random-chars : displays bunch of random characters; without any difficulty set uses hardest mode; -d 0 uses just lowercase letters, -d 1 adds uppers and digits, -d 2 adds also specials
4. -n or --non-stop-mode : repeats training defined amount of times, leave argument empty for inifnite mode
## You can add your own texts manually by editing textlist.json
If it does not exist then run typingtraining so it will create it for you. Delete that file if u messed with it too much.
## If you need help or want to learn more: run with --help
# Functionality
1. Display block of text, mark current character. Follow what user types. Mark 'red' or 'green' accordingly. Allow to use Backspace. Allow to skip some characters.
2. Gather info about speed and correctness. Show them after completion
3. Read those 'blocks of text' from json file with more info about them. Let filter or search. Mark with difficulty: polish language, more numbers, numbers mixed with weird characters, etc.
# ToDo
1. Long text
# Components
1. **TextObject**:
+ **text**: *str* - block of text that will be written on screen
- **colorsarray**: *list* - list of IDs of colors under corresponding indexes in *text*
+ **display**: *stdscr -> None* - handles displaying *text* on the screen
- **changecolor**: *(index, color) -> None* - sets color under passed index if index is in [0, len(*text*))
+ **cleanchar**: *index -> None* - reset char under index to default state
+ **wrongchar**: *index -> None* - mark char under index as wrong
+ **okchar**: *index -> None* - mark char under index as ok
+ **currentchar**: *index -> None* - mark char under index as next character to be typed
2. **Tracker**:
+ **textobj**: *TextObject*
+ **stats**: *dict* - gathers informations about misses(number of misspelled characters), typedkeys(number of those), starttime and finishtime
+ **summarize**: *stdscr -> None* - prints informations after completion
+ **starttracking**: *stdscr -> None* - contains 'game loop'; changes elements in textobj accordingly to correctness of typed characters by the user; also gathers informations and stores them in *stats*
3. **Library**:
+ **gettextbyid**:
+ **getrandom**: *difficulty -> str* - returns random text filtered by difficulty. Difficulty should be int or iterable object of int's
4. **Archive**:
- **dirpath**: *str* - absolute path to script directory
- **path**: *str* - absolute path to file with texts
+ **load**: *() -> None* - loads file with texts (file initialized together with class)
5. **Default**: