Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
added post-installation instructions, library information, related projects
  • Loading branch information
QueensGambit committed Nov 24, 2020
1 parent ed850c5 commit 482bdef
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# LiGround

> A mordern Chess Variant Analysis GUI for the 21st century
> A free, open-source and modern Chess Variant Analysis GUI for the 21st century
<img src="./media/screenshots/liground-0.0.1.png" alt="LiGround screenshot" title="LiGround screenshot." />

Expand All @@ -23,6 +23,41 @@ npm run lint

```

### Post-Installation Actions

* Move `ffish.wasm` of package `ml-research/liground/node_modules/ffish-es6` to the main directory `ml-research/liground`.

* [Download](https://github.com/ddugovic/Stockfish/releases) a binary of _Multi-Variant-Stockfish_ or build it from scratch.

* Rename the _Multi-Variant-Stockfish_ binary to `stockfish` and move it to `ml-research/liground/src/server/engines`.


### Libraries

The following libraries or assets are used in **LiGround**:

Library | Description | Usage
--- | --- | ---
[**ffish.js**](https://www.npmjs.com/package/ffish) | A high performance WebAssembly chess variant library based on [_Fairy-Stockfish_](https://github.com/ianfab/Fairy-Stockfish) as a standard module. | Used in the back-end to parse the UCI replies of the active engine.
[**ffish-es6.js**](https://www.npmjs.com/package/ffish-es6) | A high performance WebAssembly chess variant library based on [_Fairy-Stockfish_](https://github.com/ianfab/Fairy-Stockfish) as an ES6 module. | Used in the GUI for legal move generation, FEN parsing & validation, pocket pieces, ...
[**ChessgroundX**](https://github.com/gbtami/chessgroundx) | A free/libre open source chess UI developed for [lichess.org](https://lichess.org/) and [pychess.org](https://www.pychess.org/). | Used as the main UI board element.
[**ornicar/lila**](https://github.com/ornicar/lila) | The forever free, adless and open source chess server | Many high quality assets from [lichess.org](https://lichess.org/) (e.g. piece styles, board styles, chess fonts, ...) are used within this GUI.
[**Vue.js**](https://vuejs.org/) | The Progressive JavaScript Framework | Used as the main JavaScript Framework.
[**Electron**](https://www.electronjs.org/) | Build cross-platform desktop apps with JavaScript, HTML, and CSS | Used for exporting the GUI to the desktop.
[**electron-vue**](https://github.com/SimulatedGREG/electron-vue) | An Electron & Vue.js quick start boilerplate | Used for the boilerplate code.

### Related

Projects that influenced the creation of **LiGround**:

Project | Description
--- | ---
[**tinyChessServer**](https://github.com/MoritzWillig/tinyChessServer) | An xboard server for playing bughouse games via websockets
[**lichess.org/analysis**](https://lichess.org/analysis) | The forever free, adless and open source chess server
[**vue-chessboard**](https://github.com/vitogit/vue-chessboard) | Chessboard vue component to load positions, create positions and see threats
[**Nibbler**](https://github.com/fohristiwhirl/nibbler) | Leela Chess Zero (Lc0) interface
[**chess.js**](https://github.com/jhlywa/chess.js) | A Javascript chess library for chess move generation/validation, piece placement/movement, and check/checkmate/draw detection

---

This project was generated with [electron-vue](https://github.com/SimulatedGREG/electron-vue)@[45a3e22](https://github.com/SimulatedGREG/electron-vue/tree/45a3e224e7bb8fc71909021ccfdcfec0f461f634) using [vue-cli](https://github.com/vuejs/vue-cli). Documentation about the original structure can be found [here](https://simulatedgreg.gitbooks.io/electron-vue/content/index.html).

0 comments on commit 482bdef

Please sign in to comment.