mirror of
https://github.com/j2masamitu/obsidian-goboard-viewer.git
synced 2026-07-22 06:42:06 +00:00
- Add comprehensive v2.0.0 changelog entry with all new features - Document SGF editor mode with sgf/sgf-edit code block distinction - Add usage examples for both view mode and edit mode - Update feature lists with editor capabilities: - Interactive editing (add/remove stones, labels) - Comment editor - Game info editor - Move deletion - SGF output display - Auto-play mode - Add move parameter documentation for embedded SGF files - Update both English and Japanese documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
9.8 KiB
9.8 KiB
Obsidian Go Board Viewer
SGF(Smart Game Format)ファイルやコードブロックを、再生機能付きのインタラクティブな碁盤として表示するObsidianプラグインです。
📱 デスクトップとモバイルの両方で動作 - このプラグインはデスクトップとiOSとAndroidのモバイルをサポートしています。
機能
主要機能
- 📱 モバイル・デスクトップ対応: iOS、Android、Windows、Mac、Linuxで完全に動作
- SGFコードブロック対応: ````sgf`コードブロック内のSGFテキストを自動的に碁盤として描画
- SGFファイル埋め込み対応:
![[game.sgf]]構文で.sgfファイルを表示、オプションパラメータ対応moveパラメータ: 特定の手数から表示を開始(例:![[game.sgf|move=10]])
- 直接ファイルを開く:
.sgfファイルをObsidian内で直接開いて表示 - 対局情報の表示: 対局者名、棋力、棋戦名、日付、コミ、置石、結果を表示
SGF編集機能(v2.0.0の新機能)
- 閲覧/編集モード選択: コードブロックの言語タグでモードを選択
- ````sgf` - 閲覧専用モード(デフォルト): 完全な再生コントロールで棋譜を閲覧・ナビゲート
- ````sgf-edit` - 編集モード: 碁盤操作によるインタラクティブ編集
- インタラクティブ編集: 碁盤をクリックして変更を加える
- 石を追加: 黒石または白石を配置
- 石を削除: 既存の石を削除
- ラベル追加: 交点にカスタムテキストラベルを追加
- コメント編集: 現在の局面のコメントを編集・保存
- 対局情報編集: 対局者名、棋力、対局名を編集
- 手の削除: 現在の局面以降の手を削除
- SGF出力: 編集されたSGFテキストをリアルタイムで表示・コピー
- 自動再生モード: 再生/一時停止コントロール付きの自動再生機能(閲覧モードのみ)
再生・ナビゲーション
- 再生コントロール: 最初/前/次/最後のボタンで棋譜を再生
- 手のコメント表示: 各手に関連付けられたコメントを表示
- 変化図対応: 複数の変化図を処理し、選択可能
SGF機能
- SGFマーカー: SGFマークアッププロパティを完全サポート:
- LB(ラベル): 交点上のテキストラベル
- TR(三角): 三角マーカー
- SQ(四角): 四角マーカー
- CR(円): 円マーカー
- MA(マーク): バツ印マーカー
- 配置石: AB(黒石配置)、AW(白石配置)、AE(空点)をサポート
- 複数の盤サイズ: 19路盤、13路盤、9路盤、カスタムサイズ対応
デザイン・カスタマイズ
- レスポンシブデザイン: 様々な画面サイズに対応 - スマホやタブレットでの棋譜研究に最適
- タッチ操作対応: モバイルデバイス向けに最適化されたボタンサイズとレイアウト
- 色のカスタマイズ: 設定画面から完全な色のカスタマイズが可能:
- 碁盤の背景色
- 碁盤の線の色(星も含む)
- 座標ラベルの色
- SGFマーカーの色(○△□、ラベルなど)
- 変化図ラベルの色
- デフォルトに戻すボタン
スクリーンショット
基本的な棋譜表示
ソース表示
インストール方法
手動インストール
- Releasesページから最新版をダウンロード
- ファイルをObsidian vaultの
.obsidian/plugins/goboard-viewer/ディレクトリに展開 - Obsidianの設定 → コミュニティプラグインでプラグインを有効化
同期プラグインを使用しているモバイルユーザーへの注意:
- 「Remotely Save」などの同期プラグインを使用している場合、プラグインをモバイルデバイスに同期するには一時的に「Sync Config Dir」を有効にする必要があります
- 手順:
- 同期プラグインの設定で「Sync Config Dir」を有効化
- 同期を実行して完了を待つ
- モバイルデバイスでプラグインが表示されることを確認
- インストール完了後、「Sync Config Dir」を無効に戻しても構いません
- 重要: プラグインを新しいバージョンに更新する際は、再度「Sync Config Dir」を有効にして同期する必要があります
ソースからビルド
- このリポジトリをクローン
- 依存関係をインストール:
npm install - プラグインをビルド:
npm run build - 以下のファイルを
.obsidian/plugins/goboard-viewer/にコピー:manifest.jsonmain.jsstyles.css
- Obsidianの設定でプラグインを有効化
開発モード
npm install
npm run dev
開発モードでは、ファイルの変更を監視して自動的に再ビルドします。
使い方
方法1: SGFコードブロック(閲覧モード)
閲覧用にマークダウンノートにSGFコードブロックを追加:
```sgf
(;SZ[19];B[pd]C[初手は星];W[dp];
B[qp];W[dc];B[nq]
;W[qc]C[ダイレクト三々])
```
方法1b: SGFコードブロック(編集モード)
編集を有効にするにはsgf-edit言語タグを使用:
```sgf-edit
(;SZ[19];B[pd]C[初手は星];W[dp];
B[qp];W[dc];B[nq]
;W[qc]C[ダイレクト三々])
```
編集モードでは以下のことができます:
- 交点をクリックして石やラベルを追加/削除
- 現在の局面のコメントを編集
- 対局情報(対局者名、棋力など)を編集
- 現在の局面から手を削除
- 出力エリアから編集されたSGFをコピー
方法2: SGFファイルの埋め込み
- vaultに
.sgfファイルを追加 - ノートに埋め込み:
![[my-game.sgf]]
マーカーの使用
SGFマーカーは赤色(変化図は青色)で表示されます:
(;SZ[9]AB[aa][ba][ca][da][ea]AW[ac][bc][cc][dc][ec]TR[aa][ab][ac]SQ[ba][bb][bc]MA[ca][cb][cc]CR[da][db][dc]LB[ea:1][eb:2][ec:3])
- TR: 赤い三角 ▲
- MA: 赤いバツ印 ✕
- SQ: 赤い四角 □
- CR: 赤い円 ○
- LB: 赤いテキストラベル
- 変化図マーカー: 青い文字(A、B、C...)
変化図の処理
局面に複数の変化がある場合、プラグインは以下を表示します:
- 盤上の青い文字マーカー(A、B、C...)で各変化の開始位置を表示
- 盤の下に変化選択ボタンを表示
- 手数の横に「(has variations)」インジケーターを表示
変化ボタンをクリックして分岐を切り替えます。
SGF例
シンプルな対局
(;GM[1]FF[4]SZ[19]KM[6.5]DT[2025-11-08];B[pd]C[星];W[dp];B[pp];W[dd];B[fq];W[qq]C[ダイレクト三々];B[pq];W[qp];B[po];W[rn];B[cf];W[cn];B[fc];W[df];B[dg];W[ef];B[cd];W[cc];B[ce];W[dc];B[hc])
変化図のある棋譜
(;GM[1]FF[4]SZ[19]KM[6.5]DT[2025-11-08];B[pd]C[星];W[dp];B[pp];W[dd];B[fq](;W[qq]C[ダイレクト三々];B[pq];W[qp];B[po];W[rn];B[cf];W[cn];B[fc];W[df];B[dg];W[ef];B[cd];W[cc];B[ce];W[dc];B[hc])(;W[cn]C[ケイマ受け];B[dq];W[cq];B[cr]))
配置石のある詰碁
(;SZ[9]AW[ab][bb][cb][db][da]AB[ec][dc][cc][bc][ac][eb][ea]C[黒先白死];B[ba]C[三目ナカデ])
技術詳細
- @sabaki/shudan: 碁盤描画ライブラリ
- @sabaki/sgf: SGFファイル解析
- Preact: 軽量UI描画
- Obsidian API: MarkdownPostProcessorとMarkdownCodeBlockProcessor
- オフライン: インターネット接続不要で動作
対応SGFプロパティ
対局情報
- FF(ファイル形式)、GM(ゲーム)、SZ(サイズ)
- PB(黒のプレイヤー)、PW(白のプレイヤー)
- BR(黒の棋力)、WR(白の棋力)
- KM(コミ)、HA(置石)、RU(ルール)
- DT(日付)、GN(対局名)、EV(イベント)、RO(ラウンド)、PC(場所)
- RE(結果)
手と配置
- B(黒の着手)、W(白の着手)
- AB(黒石配置)、AW(白石配置)、AE(空点)
- C(コメント)
マークアップ
- TR(三角)、SQ(四角)、CR(円)
- MA(マーク/バツ)、LB(ラベル)
変化図
- ゲームツリーの変化を完全サポート、選択UI付き
既知の制限
- 時間情報(BL、WL)は表示されません
- 一部の高度なSGFプロパティは完全にサポートされていない場合があります
貢献
貢献を歓迎します!IssueやPull Requestをお気軽に送ってください。
- リポジトリをフォーク
- フィーチャーブランチを作成:
git checkout -b feature/my-feature - 変更をコミット:
git commit -am 'Add some feature' - ブランチにプッシュ:
git push origin feature/my-feature - Pull Requestを送信
ライセンス
MIT License - 詳細はLICENSEファイルを参照
謝辞
- Sabaki - 碁盤描画ライブラリ
- SGF File Format - 標準仕様
- Obsidian - ナレッジベースプラットフォーム

