flutter_stockfish_plugin/README.md

44 lines
1.7 KiB
Markdown
Raw Normal View History

2023-10-29 22:47:21 +01:00
# flutter_stockfish_plugin
2023-11-01 20:03:05 +01:00
A Flutter plugin for the Stockfish Chess engine.
2023-10-29 22:47:21 +01:00
2023-11-01 20:03:05 +01:00
The current version is based on Stockfish 16.
2023-10-29 22:47:21 +01:00
## Usage
```dart
final stockfish = new Stockfish()
// Listen on stdout of Stockfish engine
final stockfishSubscription = stockfish.stdout.listen((line) {
print("received: $line");
});
// Sending UCI command to get Stockfish ready
stockfish.stdin = 'isready'
stockfish.stdin = 'position startpos moves e2e4' // set up start position
stockfish.stdin = 'go depth 20' // search bestmove with a max septh of 20
// Don't remember to dispose Stockfish when you're done.
// Make shure to dispose Stockfish when closing the app. May use WindowListener.
stockfishSubscription.cancel();
stockfish.dispose();
```
2023-11-01 20:33:41 +01:00
A complete Example can be found at [stockfish_chess_engine](https://github.com/loloof64/StockfishChessEngineFlutter).
2023-10-29 22:47:21 +01:00
## Goal of this fork of stockfish_chess_engine
2023-11-01 20:03:05 +01:00
* Avoid limitation. This version does not redirect stdout and stdin of the app for communication with stockfish.
* stdin and stdout were replaced with a fakestream element.
* Stockfish internal logging might not work (could be fixed).
2023-10-29 22:47:21 +01:00
## Credits
* Based on and using source code from [stockfish_chess_engine](https://github.com/loloof64/StockfishChessEngineFlutter)
* Using source code from [Stockfish](https://stockfishchess.org).
* Using source code from [Flutter Stockfish](https://github.com/ArjanAswal/Stockfish).
Directory src/Stockfish contains the latest current release.
The code is modified to use a different communication interface.
2023-11-01 20:03:05 +01:00
The original license for [Stockfish](https://stockfishchess.org) can be found in their [GitHub](https://github.com/official-stockfish/Stockfish) repository.