Skip to content

Repository files navigation

Chordwiki-AutoScroller(Chrome / Firefox 拡張)

概要

Chordwiki-AutoScrollerは、ChordWikiの楽譜ページで自動スクロール機能を提供するブラウザ拡張です。手動スクロールやホイール操作と自動スクロールの両立、スムーズな再生体験を実現します。

対応ブラウザ: Google ChromeFirefox。Microsoft Edge(Chrome ウェブストア経由のインストール)ではページ側の機能が動作しない場合があります(未保証)。

主な機能

  • ChordWiki楽譜ページでの自動スクロール
  • 手動スクロール時は自動スクロールを一時停止し、即時同期
  • ホイール操作でスクロール速度を調整
  • ページ内に操作パネルを表示(速度調整・開始/停止)
  • 楽曲の再生時間を自動取得(iTunesMusicBrainz の順で参照)

manifest.json(ローカルのみ)

リポジトリには manifest.example.json を置き、実際の manifest.json は Git に含めません.gitignore)。公開したくない Chrome 拡張の key などは manifest.json にだけ書いてください

初回セットアップ(クローン後)

  1. manifest.example.jsonmanifest.json にコピーする。
  2. 必要なら manifest.jsonkey を追加する。

manifest.example.json を更新したいとき(Key 以外を Push したい)

ローカルで編集した manifest.json を正としkey フィールドだけを除いた内容でテンプレを上書きします。

node scripts/sync-manifest-example.js

その後、manifest.example.json をコミットしてください。バージョン自動 bump の pre-commit でも同様に manifest.example.json が更新されます。

バージョン番号の**唯一のソースは manifest.jsonversion**です。ポップアップ表示と MusicBrainz 向け User-Agent は実行時に chrome.runtime.getManifest().version を参照するため、background.js / popup.html に固定で書いておく必要はありません。

Chrome 提出用 ZIP

.\package-extension.ps1
# または
.\package-extension.ps1 -Target chrome

dist\Chordwiki-AutoScroller-<version>.zip が作成されます。ローカルの manifest.json(本物) が ZIP に入ります。

Firefox(AMO)提出用 ZIP

.\package-extension.ps1 -Target firefox
  • Zip: dist\Chordwiki-AutoScroller-<version>-firefox.zip
  • 一時読込用フォルダ: dist\firefox-unpacked\about:debugging →「一時的なアドオンを読み込む」でこの中の manifest.json を選択)

Firefox 用マニフェストは manifest.firefox.jsonbrowser_specific_settings.gecko.id 付き)。バージョンは manifest.json と pre-commit / version-sync で同期されます。

楽曲時間の取得で iTunes / MusicBrainz に検索語を送るため、Firefox マニフェストでは data_collection_permissions.requiredsearchTerms を宣言しています。

Firefox での動作確認

  1. .\package-extension.ps1 -Target firefox
  2. Firefox で about:debugging#/runtime/this-firefox
  3. 「一時的なアドオンを読み込む」→ dist\firefox-unpacked\manifest.json
  4. ChordWiki の曲ページで確認

使い方

  1. Chrome / Firefox 拡張としてインストール
  2. ChordWikiの楽譜ページを開くと自動でパネルが表示されます
  3. パネルで自動スクロールの開始/停止や速度調整が可能
  4. 手動でスクロールした場合は自動スクロールが一時停止し、260ms後に再開

バージョン番号(ストア公開)

  • Chrome ウェブストアの公開版は 1.0.8 → 次回 1.0.9 のように、ユーザー向けは必要最小限の patch 番号だけ上げる運用を推奨します。
  • 開発中にローカルだけ 1.0.10 … と進めても、ストア提出時は manifest.jsonversion を公開版に合わせてまとめる(今回の互換修正はすべて 1.0.9 に集約)。
  • 変更内容は CHANGELOG.md に記載します。

注意事項

  • コードやUIの詳細は今後変更される可能性があります。

ライセンス

MIT License

About

ChordWiki用のChrome拡張です。コード譜をオートスクロールします。

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages