https://github.com/arjanaswal/stockfish
The Stockfish Chess Engine for Flutter.
https://github.com/arjanaswal/stockfish
chess chess-engine flutter-chess flutter-stockfish stockfish
Last synced: 3 months ago
JSON representation
The Stockfish Chess Engine for Flutter.
- Host: GitHub
- URL: https://github.com/arjanaswal/stockfish
- Owner: ArjanAswal
- License: gpl-3.0
- Created: 2020-12-19T17:44:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2026-02-02T11:05:16.000Z (3 months ago)
- Last Synced: 2026-02-02T23:50:31.234Z (3 months ago)
- Topics: chess, chess-engine, flutter-chess, flutter-stockfish, stockfish
- Language: C++
- Homepage:
- Size: 921 KB
- Stars: 51
- Watchers: 4
- Forks: 29
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# stockfish
The Stockfish Chess Engine for Flutter.
Also check out [The Leela Chess Zero (lc0)](https://pub.dev/packages/leela_chess_zero) neural network chess engine for flutter.
## Architecture
This package wraps the **Stockfish chess engine** (C++) for use in Flutter applications on Android and iOS. It uses **Dart FFI (Foreign Function Interface)** to communicate between Dart and native C++ code.
For more information go to [architecture.md](architecture.md).
## Example
Check out this [working chess game](https://github.com/PScottZero/EnPassant/tree/stockfish) using this package by [@PScottZero](https://github.com/PScottZero).
Also see the [example](example) folder for a minimal Flutter app demonstrating usage.
## Usages
iOS project must have `IPHONEOS_DEPLOYMENT_TARGET` >=12.0.
### Add dependency
Update `dependencies` section inside `pubspec.yaml`:
```yaml
stockfish: ^1.8.1
```
### Init engine
```dart
import 'package:stockfish/stockfish.dart';
// create a new instance
final stockfish = Stockfish();
// state is a ValueListenable
print(stockfish.state.value); # StockfishState.starting
// the engine takes a few moment to start
await Future.delayed(...)
print(stockfish.state.value); # StockfishState.ready
```
### UCI command
Waits until the state is ready before sending commands.
```dart
stockfish.stdin = 'isready';
stockfish.stdin = 'go movetime 3000';
stockfish.stdin = 'go infinite';
stockfish.stdin = 'stop';
```
Engine output is directed to a `Stream`, add a listener to process results.
```dart
stockfish.stdout.listen((line) {
// do something useful
print(line);
});
```
### Dispose / Hot reload
There are two active isolates when Stockfish engine is running. That interferes with Flutter's hot reload feature so you need to dispose it before attempting to reload.
```dart
// sends the UCI quit command
stockfish.stdin = 'quit';
// or even easier...
stockfish.dispose();
```
Note: only one instance can be created at a time. The factory method `Stockfish()` will return `null` if it was called when an existing instance is active.