Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anirudhg07/typeinc-mini
Typeinc-mini, a miniature version of Typeinc, for those who have small screen. The same features as Typeinc, but less UI widgets. :<
https://github.com/anirudhg07/typeinc-mini
Last synced: 9 days ago
JSON representation
Typeinc-mini, a miniature version of Typeinc, for those who have small screen. The same features as Typeinc, but less UI widgets. :<
- Host: GitHub
- URL: https://github.com/anirudhg07/typeinc-mini
- Owner: AnirudhG07
- License: apache-2.0
- Created: 2024-06-05T08:07:50.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-22T17:46:51.000Z (4 months ago)
- Last Synced: 2024-11-06T00:09:16.449Z (15 days ago)
- Language: Python
- Size: 49.4 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Typeinc-mini  
Typeinc-mini, is a miniature version of Typeinc. Same features but less UI (you don't get the Typeinc-keyboard :<). This is made for those who do not have a big enough screen and see the message -
`...If still the issue persists, too bad.`
I certainly don't want people to not feel left-out due to their smaller screen.
_Please note:_ If your screen is still smaller in full screen mode than required, just buy a NEW-ONE bruh!!!
# Previews/Screenshots
https://github.com/AnirudhG07/Typeinc-mini/assets/146579014/4696e50a-971b-4055-9ebf-459e41770e52
**Please Note**: Due to permission errors in Typeinc-mini to write to `scores.json` which stores your scores, you may initially need to run as mentioned in preview. We ensure no other code will be run apart from giving write permission to `scores.json`. You may see ensure_permissions() function to look at the code. Thanks!
# Features
Tyepinc-mini provide some a next level typing test experience sitting on your terminal.
## 1. UI 
This terminal software provides a user-friendly UI with easy interactions, unless the user purposefully messes with things.
The UI is smaller than Typeinc, but has enough features to be able to play and test your skills!
### What you have lesser here than Typeinc Original-
1. Keyboard UI
2. Display of top 5 scores, instead of top 10
## 2. Difficulty levels 
Typeinc has the widest range of difficulty level. You can actually put any number between -infinity to +infinity (keeping in mind computer limitations). Although they are categorized so any difficulty level more than 1000 will be based on LUCK, you may get an easy level 1000 + typing test, or really nasty cause it's absolutely random.
Give your best shot with the difficulty levels and have fun typing!
Here is a detailed summary of the Difficulty level division.
```markdown
- Level <= 0 : Super Easy (Regular) (SE)
- 0 < Level <= 2 : Easy (E)
- 2 < Level <= 4 : Normal (N)
- 4 < Level <= 6 : Hard (H)
- 6 < Level <= 9 : Super Hard (SH)
- 9 < Level <= 10 : Insane (I)
- 10 < Level < 20 : Super Insane (SI)
- 20 <= Level < 50: BRUH (X)
- 50 <= Level < 100: SUPER BRUHH (X2)
- 100 <= Level < 500: DAMNN BRUHHH!! (XX)
- 500 <= Level < 1000: U ROCK BRUHHH! (XX2)
- 1000 <= Level: GOD BRUH!!! (SXX)
```
All the difficulties levels are set by me, including the names. This test is a total 'BRUHHH'!
For example-
This is an example of 50 word test-text at difficulty level = 20. (It may differ for you). You see the `. . .` to explain 50 words coudn't fit here, since the screen is smaller than `Typeinc Original`, hence you will get another screen as you complete typing this screen.
**Note:** If you want to have the regular typing test, please enter without mentioning any difficulty level since Default Difficulty is set to 0.
## 3. Grading and Typeinc score 
The grading system differs for each difficulty level chosen and so is your score. The higher the difficulty level,
more the score you will obtain.
Refer this tool to your friends, family and colleagues and compete with them!
Please refer to Typeinc standards & grades for more information regarding the grading and typeinc score.
## 4. Highscore Display Typeinc-mini 
Save your result with your name for each test you take. You can also see the top 5 for each respective difficulty level by running the command - (Note: difficulty level is code for each difficulty level, like 'E', 'X2', etc.)
```bash
typeinc-mini -r
```
The topper is the one with higher `Typeinc Score`.
Only 100 scores are saved in database which are ordered in desceding order w.r.t Typeinc score. Any score which is lesser than least of them, will not be saved. Try to beat that score to be able to save it, but this will push out the one who went to position 101, which will be deleted.
# How to Install
This is a cross-platform tool so it can be downloaded in your MacOS, Linux, Windows, etc.
Follow the below guidelines to download the software
## ~> PIP Installation
1. You can install this package from PyPi by running the following command0
```bash
pip install typeinc-mini
```
If it gives any permission error, you can run using `sudo`(for Unix).
```bash
sudo pip install typeinc-mini
```
2. Now you are good to go! Play by simply running typeinc-mini by-
```bash
typeinc-mini # to play
typeinc-mini -h # to see help message
```
## ~> Homebrew Installation
This tool can also be installed using Homebrew(for MacOS only). You can install it by tapping my homebrew-tap repo and installing the tool.
```bash
brew tap AnirudhG07/AnirudhG07
brew install typeinc-mini
```
You can now run the tool by running `typeinc-mini -h` in your terminal. If you are facing issues, try running-
```bash
brew install AnirudhG07/AnirudhG07/Typeinc-mini # After tapping the repo
```
Make sure you have Homebrew installed in your MacOS and it is updated which can be done by running `brew update`.
## ~> Manual Installation
To install this tool manually, you can `git clone` this repository in your directory and run it, with the below command guidelines-
1. Clone the repository in your directory
```bash
cd /path/to/your/directory/
git clone https://github.com/AnirudhG07/Typeinc-mini
```
2. Run `setup.py` to set the tool
```bash
python setup.py install #use python3 if required
# OR if it throws an error
pip install .
```
Now you should be able to run the tool using `typeinc-mini` in your terminal. Feel free to raise an issue if you face with any errors.
# Dependencies
This tool doesn't require a lot of dependencies but you need some basic requirements like
- python version >= 3.11
- curses library of python (Note: It will be automatically installed if you use the Pip Installation process)
- For Windows, windows-curses and setuptools are needed.
If you have any doubts/facing any issue, feel free to raise an issue.
# Documentation
Check out the docs in the repository for information regarding how to use, grading system, general queries, etc. Check out the help message in your terminal to check out the usage too ny running `typeinc-mini -h`.
## Tldr
Thanks to maintainers at `tldr/tldr-pages`, we have English and Spanish tldr for typeinc, which is similar for typeinc-mini.
```bash
$ tldr typeinc
```
# Contribution
It would be great to have contributions from anyone. To make Typeinc-mini more loved among everyone and make it better, feel free to raise an issue, discuss and make a PR.
### Contribution Guidelines
1. If you would like to raise any grading system based issues, please have a valid point using some mathematical figures to support your statements.
Statements like `This is unfair`, `I don't like it`, etc. will not be attended to.
2. If you feel like adding a feature or fixing bug, please put up an issue before adding a PR.
You can always post your highest score and grade with wpm, accuracy and difficulty level chosen. I would love to make a global top list and add you there, if you are worthy!
## Note regarding Grading system 
- All the grading, difficulty level, typeinc score is devised by AnirudhG07(me). It has not been taken from anywhere
and all the numbers set has been made from a fair system and intuition.
- I honestly would give more score to a person trying higher difficulty level cause they won't achieve a good wpm, unlike regular level where even 140-150 is possible.
- In no way I am also trying to equate the best possible (wpm, accuracy) of Regular Difficulty level to least possible (wpm, accuracy) of the most Difficult level.
Thanks!