Installation

You can install Gym Xiangqi using pip or directly from source code.

Using PIP

To install using pip, run:

pip install gym-xiangqi

Installing from Source

To install from the source,

1. First download the latest release from our repository.

2. Extract the files using unzip or tar

unzip gym-xiangqi-x.x.x.zip

tar -xf gym-xiangqi-x.x.x.zip

3. Change directory to project root:

cd gym-xiangqi

4. Build and install:

python setup.py build
python setup.py install

Installing for Development

To install for development,

1. clone the repository:

git clone https://github.com/tanliyon/gym-xiangqi.git

2. Change directory to project root:

cd gym-xiangqi

3. Install Python Dependencies:

pip install -r requirement.txt

Note

We recommend creating a separate virtual environment just for this project.

To create a virtual environment, run:

python -m venv <virtual environment name>

4. Install the project as Python module:

pip install -e .