Metadata-Version: 2.1
Name: pygame_spiel
Version: 1.0.0
Summary: Pygame spiel
Author-email: Giovanni Ortolani <giovorto@pm.me>
Maintainer-email: Giovanni Ortolani <giovorto@pm.me>
License: MIT License
        
        Copyright (c) 2023 Giovanni Ortolani
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/giogix2/pygame_spiel
Project-URL: Repository, https://github.com/giogix2/pygame_spiel
Keywords: open_spiel,pygame
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9.1
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pygame==2.5.0
Requires-Dist: tensorflow==2.13.0
Requires-Dist: gdown==4.7.1
Requires-Dist: pygame-menu==4.4.3
Provides-Extra: spiel
Requires-Dist: open-spiel==1.3; extra == "spiel"

# Pygame_spiel: Pygame-based UI to play board Reinforcement Learning games from OpenSpiel
PygameSpiel is a [Pygame](https://www.pygame.org)-based library to play board games from the library [OpenSpiel](https://github.com/google-deepmind/open_spiel) against AI algorithms.


Pygame_spiel provides a graphical UI interface to play games from the library [OpenSpiel](https://github.com/google-deepmind/open_spiel). While by default Pygame_spiel allows to play against a few existing algorithms from OpenSpiel, it also enables users who are working with OpenSpiel to quickly test new algorithms. With this in mind, Pygame_spiel offers the possibility to plugin new BOTs in runtime for quick testing.

## Index
* [Installation](docs/installation.md)
* [Get started](docs/get_started.md)

## Overview

Use your mouse to select the cell (tic tac toe) or select pawn and destination cell (breakthrough).

![breakthrough_tic_tac_toe](https://github.com/giogix2/pygame_spiel/assets/5859539/dd5f8709-f383-497e-8317-a113ca50d1e7)

## Version 1.0.0
Games currently available: 
* Breakthrough
* Tic Tac Toe

AI algorithms available:
* mcts, DQN (currently only for breakthrough)

**more to come...**
