Package Exports

termitype
termitype/dist/main.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (termitype) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Termitype

A terminal-based typing game designed to improve your typing speed and accuracy.

🚀 Features

🎮 Multiple difficulty levels: Beginner, Intermediate, Advanced, and Master
📊 Real-time stats: WPM, accuracy, mistakes, and time taken
🖋️ Practice with predefined or custom text prompts
💾 Save and resume progress
🔀 Randomized prompts for dynamic practice
🖥️ Minimal and intuitive CLI interface
🛠️ Customizable settings for personalized gameplay

📦 Installation

Install globally via npm:

npm install -g termitype

🎯 Quick Start

After installation, you can start the game by typing:

termitype
# or use the shorthand
typ

📖 Usage

Game Flow

Title Screen: Set up a username or skip directly to the main menu.
Main Menu: Choose from Practice, Practice Category, Settings, or Exit.
Game Levels: Select your difficulty level (Beginner, Intermediate, Advanced, Master).
Typing Practice: Type the displayed text prompt as quickly and accurately as possible.
Results: View your stats, including WPM, accuracy, mistakes, and time taken.

Keyboard Controls

Key	Action
`Ctrl+C`	Exit the game
`Enter`	Confirm selection
`Arrow Keys`	Navigate menus
`Ctrl+S`	Save current game in game mode
`Ctrl+L`	Show game menu in game mode

🛠️ Development

Prerequisites

Node.js (>= 18.x)
npm (>= 9.x)

Local Setup

Clone the repository:

git clone https://github.com/Essien-Emmanuel/termitype.git
cd termitype

Install dependencies:
```
npm install
```

Scripts

Start the game in development mode:
```
npm run game
```
Build the project:
```
npm run build
```

🤝 Contributing

Contributions are welcome! Please follow these steps:

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add some amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

See CONTRIBUTING.md for more details.

📄 License

This project is licensed under the ISC License - see the LICENSE file for details.

👤 Author

Essien Emmanuel

GitHub: @Essien-Emmanuel
npm: termitype

🌟 Show your support

Give a ⭐️ if this project helped you!

📝 Changelog

See CHANGELOG.md for release history.

This README was generated with ❤️