Obsidian Stats logoObsidian Stats

Chinese chess

by weshell
5
4
3
2
1
Score: 53/100
Install Code

Description

The Chinese Chess (Xiangqi) plugin brings a fully interactive Chinese chess engine into your notes. It supports both FEN and PGN formats, letting you render games, review moves, and even create new variations directly within code blocks. The plugin registers a dedicated view for .pgn files, enabling real-time editing where any changes to moves, comments, or branches are saved back to the file automatically. You can customise almost every aspect, from board size and theme to whether move lists or notations are displayed. Extra features include saving and restoring positions, speech playback of moves, rotation of the board, and ICCS-compatible PGN handling. Mobile users can adjust the layout for smaller screens, while advanced users can embed parameters like protected mode or rotated view.

Reviews

No reviews yet.

Stats

14
stars
960
downloads
5
forks
260
days
0
days
112
days
2
total PRs
0
open PRs
0
closed PRs
2
merged PRs
2
total issues
0
open issues
2
closed issues
0
commits

Latest Version

2.6.3
4 months ago

Changelog

  • 修复分支图最小宽度限制
See all version on GitHub

README file from

Github

Obsidian中国象棋插件

版本 许可证

中文 | English

如果你喜欢这个项目，欢迎到我的主页
Bilibili
点赞、投币、交流

插件简介

中国象棋插件(Obsidian) 是一款为 Obsidian 笔记软件量身打造的中国象棋渲染引擎，支持以 FEN 和 PGN 格式展示棋局，并可进行推演。插件提供丰富的自定义设置、棋谱导航、分支变化和皮卡鱼分析连接等功能。

PGN 文件支持

本插件注册了 .pgn 文件的专属视图。在 Obsidian 中直接打开 .pgn 文件。

  • 实时读写：对棋谱的任何操作（如走子、添加变招或评论）都会被实时、自动地保存回原始 .pgn 文件。
  • 功能完备：支持分支变招、评论和标注。
  • 跳转AI：支持将当前分支打包到网页版皮卡鱼进行分析
  • 切换视图：支持通过文件菜单在文本视图和象棋视图间切换
  • 快速新建：支持工具栏按钮新建PGN文件

PGN 文件

代码块示例

提供两种代码块名

xiangqi: 用于在 Markdown 文件中展示棋谱, 留空为默认开局

```xiangqi
1. H2-E2 H9-G7
2. H0-G2 I9-H9
3. I0-H0 B9-C7
....
30. B2-B9 D9-D8
31. B9-G9 C2-C7
32. G7-E7  *
```

PGN 展示

xq: 用于生成生成带fEN的xiangqi代码段
xq代码块内的内容会被清空换成FEN

```xq

```

FEN 生成

功能特点

  • 棋盘渲染：可在笔记中展示并复盘中国象棋棋局

  • 定制开局:

    • 可视化编辑开局
    • 清空\填满辅助摆放
    • 先后手设置
    • 保存为fen

  • 棋谱保存：

    • 支持将走棋历史保存为 PGN 格式
    • 无 PGN 时保存按钮为灰色，有 PGN 时为绿色,推演后为橙色
    • 点击保存时弹出确认提示
    • 若当前无任何走棋记录，保存操作将清空原有 PGN

  • 自定义设置：

    • 主题支持深色/浅色/跟随系统
    • 按钮位置调整（右侧 / 底部）
    • 棋盘大小
    • 着法列表是否显示
    • 着法文字是否显示,及文字调整
    • 着法列表是否自动跳转到结尾
    • 可选是否朗读着法,移动端不支持

  • 移动端适配：通过手动调整棋盘大小和按钮位置，可适配手机等小屏设备

  • 朗读功能：可选的语音播报走棋内容（可在设置中启用/关闭）

  • 格式支持：支持 ICCS 格式的 PGN 棋谱

  • 跳转AI：支持将着法列表打包跳转到网页版皮卡鱼进行分析

使用方法

xq代码块

  1. 输入xq代码块标记即可
  2. 可手动编辑局面,右侧按钮可以清空填满棋盘,切换先手
  3. 编辑好后点击保存,会生成相应的带fen的xiangqi代码块

xiangqi代码块

  1. 将棋谱写入以 xiangqi 标记的代码块中
  2. FEN 格式可省略，省略则默认从标准开局开始。支持解析皮卡鱼的网页连接。
  3. 操作说明：
    • 若未手动走棋，着法列表会展示PGN
    • 手动走棋后，着法列表将展示手动后的记录
    • 点击“重置”恢复到手动推演前的着法
    • 再次点击"重置"回到最初状态
  4. 点击“保存”将用当前走法覆盖原 PGN 内容

可选参数

名称 值 描述
fen 可用的fen 特殊开局的fen代码,留空为默认开局
protected/p true/false ture时保存按钮将失效,留空为false
rotated/r true/flase true时倒转棋盘,留空为false,红方在下
示例
```xiangqi
r:true
p:true
2bk1a3/5n3/3Pb4/R7p/2p6/C3p2N1/PR2c3P/1nr1B1C2/4A4/1rB1KA3 w
1. G2-G9 F9-E8
2. D7-D8 D9-E9
3. D8-E8 E9-E8
4. A6-A8 E8-E9
```
  • 冒号中英文皆可,rp大小写皆可
  • fen 两边带不带引号都行,随意
  • PGN 两个个一起编号也行,不编号也行
  • 一个一个的写也行,怎么都行

安装说明

本插件已在 Obsidian 官方插件市场上线，搜索“Chinese chess”或者"xiangqi"即可安装。

  1. 打开 Obsidian。
  2. 进入 设置 (Settings)。
  3. 点击 第三方插件 (Community plugins)。
  4. 确保 安全模式 (Restricted mode) 已关闭。
  5. 点击 浏览 (Browse) 按钮。
  6. 在搜索框中输入 “Chinese chess”。
  7. 找到本插件并点击 安装 (Install)。
  8. 安装完成后，点击 启用 (Enable)。

打赏

如果喜欢该插件,可以打赏一下哦 打赏

Sponsors