View on GitHub

cat-oscillator-sync

cat-oscillator-sync

クイックスタート - TypeScript/Node.js CLI版(Windows専用)

最速で動かすための手順書です。

前提条件

手順

1. Node.jsのインストール

  1. Node.js公式サイトにアクセス
  2. LTS版(推奨版)のWindowsインストーラーをダウンロード
  3. ダウンロードしたインストーラー(.msiファイル)を実行
  4. インストールウィザードに従ってインストール
    • すべてデフォルト設定でOK

2. インストールの確認

コマンドプロンプトまたはPowerShellを開いて、以下のコマンドを実行:

node --version
npm --version

バージョン番号が表示されればOKです。

3. ビルドツールのインストール(必要な場合)

ネイティブモジュールのビルドに必要です。以下のいずれかの方法でインストールしてください:

方法1: winget を使用(推奨) PowerShellを管理者権限で開き、以下を実行:

winget install --id Microsoft.VisualStudio.2022.BuildTools --override "--wait --passive --add Microsoft.VisualStudio.Workload.VCTools --includeRecommended"

方法2: Visual Studio Build Tools を手動インストール

  1. Visual Studio Downloads にアクセス
  2. “Build Tools for Visual Studio 2022” をダウンロード
  3. インストーラーを実行し、「C++ によるデスクトップ開発」ワークロードを選択
  4. インストール(10-15分程度かかります)

注意: インストール完了後、コマンドプロンプトまたはPowerShellを再起動してください。

4. リポジトリのクローンと移動

git clone https://github.com/cat2151/cat-oscillator-sync.git
cd cat-oscillator-sync\src\typescript\cli

5. 依存パッケージのインストール

npm install

注意: 初回インストール時、ネイティブモジュールのコンパイルが行われます。 数分かかることがあります。

6. ビルド

npm run build

7. 実行

シンプル版

npm start

スムーズ版

node dist/main.js smooth

操作方法

  1. プログラムが起動したら、マウスを動かしてください
  2. 音が出れば成功です!
    • X軸: マスター周波数 (40Hz - 600Hz)
    • Y軸: スレーブ周波数 (100Hz - 2000Hz)
  3. Ctrl+C で終了

トラブルシューティング

エラー: “node-gyp のビルドに失敗しました”

原因: C++ビルドツールがインストールされていません

解決方法: PowerShellを管理者権限で開き、以下を実行:

winget install --id Microsoft.VisualStudio.2022.BuildTools --override "--wait --passive --add Microsoft.VisualStudio.Workload.VCTools --includeRecommended"

インストール完了後、コマンドプロンプトまたはPowerShellを再起動し、再度 npm install を実行

エラー: “Cannot find module”

原因: 依存パッケージがインストールされていないか、ビルドされていません

解決方法:

npm install
npm run build

音が出ない

解決方法:

  1. Windowsの音量設定を確認
  2. 既定のオーディオデバイスが正しく設定されているか確認
  3. 他のアプリケーションでオーディオが正常に動作するか確認
  4. PCを再起動してみる

マウスが認識されない

解決方法:

  1. コマンドプロンプトまたはPowerShellを管理者権限で実行してみる
  2. robotjs を再インストール:
    npm uninstall robotjs
    npm install robotjs
    

次のステップ

よくある質問

Q: インストールに時間がかかるのはなぜですか?

A: speakerrobotjs はネイティブモジュールであり、初回インストール時にC++コードのコンパイルが必要です。 通常、5-10分程度かかります。

Q: 管理者権限が必要ですか?

A: ビルドツールのインストール時は必要ですが、プログラムの実行自体には通常必要ありません。 ただし、マウス位置の取得で問題が発生した場合は、管理者権限で実行してみてください。