osmanthus 0.1.2

An algorithmic chess engine, written in Python.

Osmanthus

Osmanthus is a sophisticated chess engine that employs advanced algorithms to provide a challenging and enjoyable playing experience. It offers a range of features, including self play, puzzle solving, and an intuitive command-line interface.

Installation

Osmanthus can be easily installed using pip:

pip install osmanthus

Usage

To start the CLI interface, enter the following command:

osmanthus-cli

Moves can be input in Standard Algebraic Notation (SAN) or Universal Chess Interface notation. We recommend using SAN. If you are new to this notation, we have provided a short guide on our wiki page.

If you are new to playing chess, we suggest checking out this video to learn the fundamentals.

Contributing

Contributions to Osmanthus are highly appreciated! For suggestions, we recommend looking at any open issues, particularly those tagged as "Good First Issue" if you are a first-time contributor. We are also opening new issues related to planned features and bugs that need to be fixed.

When contributing, we ask that you follow the coding style laid out in Google's Python Style Guide.

Thank you for your interest in Osmanthus, and we look forward to your contributions!