LizGoban 开源项目教程

LizGoban 开源项目教程

lizgobanLeela Zero & KataGo visualizer项目地址:https://gitcode.com/gh_mirrors/li/lizgoban

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

LizGoban 是一个用于围棋分析的工具，结合了 Leela Zero 和 KataGo。以下是项目的目录结构及其介绍：

lizgoban/
├── github/workflows/
│   ├── build_with_external.yml
│   └── ...
├── src/
│   ├── main.js
│   └── ...
├── .gitignore
├── LICENSE.txt
├── Makefile
├── NOTE.txt
├── OBSOLETE.md
├── README.md
├── faces.png
├── lizgoban_windows.ps1
├── lizgoban_windows.vbs
├── match.png
├── package.json
├── screen.gif
└── ...

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• src/: 项目的源代码目录，包含主要的 JavaScript 文件。
• .gitignore: Git 忽略文件配置。
• LICENSE.txt: 项目的许可证文件。
• Makefile: 用于构建项目的 Makefile。
• NOTE.txt: 项目的一些注释或说明。
• OBSOLETE.md: 过时的文档或说明。
• README.md: 项目的说明文档。
• faces.png: 围棋棋子的图像文件。
• lizgoban_windows.ps1: Windows 平台的启动脚本。
• lizgoban_windows.vbs: Windows 平台的启动脚本。
• match.png: 匹配相关的图像文件。
• package.json: Node.js 项目的配置文件。
• screen.gif: 项目的屏幕截图。

2. 项目的启动文件介绍

LizGoban 的启动文件主要包括以下几个：

• lizgoban_windows.ps1: Windows 平台的 PowerShell 启动脚本。
• lizgoban_windows.vbs: Windows 平台的 VBScript 启动脚本。
• src/main.js: 项目的入口 JavaScript 文件。

在 Windows 平台上，可以通过双击 lizgoban_windows.vbs 文件来启动 LizGoban。在其他平台上，可以通过运行 npm start 命令来启动项目。

3. 项目的配置文件介绍

LizGoban 的配置文件主要包括 package.json 和 config.json。

• package.json: 这是 Node.js 项目的标准配置文件，包含了项目的依赖、脚本命令等信息。

{
  "name": "lizgoban",
  "version": "0.8.0-pre6",
  "description": "Leela Zero & KataGo visualizer",
  "main": "src/main.js",
  "scripts": {
    "start": "electron ."
  },
  "dependencies": {
    "electron": "^12.0.0"
  }
}

• config.json: 这是 LizGoban 的自定义配置文件，用于配置 KataGo 和其他引擎的参数。

{
  "preset": [
    {
      "label": "KataGo",
      "engine": [
        "/FOO/BAR/katago",
        "gtp",
        "-override-config",
        "analysisPVLen=50 defaultBoardSize=19",
        "-model",
        "/FOO/BAR/model.bin.gz",
        "-config",
        "/FOO/BAR/gtp.cfg"
      ]
    }
  ]
}

在 Windows 平台上，可以将 config.json 文件放置在与 lizgoban_windows.vbs 相同的目录中，并通过双击 lizgoban_windows.vbs 来启动项目。在其他平台上，可以通过运行 npm start -- -c config.json 来启动项目。

lizgobanLeela Zero & KataGo visualizer项目地址:https://gitcode.com/gh_mirrors/li/lizgoban