Metadata-Version: 2.3
Name: ycr-py-games
Version: 26.1.2
Summary: Classic Games in Python using DearPyGui by @chaitu-ycr
Author: chaitu-ycr
Author-email: chaitu-ycr <chaitu-ycr@gmail.com>
Requires-Dist: dearpygui>=2.3.1
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# ycr-py-games

Classic games built with Dear PyGui by @chaitu-ycr.

Playable games

- 2048
- Snake
- Tic Tac Toe

## Installation

Choose one of the following options.

### 1) Install from PyPI (recommended)

Install the released package and run the app:

```bash
python -m pip install ycr-py-games
ycr-py-games
```

### 2) Local development (editable install)

For development or changes inside the repository:

```bash
python -m venv .venv
source .venv/bin/activate
python -m pip install -e .
ycr-py-games
```

### 3) Run with Astral `uv`

If you prefer Astral tooling, these variants work:

```bash
uv run python -m ycr_py_games
uv run ycr-py-games
uv tool run ycr-py-games
```

## Usage

- Launch the app and open the game windows from the `Windows` menu.
- Use arrow keys (or WASD) for movement in supported games.
- Close the app with File → Exit or window close, which saves your layout and state.

## Dependencies

- dearpygui
- pyinstaller (used for creating executable)

These are declared in `pyproject.toml` and are installed automatically when you install from PyPI.

## License

This project uses the license file included in the repository.

Happy gaming! 🚀
