Stockfish.wasm 项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00090/article/details/138892100

Stockfish.wasm 项目教程

stockfish.wasm WebAssembly port of the strong chess engine Stockfish 项目地址: https://gitcode.com/gh_mirrors/st/stockfish.wasm

1. 项目的目录结构及介绍

Stockfish.wasm 项目的目录结构如下：

stockfish.wasm/
├── AUTHORS
├── Copying.txt
├── Readme.md
├── Readme.upstream.md
├── Top CPU Contributors.txt
├── appveyor.upstream.yml
├── index.html
├── package.json
├── preamble.js
├── travis.upstream.yml
├── src/
│   ├── ...
├── tests/
│   ├── ...
├── github/workflows/
│   ├── ...
└── .gitignore

目录结构介绍

AUTHORS: 项目贡献者列表。
Copying.txt: 项目的许可证文件，遵循 GPL-3.0 许可证。
Readme.md: 项目的自述文件，包含项目的基本信息和使用说明。
Readme.upstream.md: 上游项目的自述文件。
Top CPU Contributors.txt: 主要 CPU 贡献者列表。
appveyor.upstream.yml: AppVeyor CI 配置文件。
index.html: 项目的入口 HTML 文件。
package.json: 项目的 npm 配置文件，包含项目的依赖和脚本。
preamble.js: 项目的前置脚本文件。
travis.upstream.yml: Travis CI 配置文件。
src/: 项目的源代码目录，包含主要的 WebAssembly 代码。
tests/: 项目的测试代码目录。
github/workflows/: GitHub Actions 的工作流配置文件目录。
.gitignore: Git 忽略文件配置。

2. 项目的启动文件介绍

项目的启动文件是 index.html。该文件是项目的入口点，负责加载和初始化 Stockfish.wasm 引擎。

index.html 文件内容

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Stockfish.wasm</title>
</head>
<body>
    <script src="stockfish.js"></script>
    <script>
        Stockfish().then((sf) => {
            sf.addMessageListener((line) => {
                console.log(line);
            });
            sf.postMessage("uci");
        });
    </script>
</body>
</html>

启动文件介绍

<script src="stockfish.js"></script>: 加载 Stockfish.js 文件，该文件负责初始化和加载 WebAssembly 模块。
Stockfish().then((sf) => {...}): 初始化 Stockfish 引擎，并在引擎准备好后执行回调函数。
sf.addMessageListener((line) => {...}): 添加消息监听器，用于接收引擎的输出。
sf.postMessage("uci"): 向引擎发送 UCI 命令，启动引擎。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 appveyor.upstream.yml。

package.json 文件内容

{
  "name": "stockfish.wasm",
  "version": "1.0.0",
  "description": "WebAssembly port of the strong chess engine Stockfish",
  "main": "index.html",
  "scripts": {
    "prepare": "em++ -O3 -s USE_PTHREADS=1 -s PTHREAD_POOL_SIZE=4 -s TOTAL_MEMORY=16777216 -s ALLOW_MEMORY_GROWTH=1 -s EXPORTED_FUNCTIONS='[\"_main\",\"_uci\",\"_ucinewgame\",\"_isready\",\"_position\",\"_go\",\"_stop\",\"_ponderhit\",\"_quit\"]' -s EXPORTED_RUNTIME_METHODS='[\"ccall\",\"cwrap\"]' -o stockfish.js src/main.cpp"
  },
  "author": "lichess.org",
  "license": "GPL-3.0",
  "dependencies": {
    "stockfish.wasm": "file:./"
  }
}

package.json 文件介绍

name: 项目名称。
version: 项目版本。
description: 项目描述。
main: 项目的入口文件。
scripts: 包含项目的构建脚本，使用 em++ 编译 WebAssembly 模块。
author: 项目作者。
license: 项目许可证。
dependencies: 项目依赖。

appveyor.upstream.yml 文件内容

version: 1.0.{build}
image: Visual Studio 2019
platform: x64
configuration: Release
before_build:
  - cmd: npm install
build:
  project: stockfish.wasm.sln
test: off