Metadata-Version: 2.4
Name: sai-pygame
Version: 0.1.8
Summary: A collection of pygame based minigame environments for the SAI platform.
Project-URL: Homepage, https://competesai.com
Project-URL: Documentation, https://docs.competesai.com
Author-email: ArenaX Labs <research@competesai.com>
License: MIT
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Requires-Dist: gymnasium<1.2.0,>=1.0.0
Requires-Dist: numpy<3.0,>=2.0.0
Requires-Dist: pygame<3,>=2.1.0
Requires-Dist: setuptools<71
Description-Content-Type: text/markdown

# ArenaX Lab's PyGame Environments

This package contains the PyGame environments used for the SAI Platform.

## Installation

```bash
pip install sai-pygame
```

## Usage

```python
import gymnasium as gym
import sai_pygame

env = gym.make("CoopPuzzle-v0", render_mode="human")
```


# Environment List

- `CoopPuzzle-v0`: A cooperative puzzle game where two players work together to solve a puzzle.
- `Pong-v0`: A game where two players compete to hit a ball back and forth.
- `SpaceEvaders-v0`: A game where a player must avoid incoming asteroids.
- `SquidHunt-v0`: A game where a player must hunt down squids while avoiding obstacles.


# More Information

- [SAI Platform](https://competesai.com)
- [SAI Documentation](https://docs.competesai.com)
