Welcome to T.I.N.C.A.N., a chess engine designed for tactical gameplay and neural network-powered decision-making. This README will guide you through the process of downloading and using T.I.N.C.A.N. for a Windows machine.
Before you begin, ensure you have the following installed on your system:
- Python version 3.11.7: You can download Python from here. During installation, make sure to select the option to add pip to your PATH environment.
-
Clone the Repository: Create a directory in your documents to store this repository. Open a Git Bash terminal in that directory and run the following command:
git clone https://github.com/reece-cristea/tim-capstone-chess-engine.git
-
Navigate to Repository: Change directory into the cloned repository:
cd tim-capstone-chess-engine
-
Setup Virtual Environment: Create a virtual environment using Python's venv module:
python -m venv venv
-
Activate Virtual Environment: Activate the virtual environment. In your terminal, switch to PowerShell and run:
.\venv\Scripts\activate.ps1
-
Install Dependencies: Copy and paste the contents of
pip.txt
into the terminal and press enter. This will install the required dependencies. -
Start the Server: Run the following command to serve the frontend and start the API:
python api.py
-
Access the Game: Open your web browser and navigate to http://localhost:8000/ to play the game.
If you encounter any errors or have questions, please feel free to contact the developer at [email protected].
Thank you for checking out T.I.N.C.A.N.! Enjoy playing chess with our tactical AI engine. ๐๐ฅ