Flutter图像处理插件pikafish_engine的使用

简介

flutter_pikafish 是一个基于 Stockfish 的开源中国象棋引擎的 Flutter 插件。

使用方法

iOS 项目要求

iOS 项目必须设置 IPHONEOS_DEPLOYMENT_TARGET >= 11.0。

添加依赖

在 pubspec.yaml 文件中添加依赖：

dependencies:
  flutter_pikafish: ^<last-version>

初始化引擎

首先，导入必要的包并初始化引擎：

import 'package:pikafish_engine/pikafish_engine.dart';

// 创建一个新的实例
final pikafish = Pikafish();

// state 是一个 ValueListenable<PikafishState>
print(pikafish.state.value); // PikafishState.starting

// 引擎需要几秒钟来启动
await Future.delayed(Duration(seconds: 1));
print(pikafish.state.value); // PikafishState.ready

发送 UCI 命令

等待状态变为 ready 后，可以发送 UCI 命令。这些命令通过 stdin 属性发送，并且输出被定向到一个 Stream：

pikafish.stdin = 'isready';
pikafish.stdin = 'go movetime 3000';
pikafish.stdin = 'go infinite';
pikafish.stdin = 'stop';

监听引擎的输出：

pikafish.stdout.listen((line) {
  // 执行一些有用的操作
  print(line);
});

处理和热重载

当 Pikafish 引擎运行时，有两个活动的隔离区，这会干扰 Flutter 的热重载功能。因此，在尝试重新加载之前需要释放资源：

// 发送 UCI quit 命令
pikafish.stdin = 'quit';

// 或者更简单的方式
pikafish.dispose();

注意：一次只能创建一个实例。如果在现有实例活动时调用 Pikafish()，它将返回 null。

完整示例代码

以下是一个完整的示例代码，展示了如何在 Flutter 应用中使用 pikafish_engine 插件：

import 'dart:io';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:path_provider/path_provider.dart';
import 'package:pikafish_engine/pikafish_engine.dart';

import 'src/output_widget.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<StatefulWidget> createState() => _AppState();
}

class _AppState extends State<MyApp> {
  late Pikafish pikafish;

  [@override](/user/override)
  void initState() {
    super.initState();
    pikafish = Pikafish();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    var commands = [
      'd',
      'isready',
      'go infinite',
      'go movetime 3000',
      'stop',
      'quit',
    ];
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text('Pikafish 示例应用')),
        body: Column(
          children: [
            Padding(
              padding: const EdgeInsets.all(8.0),
              child: AnimatedBuilder(
                animation: pikafish.state,
                builder: (_, __) => Text(
                  'pikafish.state=${pikafish.state.value}',
                  key: const ValueKey('pikafish.state'),
                ),
              ),
            ),
            Padding(
              padding: const EdgeInsets.all(8.0),
              child: AnimatedBuilder(
                animation: pikafish.state,
                builder: (_, __) => ElevatedButton(
                  onPressed: pikafish.state.value == PikafishState.disposed
                      ? () {
                          final newInstance = Pikafish();
                          setState(() => pikafish = newInstance);
                        }
                      : null,
                  child: const Text('重置 Pikafish 实例'),
                ),
              ),
            ),
            Padding(
              padding: const EdgeInsets.all(8.0),
              child: TextField(
                autocorrect: false,
                decoration: const InputDecoration(
                  labelText: '自定义 UCI 命令',
                  hintText: 'go infinite',
                ),
                onSubmitted: (value) => pikafish.stdin = value,
                textInputAction: TextInputAction.send,
              ),
            ),
            ElevatedButton(
              onPressed: setupNnue,
              child: const Text('设置 NNUE 文件'),
            ),
            Wrap(
              children: commands
                  .map(
                    (command) => Padding(
                      padding: const EdgeInsets.all(8.0),
                      child: ElevatedButton(
                        onPressed: () => pikafish.stdin = command,
                        child: Text(command),
                      ),
                    ),
                  )
                  .toList(growable: false),
            ),
            Expanded(child: OutputWidget(pikafish.stdout)),
          ],
        ),
      ),
    );
  }

  void setupNnue() async {
    //
    final appDocDir = await getApplicationDocumentsDirectory();
    final nnueFile = File('${appDocDir.path}/pikafish.nnue');

    if (!(await nnueFile.exists())) {
      await nnueFile.create(recursive: true);
      final bytes = await rootBundle.load('assets/pikafish.nnue');
      await nnueFile.writeAsBytes(bytes.buffer.asUint8List(), flush: true);
    }

    pikafish.stdin = 'setoption name EvalFile value ${nnueFile.path}';
  }
}