Change plugin ID to comply with Obsidian guidelines

BREAKING CHANGE: Plugin ID changed from "obsidian-goboard-viewer" to "goboard-viewer"

- Update manifest.json: id changed to "goboard-viewer"
- Update package.json: name changed to "goboard-viewer"
- Update installation paths in README.md and README_ja.md
- Update setup.sh and CONTRIBUTING.md with new plugin folder name

Reason: Obsidian plugin guidelines state "The id can't contain obsidian."
This change is required for Community Plugins submission.

Existing users will need to reinstall the plugin in the new folder:
  .obsidian/plugins/goboard-viewer/

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
j2masamitu 2025-11-10 13:59:01 +09:00
parent 2347f9125c
commit 09a434fd67
6 changed files with 9 additions and 9 deletions

View file

@ -30,7 +30,7 @@ npm run build
Test the plugin in Obsidian:
1. Build the plugin
2. Copy `manifest.json`, `main.js`, and `styles.css` to your vault's `.obsidian/plugins/obsidian-goboard-viewer/`
2. Copy `manifest.json`, `main.js`, and `styles.css` to your vault's `.obsidian/plugins/goboard-viewer/`
3. Reload Obsidian
4. Enable the plugin in Settings

View file

@ -47,7 +47,7 @@ An Obsidian plugin that displays SGF (Smart Game Format) files and code blocks a
### Manual Installation
1. Download the latest release from the [Releases page](https://github.com/j2masamitu/obsidian-goboard-viewer/releases)
2. Extract the files to your Obsidian vault's `.obsidian/plugins/obsidian-goboard-viewer/` directory
2. Extract the files to your Obsidian vault's `.obsidian/plugins/goboard-viewer/` directory
3. Enable the plugin in Obsidian Settings → Community Plugins
**Note for Mobile Users with Sync Plugins**:
@ -64,7 +64,7 @@ An Obsidian plugin that displays SGF (Smart Game Format) files and code blocks a
1. Clone this repository
2. Install dependencies: `npm install`
3. Build the plugin: `npm run build`
4. Copy the following files to `.obsidian/plugins/obsidian-goboard-viewer/`:
4. Copy the following files to `.obsidian/plugins/goboard-viewer/`:
- `manifest.json`
- `main.js`
- `styles.css`

View file

@ -47,7 +47,7 @@ SGFSmart Game Formatファイルやコードブロックを、再生機能
### 手動インストール
1. [Releasesページ](https://github.com/j2masamitu/obsidian-goboard-viewer/releases)から最新版をダウンロード
2. ファイルをObsidian vaultの`.obsidian/plugins/obsidian-goboard-viewer/`ディレクトリに展開
2. ファイルをObsidian vaultの`.obsidian/plugins/goboard-viewer/`ディレクトリに展開
3. Obsidianの設定 → コミュニティプラグインでプラグインを有効化
**同期プラグインを使用しているモバイルユーザーへの注意**
@ -64,7 +64,7 @@ SGFSmart Game Formatファイルやコードブロックを、再生機能
1. このリポジトリをクローン
2. 依存関係をインストール: `npm install`
3. プラグインをビルド: `npm run build`
4. 以下のファイルを`.obsidian/plugins/obsidian-goboard-viewer/`にコピー:
4. 以下のファイルを`.obsidian/plugins/goboard-viewer/`にコピー:
- `manifest.json`
- `main.js`
- `styles.css`

View file

@ -1,5 +1,5 @@
{
"id": "obsidian-goboard-viewer",
"id": "goboard-viewer",
"name": "Go Board Viewer",
"version": "1.0.0",
"minAppVersion": "0.15.0",

View file

@ -1,5 +1,5 @@
{
"name": "obsidian-goboard-viewer",
"name": "goboard-viewer",
"version": "1.0.0",
"description": "Obsidian plugin to display SGF files as interactive Go boards with playback controls, variations, and markers",
"main": "main.js",

View file

@ -53,7 +53,7 @@ echo "======================================"
echo ""
echo "Next steps:"
echo "1. Copy these files to your Obsidian vault:"
echo " .obsidian/plugins/obsidian-goboard-viewer/"
echo " .obsidian/plugins/goboard-viewer/"
echo ""
echo " Files to copy:"
echo " - manifest.json"
@ -65,5 +65,5 @@ echo "3. Enable 'Go Board Viewer' in Settings → Community Plugins"
echo ""
echo "Or use a symbolic link for development:"
echo " cd /path/to/vault/.obsidian/plugins/"
echo " ln -s $(pwd) obsidian-goboard-viewer"
echo " ln -s $(pwd) goboard-viewer"
echo ""