https://github.com/prime-run/go-typer
The sleek, blazing-fast terminal typing test inspired by MonkeyType!
https://github.com/prime-run/go-typer
Last synced: 10 days ago
JSON representation
The sleek, blazing-fast terminal typing test inspired by MonkeyType!
- Host: GitHub
- URL: https://github.com/prime-run/go-typer
- Owner: prime-run
- License: mit
- Created: 2025-03-31T18:08:05.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2025-04-16T17:48:51.000Z (18 days ago)
- Last Synced: 2025-04-17T02:29:16.959Z (18 days ago)
- Language: Go
- Size: 16.9 MB
- Stars: 9
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- charm-in-the-wild - go-typer - An sleek, blazing-fast and fun terminal typing game inspired by MonkeyType. (_built with Bubble Tea_) (Applications / Games)
README
# 🚀 Go Typer
**The sleek, fast terminal typing game inspired by [MonkeyType](https://monkeytype.com/)!**
Go Typer brings the popular web-based typing experience of MonkeyType to your terminal with a beautiful, customizable interface. Master your typing skills right in your terminal (where it actually matters 😉) without a browser.
(online multiplayer type racer, coming soon)
## 🛠️ Built With
[](https://go.dev/) [](https://github.com/spf13/cobra) [](https://github.com/charmbracelet/bubbletea) [](https://github.com/charmbracelet/lipgloss)
📷 Screenshots
## ✨ Features
- **⚡ Standard-Style Gameplay**: Space bar to advance between words, just like the web favorite!
- **📊 WPM & Accuracy Tracking**: Watch your stats update when you done typing
- **🎮 Multiple Game Modes**: Choose between normal mode (with punctuation) or simple mode for beginners
- **🎨 Gorgeous Themes**: Customize your experience with beautiful color schemes
- **📏 Flexible Text Lengths**: Practice with short, medium, long, or very long passages
- **⚙️ Performance Tuning**: Adjust refresh rates from 1-60 FPS for any terminals (or modify it in code for any value)
- **📝 Cursor Options**: Choose your preferred cursor style (block or underline)
- **💻 100% Terminal-Based**: No browser needed - perfect for developers and terminal enthusiasts.
### Demo video
[](https://github.com/user-attachments/assets/644a3feb-5758-4d3e-bd0d-878abde63787)
## 🖥️ Terminal Requirements
Go Typer works best in terminals that support "TrueColor" (24-bit color). It's been tested extensively on Linux but runs great on macOS and Windows too!
(if you see inconsistency with colors, animations or functionality with different terminal emulators please open an issue in this repo)
Verify your terminal supports TrueColor by running:
```bash
printf "\x1b[38;2;255;0;0mTRUECOLOR\x1b[0m\n"
```
If you see "TRUECOLOR" in red, you're good to go\! If not, check out [this compatibility guide](https://gist.github.com/weimeng23/60b51b30eb758bd7a2a648436da1e562).
> [\!CAUTION]
> Please avoid launching the game through `tmux` as it might cause unexpected behavior.
> [\!TIP]
> I recommend using terminal emulators like [`alacritty`](https://github.com/alacritty/alacritty) or [`kitty`](https://github.com/kovidgoyal/kitty), as they are GPU accelerated and generally offer better performance.
## 🚀 Installation
Choose the installation method that suits you best:
⬇️ Download Binaries (Quickest Start)
Download the latest pre-built binaries for your operating system from the [Releases](https://github.com/prime-run/go-typer/releases) page. Here's a simplified way to download and install (rootless):
**Linux (x86_64):**
```bash
wget https://github.com/prime-run/go-typer/releases/download/v1.0.2/go-typer_1.0.2_linux_x86_64.tar.gz
mkdir -p ~/.local/bin
tar -xzf go-typer_*.tar.gz -C ~/.local/bin go-typer
```
**macOS (Intel x86_64):**
```bash
wget https://github.com/prime-run/go-typer/releases/download/v1.0.2/go-typer_1.0.2_macOS_intel.tar.gz
mkdir -p ~/.local/bin
tar -xzf go-typer_*.tar.gz -C ~/.local/bin go-typer
```
**macOS (Apple Silicon arm64):**
```bash
wget https://github.com/prime-run/go-typer/releases/download/v1.0.2/go-typer_1.0.2_macOS_apple-silicon.tar.gz
mkdir -p ~/.local/bin
tar -xzf go-typer_*.tar.gz -C ~/.local/bin go-typer
```
After downloading and extracting, ensure that `~/.local/bin` is in your system's `PATH` environment variable. You can usually do this by adding the following line to your shell's configuration file (e.g., `.bashrc`, `.zshrc`):
```bash
export PATH="$HOME/.local/bin:$PATH"
```
Then, reload your shell configuration:
```bash
source ~/.bashrc # For Bash
# or
source ~/.zshrc # For Zsh
```
Now you should be able to run Go Typer by simply typing `go-typer` in your terminal.
⚙️ Go Install (For Go Users)
> [!NOTE]
> [go](https://go.dev/doc/install) version > v1.24 is required
```bash
go install github.com/prime-run/go-typer@latest
```
Make sure you have Go installed and your `GOPATH/bin` or `GOBIN` is in your system's `PATH`.
🛠️ Clone and Build (From Source)
```bash
git clone https://github.com/prime-run/go-typer.git
cd go-typer
go build -o bin/go-typer
./bin/go-typer
```
🔨 Make (Unix/Linux)
```bash
git clone https://github.com/prime-run/go-typer.git
cd go-typer
make
./bin/go-typer
```
🐳 Docker (Container)
```bash
git clone https://github.com/prime-run/go-typer.git
cd go-typer
docker build -t go-typer .
# Run in container
docker run -it --rm go-typer
```
## 🎮 How to Play
1. Launch Go Typer:
```bash
go-typer
```
2. **Navigate** through the menu using the arrow keys or `j`/`k`.
3. Press **Enter** to select a menu item and start typing.
4. **Type** the text as displayed. Correctly typed characters will be highlighted.
5. Press **spacebar** to advance to the next word, just like on MonkeyType\!
6. Your **WPM**, **accuracy**, and time are tracked in real-time at the bottom of the screen.
7. Complete the passage to see your final statistics.
### 🎯 Keyboard Controls
- **↑/↓ or j/k**: Navigate through menu items
- **Enter**: Select menu item
- **Esc**: Go back to the previous screen
- **Space**: Advance to the next word while typing
- **Tab**: Restart the current typing exercise
- **q or Ctrl+C**: Quit the application
## ⚙️ Configuration
Go Typer automatically saves your preferences in your user config directory:
- Linux/BSD: `~/.config/go-typer/settings.json`
- macOS: `~/Library/Application Support/go-typer/settings.json`
- Windows: `%AppData%\go-typer\settings.json`
You can directly edit the `settings.json` file to customize the following options:
- **theme**: Pick from eye-catching color schemes (`default`, `dark`, `monochrome`) or create your own.
- **cursor_style**: Choose between `block` or `underline`.
- **game_mode**: Select `normal` (with punctuation) or `simple` for beginners.
- **include_numbers**: Set to `true` to include numbers in typing tests.
- **text_length**: Choose from `short`, `medium`, `long`, or `very_long`.
- **refresh_rate**: Fine-tune animation smoothness from `5` (battery-saving) to `60` (ultra-smooth) FPS.
## 🎨 Themes
Go Typer includes beautiful themes inspired by popular coding and typing interfaces.
Built-in themes:
- `default`: Clean light theme with green/blue highlights
- `dark`: Sleek dark theme with purple/blue accents
- `monochrome`: Minimalist black and white theme for distraction-free typing
### 🖌️ Create Your Own Theme
Further customize your typing experience by creating a custom theme file with a `toml` file under `colorschemes` directory and select it within the game settings. Here's the structure of a theme file:
```yaml
# UI Elements
help_text: "#626262" # Help text at the bottom
timer: "#FFDB58" # Timer display
border: "#7F9ABE" # Border color for containers
# Text Display
text_dim: "#555555" # Untyped text
text_preview: "#7F9ABE" # Preview text color
text_correct: "#00FF00" # Correctly typed text
text_error: "#FF0000" # Incorrectly typed characters
text_partial_error: "#FF8C00" # Correct characters in error words
# Cursor
cursor_fg: "#FFFFFF" # Cursor foreground color
cursor_bg: "#00AAFF" # Cursor background color
cursor_underline: "#00AAFF" # Underline cursor color
# Miscellaneous
padding: "#888888" # Padding elements color
```
## 🔄 Related Projects
**togo**: A terminal-based todo manager built with the same technology stack\!
[Check out togo on GitHub](https://github.com/prime-run/togo)
## 🤝 Contributing
Love Go Typer? Contributions are always welcome\!
- Check out our [todos](https://www.google.com/search?q=todos.md) for upcoming features and areas where you can help.
- Feel free to submit pull requests for bug fixes or new features.
- If you have any suggestions or find any issues, please open an issue on GitHub.
## 📜 License
[MIT](https://www.google.com/search?q=LICENSE)