Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
martinRenou committed May 21, 2018
1 parent 804cad5 commit b51ea55
Showing 1 changed file with 50 additions and 5 deletions.
55 changes: 50 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
<p align="center"><a href="https://martinrenou.github.io/ToonChess/"><img width="300" src="images/logo.png"></a></p>
<h1 align="center">ToonChess</h1>
<h2 align="center"> 3D Chess game based on OpenGL and Stockfish </h1>
<h2 align="center"> 3D Chess game based on OpenGL </h1>
<h2 align="center"><a href="https://martinrenou.github.io/ToonChess/">Website</a></h1>

[![Build Status](https://travis-ci.org/martinRenou/ToonChess.svg?branch=master)](https://travis-ci.org/martinRenou/ToonChess)

## Installation (linux only)

Install [CMake](https://cmake.org/), [Stockfish](https://stockfishchess.org/) and [OpenGL](https://www.opengl.org/):
### Installation of dependencies

Install [CMake](https://cmake.org/) and [OpenGL](https://www.opengl.org/):
```bash
sudo apt-get install cmake stockfish xorg-dev freeglut3-dev
sudo apt-get install cmake xorg-dev freeglut3-dev
```

Install [Bullet Physics](http://bulletphysics.org/wordpress/):
Expand All @@ -22,6 +24,26 @@ sudo make install
cd ..
```

If you want to use [Stockfish](https://stockfishchess.org/) as AI (Stockfish will be used by default but any AI using the [UCI protocol](http://wbec-ridderkerk.nl/html/UCIProtocol.html) can work with ToonChess) you can install it using the following:
```bash
sudo apt-get install stockfish
```

### Install of ToonChess

You can install the Python GUI for ToonChess, it provides a nice GUI for changing game parameters like the AI that you want to use, the screen resolution or color of pieces.

But it's not required to install the Python GUI if you do not want to, you would still be able to configure ToonChess as you wish, manually changing the `/home/user/.config/toonchess/config.txt` file.

#### Installation of ToonChess with Python GUI

If you want to, you can install the python GUI for ToonChess, you will need one of the following installed on your computer in order to make it work:

- PyQt
- wxPython
- PySide
- PyQt5

Download source code:
```bash
git clone https://github.com/martinRenou/ToonChess.git
Expand All @@ -30,13 +52,36 @@ cd ToonChess

Install ToonChess:
```bash
mkdir build && cd build && cmake ..
mkdir build && cd build
cmake ..
sudo make install
```

Run it!
```bash
toonchess
```

#### Installation of ToonChess without Python GUI

If you prefer not to install the Python GUI:

Download source code:
```bash
git clone https://github.com/martinRenou/ToonChess.git
cd ToonChess
```

Install ToonChess without the Python GUI:
```bash
mkdir build && cd build
cmake -DTOONCHESS_BUILD_PYTHON_GUI=OFF ..
sudo make install
```

Run it!
```bash
ToonChess
toonchess
```

## Tests
Expand Down

0 comments on commit b51ea55

Please sign in to comment.