ghndrx/shellmate
1
0
Fork 0
mirror of https://github.com/ghndrx/shellmate.git synced 2026-02-10 06:45:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update branding: shellmate.md

Browse Source
This commit is contained in:
Greg Hendrickson
2026-01-27 15:12:09 +00:00
parent 95471924a4
commit eb64e73ae1
1 changed files with 48 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
README.md
View File

@@ -2,48 +2,59 @@
**SSH into chess mastery.** **SSH into chess mastery.**
``` ```bash
ssh play@shellmate.sh ssh play@shellmate.md
``` ```
A terminal-based chess experience over SSH. Play against AI, challenge friends, or learn the game with interactive tutorials. > *Experience chess in your terminal. Play against AI, challenge friends, or master the game with interactive tutorials.*
## Features ## ✨ Features
### 🎮 Game Modes ### 🎮 Game Modes
- **vs AI** — Challenge Stockfish at adjustable difficulty levels - **vs AI** — Challenge Stockfish at adjustable difficulty (beginner → grandmaster)
- **vs Player** — Real-time PvP matchmaking - **vs Player** — Real-time PvP matchmaking with ELO ratings
- **vs Friend** — Private rooms with shareable codes - **vs Friend** — Private rooms with shareable codes
### 📚 Learn ### 📚 Learn Mode
- **Interactive Tutorials** — From basics to advanced tactics - **Interactive Tutorials** — From absolute basics to advanced tactics
- **Move Analysis** — AI explains why each move matters - **Move Analysis** — AI explains *why* each move matters
- **Puzzle Rush** — Tactical training exercises - **Puzzle Rush** — Tactical training exercises
- **Opening Explorer** — Learn popular openings with explanations - **Opening Explorer** — Learn popular openings with explanations
- **Endgame Drills** — Master critical endgame patterns
### 🏆 Features ### 🏆 Compete
- ELO rating system - Global ELO leaderboard
- Game history & replay - Game history & replay
- Multiple board themes - Achievements & stats
- Move hints & analysis
- Chat in PvP games
## Quick Start ## 🚀 Quick Start
```bash ```bash
# Connect and play # Play a game
ssh play@shellmate.sh ssh play@shellmate.md
# Spectate a game # Learn chess
ssh watch@shellmate.sh ssh learn@shellmate.md
# Tutorial mode # Spectate live games
ssh learn@shellmate.sh ssh watch@shellmate.md
``` ```
## Tech Stack ## 🖥️ Controls
- **Python 3.11+** | Key | Action |
|-----|--------|
| Arrow keys | Navigate board |
| Enter | Select/Move piece |
| `h` | Get hint |
| `u` | Undo move |
| `n` | New game |
| `r` | Resign |
| `q` | Quit |
## 🏗️ Tech Stack
- **Python 3.11+** with type hints
- **Textual** — Modern TUI framework - **Textual** — Modern TUI framework
- **python-chess** — Chess logic & notation - **python-chess** — Chess logic & notation
- **Stockfish** — AI engine - **Stockfish** — AI engine
@@ -51,18 +62,28 @@ ssh learn@shellmate.sh
- **Redis** — Matchmaking & sessions - **Redis** — Matchmaking & sessions
- **PostgreSQL** — User data & game history - **PostgreSQL** — User data & game history
## Self-Hosting ## 🐳 Self-Hosting
```bash ```bash
git clone https://github.com/ghndrx/shellmate.git
cd shellmate
docker compose up -d docker compose up -d
``` ```
See [docs/self-hosting.md](docs/self-hosting.md) for configuration. Then connect:
```bash
ssh -p 2222 play@localhost
```
## License See [docs/self-hosting.md](docs/self-hosting.md) for configuration options.
## 📝 License
MIT MIT
--- ---
*Built with ♟️ by Greg Hendrickson* **Website:** [shellmate.md](https://shellmate.md)
**Game:** `ssh play@shellmate.md`
*Built with ♟️ by [Greg Hendrickson](https://gregh.dev)*