Skip to content

feat: add custom text source from local file, code file, or URL #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
barelief wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add custom text source from local file, code file, or URL #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 27 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,17 @@
TUI typing test with a word selection algorithm inspired by [keybr](https://keybr.com/)

## Features
- Word selection algorithm to optimize your typing speed inspired by [keybr](https://keybr.com/) weighted by:
- Accuracy with the letter
- Frequency of the letter in the English language
- Speed at which you type the letter

- Word selection algorithm to optimize your typing speed inspired by [keybr](https://keybr.com/) weighted by:
- Accuracy with the letter
- Frequency of the letter in the English language
- Speed at which you type the letter
- A cool TUI with curses
- Stores your data in a JSON file
- **Custom text source** — type from your own word list, code file, or any URL

## Installation

### Windows

```bash
Expand All @@ -33,34 +36,50 @@ python3 main.py
## Usage

### Running it normally

```bash
python3 main.py
```

### To forgive errors

```bash
python3 main.py --forgive-errors
```

### To set the time limit

```bash
python3 main.py --time 60
```

### To set the words limit

```bash
python3 main.py --words 100
```

### To run it forever

```bash
python3 main.py --forever
```

### To type from a custom file or URL

```bash
# local file
python3 main.py --custom words_i_like.txt

# raw URL — type the typr source itself
python3 main.py --custom https://raw.githubusercontent.com/Sakura-sx/typr/main/main.py
```

You can also set the custom source interactively via the **Custom Text** menu option or **Settings → Custom Word File**. Both local paths and `http`/`https` URLs are supported. Line structure and indentation are preserved — press `Enter` when you reach a `↵` symbol.

## Roadmap
- [ ] Add a setting for the wordlist.
- [ ] Add a setting for the language.

- [ ] Add a setting for the language.

## Contributing

Expand All @@ -69,4 +88,5 @@ to discuss what you would like to change.

## License

[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)
[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)

Loading