Metadata-Version: 2.4
Name: squabble-game
Version: 0.1.1
Summary: Command-line SQUABBLE — a familiar-seeming but legally distinct word game
Project-URL: Homepage, https://github.com/klingj3/squabble-word-game
Project-URL: Repository, https://github.com/klingj3/squabble-word-game
Project-URL: Issues, https://github.com/klingj3/squabble-word-game/issues
Author-email: John Klingelhofer <jkklingelhofer@gmail.com>
License: MIT
License-File: LICENSE
Keywords: board game,cli,terminal,word game
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Games/Entertainment :: Board Games
Requires-Python: >=3.12
Requires-Dist: aiohttp>=3.13.5
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: rich>=13.7.0
Provides-Extra: dev
Requires-Dist: mypy>=1.8.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Description-Content-Type: text/markdown

# squabble-game

A familiar-seeming but legally distinct word game for the terminal. Play hot-seat against friends or let computer opponents search the move space each turn.

## Install

```bash
pip install squabble-game
```

Requires Python 3.12+.

## Play

```bash
squabble                                        # 1 human vs 1 computer (default)
squabble <human_players> <computer_players>     # e.g. squabble 2 0, squabble 0 2
```

### Commands during a game

| Command | Effect |
|---|---|
| `<x> <y> <R\|D> <WORD>` | Place a word at column `x`, row `y`, going right or down |
| `exchange <LETTERS>` | Return tiles to the bag and draw new ones |
| `define <WORD>` | Look up a word's definition |
| `skip` | Pass the turn |
| `quit` | End the game |

Coordinates follow the hex digit column headers shown on the printed board.

## Credits

Word definitions sourced via the [Free Dictionary API](https://github.com/meetDeveloper/freeDictionaryAPI).
