Obsidian 插件:Chess Study
插件名片
概述
一个国际象棋学习助手和 PGN 查看器/编辑器。
原文出处
下面自述文件的来源于 Readme
Readme(翻译)
下面是 chess-study 插件的自述翻译
黑曜石国际象棋学习
一个为 Obsidian 设计的国际象棋学习助手和 PGN 查看器/编辑器。
通过这个插件,你可以导入 PGN 文件或者开始一局全新的游戏。它允许你为每一步添加评论和箭头,这些内容将保存在你的 vault 中的一个 JSON 文件中。虽然它不是一个完整的分析棋盘,但它是一个有价值的工具,可以支持你在 Obsidian 中进行国际象棋笔记。
目录
动机
我喜欢 Obsidian 及其工具,但管理国际象棋局面的截图变得难以控制,而且更新也很麻烦。在 Obsidian 中拥有类似 lichess.org 或 chess.com 提供的 PGN 查看器将是很棒的。它应该能够让我们轻松地查看 PGN,添加箭头和评论,并将它们持久化在 Obsidian 存储库中。目前已存在的 替代方案 主要关注于可视化 FEN 快照,这就是为什么开始这个副项目的原因。
安装
一旦您禁用了安全模式,您可以通过导航到“设置”>“社区插件”>“浏览并搜索”来找到第三方插件“Chess Study”。安装完插件后,您可以在“设置”>“社区插件”下访问它。请注意,您必须启用插件才能使用它。您也可以从那里卸载插件。
使用方法
首先,将光标定位到您希望在笔记中放置 PGN 查看器/编辑器的位置。执行 Obsidian 命令“Chess Study: Insert PGN-Editor at cursor position”。
这个操作将触发一个模态窗口,在这里您可以选择粘贴您的 PGN 或将其留空以开始一局新的游戏。下面是它的样子:
点击“Submit”后,Obsidian Chess Study 将解析 PGN,生成一个新的 JSON 文件,位于您的 vault 中的 .obsidian/plugins/obsidian-chess-study/storage/{id}.json
,并在光标位置插入一个 chessStudy 代码块。以下是 chessStudy 代码块的示例:
之后,PGN 查看器/编辑器将渲染,您可以开始使用(样式与您的主题和强调色相匹配):
特点
1.0.0
- 导入 PGN 文件
- 以 JSON 格式存储游戏状态
- 添加自定义 PGN 查看器
- 仅允许合法移动
- 通过导航按钮和直接点击移动棋子
- 绘制和同步形状
- 添加并同步支持 Markdown 的评论
1.1.0
- 添加对变体的支持(深度为 1)
设置
以下是 chessStudy
代码块的可用设置:
设置 | 可能的值 | 描述 |
---|---|---|
chessStudyId | 有效的 nanoid | 存储在插件存储中的文件的有效 ID |
boardOrientation | white | black | 棋盘的方向 |
boardColor | green | brown | 棋盘的颜色 |
您可以在 Obsidian Chess Study 的插件设置中永久设置某些设置。
路线图
- 添加导出当前 FEN 的选项
- 添加从特定位置(FEN)开始的选项
- 添加撤销按钮
- 添加管理存储游戏的视图
- 添加更多样式
- 添加更多设置
使用的工具
- 国际象棋的可视化由 Chessground 提供支持
- 国际象棋的逻辑由 Chess.js 提供支持
- Markdown 编辑器由 TipTap 提供支持
- 图标由 Lucide 提供
- 所有的组件都由 React 组合在一起
替代方案
如果你想查看 FENs,可以尝试这些替代的 Obsidian 插件:
许可证
Obsidian Chess Study 使用 GPL-3.0 许可证。有关更多信息,请参阅 LICENSE。
反馈交流
其他渠道
版权声明
版权声明:所有 PKMer 文章如果需要转载,请附上原文出处链接。