Update branding: shellmate.md

This commit is contained in:
Greg Hendrickson
2026-01-27 15:12:09 +00:00
parent 95471924a4
commit eb64e73ae1

View File

@@ -2,48 +2,59 @@
**SSH into chess mastery.**
```
ssh play@shellmate.sh
```bash
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
- **vs AI** — Challenge Stockfish at adjustable difficulty levels
- **vs Player** — Real-time PvP matchmaking
- **vs AI** — Challenge Stockfish at adjustable difficulty (beginner → grandmaster)
- **vs Player** — Real-time PvP matchmaking with ELO ratings
- **vs Friend** — Private rooms with shareable codes
### 📚 Learn
- **Interactive Tutorials** — From basics to advanced tactics
- **Move Analysis** — AI explains why each move matters
### 📚 Learn Mode
- **Interactive Tutorials** — From absolute basics to advanced tactics
- **Move Analysis** — AI explains *why* each move matters
- **Puzzle Rush** — Tactical training exercises
- **Opening Explorer** — Learn popular openings with explanations
- **Endgame Drills** — Master critical endgame patterns
### 🏆 Features
- ELO rating system
### 🏆 Compete
- Global ELO leaderboard
- Game history & replay
- Multiple board themes
- Move hints & analysis
- Chat in PvP games
- Achievements & stats
## Quick Start
## 🚀 Quick Start
```bash
# Connect and play
ssh play@shellmate.sh
# Play a game
ssh play@shellmate.md
# Spectate a game
ssh watch@shellmate.sh
# Learn chess
ssh learn@shellmate.md
# Tutorial mode
ssh learn@shellmate.sh
# Spectate live games
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
- **python-chess** — Chess logic & notation
- **Stockfish** — AI engine
@@ -51,18 +62,28 @@ ssh learn@shellmate.sh
- **Redis** — Matchmaking & sessions
- **PostgreSQL** — User data & game history
## Self-Hosting
## 🐳 Self-Hosting
```bash
git clone https://github.com/ghndrx/shellmate.git
cd shellmate
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
---
*Built with ♟️ by Greg Hendrickson*
**Website:** [shellmate.md](https://shellmate.md)
**Game:** `ssh play@shellmate.md`
*Built with ♟️ by [Greg Hendrickson](https://gregh.dev)*