/Chess-Engine

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Contributors Forks Stargazers Issues GNU GPL v3.0 License


a chess engine made with python, tensorflow, and python-chess
View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

(back to top)

Built With

  • python
  • python-chess
  • tensorflow

(back to top)

Getting Started

Prerequisites

What you need to get started

  • python3 (tested on 3.11.5)
    python3 --version

Installation

  1. Clone the repo.
    git clone https://github.com/d3finit/chess-engine.git
  2. Navigate to the repository folder.
    cd Chess-Engine
  3. Install the required libraries
    pip install -r requirements.txt
    Depending on your configuration the command
    python3 -m pip install -r requirements.txt
    may be necessary to install the libraries.

(back to top)

Usage

Use

python3 main.py -matesd <number> -materialsd <number> [-sf]

to start the engine.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Increase the model size
  • Optimize the code
  • Make GitHub wiki
    • Usage
    • Document how the code works
  • Add SAN parsing

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GNU GPL v3 License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/d3finit/chess-engine

(back to top)