Gym Janggi

Gym Janggi provides an reinforcement learning environment for Korean chess called Janggi. As an OpenAI Gym environment, this package can be used for reinforcement learning algorithms, such as AlphaZero.

Documentation

Check out the GitHub Page for Gym environment documentation.

Getting Started

Using the Gym Enviornment in Your Package

1. Install package via pip:

   pip install gym-janggi

2. Import in your Python module:

   import gym

   import gym_janggi

3. Make a Gym environment instance:

   gym.make("gym_janggi/Janggi-v0")

   Check out the Documentation section for more details.

Testing Functionality

Gym Janggi is originally designed to be imported by other packages and provide a Gym environemnt for Janggi, but if you want to check if the package itself is working, you can follow these steps:

1. Clone the repository:

   git clone https://github.com/sungho-cho/gym-janggi.git

2. Install the module:

   pip install -e .

3. Run play.py, which generates a game with a series of random moves:

   python gym_janggi/play.py

   If you see the UI window and moves being played, the package is working!

Releases

Check out the PyPi Package for releases.

License

This package is licensed under the GNU General Public License v3.0.