WayChess

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 17 Open GitHub ↗

A modern design, open source, fully featured chess GUI.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# WayChess

![demo](https://raw.githubusercontent.com/r2dev2/WayChess/master/img/demo/general_screen.png)

## Installation

There should be a Windows installer available, if you don't use Windows, install from scratch.

### Binary From Scratch

```
git clone https://github.com/r2dev2bb8/WayChess.git
cd WayChess
make
```

### Linux

You may need to install the following extra dependencies

```
sudo apt install mercurial python3-dev libjpeg-dev libportmidi-dev libsdl-image1.2-dev libsdl-mixer1.2-dev libsdl-ttf2.0-dev libsdl1.2-dev libsmpeg-dev libx11-dev libavformat-dev libswscale-dev python3-tk
chmod +x cleartype-install-linux.bash
./cleartype-install-linux.bash
```

## Usage

Keybindings:

|    Key        |     Function     |
| ------------- | ---------------- |
| ``<-``        | Move back        |
| ``->``        | Move forward     |
| ``ctrl + ->`` | Variation menu   |
| ``f``         | Flip board       |
| ``s``         | Save database    |
| ``ctrl + n``  | Create game      |
| ``n``         | Next game        |
| ``b``         | Previous game    |
| ``e``         | Toggle engine    |
| ``o``         | Load a pgn       |
| ``x``         | Toggle explorer  |
| ``q``         | Quit application |

## Tests
```
make test
```

## Goals

- [x] Open source chess gui
  - [ ] Fully-featured
      - [x] Comments
      - [x] Variations
      - [ ] Annotations
      - [ ] Engine matches
      - [x] Engine options
  - [ ] Easy to install
  - [ ] Fluid design
  - [x] Cross-platform
  - [ ] Ease of use
  - [x] Modularity
  - [x] Database

## Progress

Navigation is controlled by keybindings instead of button right now. Comments, variations, and annotations have yet to be added. The chess.com database explorer (doesn't need to login) and the engine have been stably implemented. School and CollegeBoard tests are ramping up for me so I can't work on this for much time as of now.

WayChess

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README