GUI の使い方

起動

配布パッケージを使う場合:

nyxpy gui

リポジトリの内容を直接使う場合:

uv run nyxpy gui

nyx-gui でも同じ GUI を起動できます。

起動すると、コマンドを実行したディレクトリまたは親ディレクトリから workspace が探されます。workspace がない場所で起動した場合は、その場所が新しい workspace として初期化されます。既存 workspace を使う場合は、対象ディレクトリへ移動してから起動してください。

初回の流れ

  1. workspace で nyxpy init を実行する。
  2. キャプチャデバイスとシリアルデバイスを接続する。
  3. nyxpy gui を起動する。
  4. 設定 でキャプチャデバイスとシリアルデバイスを選ぶ。
  5. リロード でマクロ一覧を更新する。
  6. 実行するマクロを選んで 実行 を押す。

NyX GUI の画面例

画面例では、左側にマクロ一覧と操作ボタン、中央にプレビュー、下部にコントローラー表示とマクロログ、右側にツールログが表示されています。

画面の見方

領域 用途
マクロ一覧 workspace の macros/ から読み込んだマクロを表示する
リロード マクロを追加・更新した後に一覧を読み直す
実行 選択中のマクロを開始する
実行 横のメニュー --define 相当のパラメータを GUI から入力して実行する
停止 実行中のマクロへ中断を要求する
スナップショット 現在のプレビュー画像を snapshots/ に保存する
設定 デバイス、通知、ログ、表示設定を変更する
マクロログ マクロ実行中の利用者向けログを表示する
ツールログ デバイス接続や設定反映など、NyX 本体側のログを表示する

マクロの配置

利用者が実行するマクロは workspace の macros/ と resources/ に置きます。

macros/sample_macro/
  macro.py

resources/sample_macro/
  settings.toml
  assets/

examples/macros と examples/resources は参照用サンプルです。利用者の配置先ではありません。

マクロを配置した後に GUI を開いている場合は、リロード を押して一覧を更新します。マクロが表示されない場合は、トラブルシューティング の「マクロが見つからない」を確認してください。

パラメータ付きで実行する

実行 ボタン右側のメニューから パラメータ付きで実行 を選ぶと、マクロへ渡す key=value を入力できます。入力できる項目名と値はマクロごとに異なるため、マクロ配布元の説明を確認してください。

プレビューとスナップショット

GUI のプレビュー領域にキャプチャ中の画面が表示されます。スナップショットは workspace の snapshots/ に保存されます。

プレビューが表示されない場合は、トラブルシューティング の「プレビューが表示されない」を確認してください。

ログを確認する

GUI のログ欄に加えて、workspace の logs/ と runs/ に実行ログが保存されます。Issue や相談にログを貼る場合は、通知 URL、token、個人名、端末固有の情報が含まれていないか確認してください。