waves/public/assets/g/chess/other-implementations/example1/README.md
2025-04-09 17:11:14 -05:00

65 lines
2.0 KiB
Markdown

# BoldChess-Stockfish-Web-GUI - Other Implementations - Example 1
## Overview
A web graphical user interface (GUI) that loads the JS compiled version of the Stockfish chess engine. It is a functional Web GUI that works out-of-box on all operating systems.
## Features
- Lightweight.
- Easy To Install.
- Fully Responsive.
- Uses Stockfish Version 10.
- Uses Bootstrap Version 4.3.1.
- Uses jQuery 3.4.1.
- Uses Chessboard.js Version 1.0.0.
## Online Installation
- Unzip the compressed file.
- Upload the unzipped folder to your web server then view its path from your web browser.
## Local Installation
- Install [XAMPP](https://www.apachefriends.org/index.html) or any other alternative localhost stack.
- Unzip the compressed file.
- Copy the unzipped folder to the (htdocs) directory then view its path from your web browser.
## Contribution
We welcome all developers to contribute to this repository by adding features or fixing bugs. It will always be free and open source.
## Known Issues
- In some cases, the timer text is not updating itself for the end users.
- After the first move, the move evaluation text is getting printed twice.
## Possible Improvements
- Improving the user interface and make it much more attractive.
- Adding an ability to "undo" a certain move.
- Adding an option to set FEN.
- Adding an option to export the game.
- Integrating a chess opening book.
## License
GNU GPLv3: [https://www.gnu.org/licenses/gpl-3.0-standalone.html](https://www.gnu.org/licenses/gpl-3.0-standalone.html)
## Credits
- Stockfish: [https://github.com/mcostalba/Stockfish](https://github.com/mcostalba/Stockfish)
- Stockfish.js: [https://github.com/nmrugg/stockfish.js](https://github.com/nmrugg/stockfish.js)
- Chessboard.js: [https://github.com/oakmac/chessboardjs/](https://github.com/oakmac/chessboardjs/)
- Bootstrap: [https://github.com/twbs/bootstrap](https://github.com/twbs/bootstrap)
- jQuery: [https://github.com/jquery/jquery](https://github.com/jquery/jquery)
- Labinator: [https://labinator.com](https://labinator.com)