ターミナルから Amplitude プロジェクトを作成
Amplitude プロジェクトを管理する公式のコマンドラインツールです。プロジェクトの作成、アセットの作成、検証、ビルドまで、手動でもスクリプトからでも実行できるシンプルなコマンドで行えます。
$ curl -fsSL https://cli.amplitudeaudiosdk.com/install.sh | bash 開発初期段階のため、コマンドや出力はリリースごとに変わる場合があります。
# プロジェクトを作成して移動 $ am project init my_game $ cd my_game # ループする足音を作成 $ am asset sound create footstep \ --file audio/step.wav --bus sfx --gain 0.8 --loop # すべてのアセットを検証し、ランタイム用にビルド $ am project validate $ am project build --output dist/
空のフォルダーからランタイム用アセットまで
Amplitude はデータ駆動です。SDK は JSON を読み込み、CLI はその JSON の作成、検証、パッケージ化を行います。
プロジェクトを始める
テンプレートからプロジェクトのフォルダー構成を生成します。指定しない限り、プロジェクトは CLI に登録されます。
am project init my_gameアセットを作る
サウンド、コレクション、エフェクト、スイッチ、イベント、サウンドバンク、アッテネーション、RTPC、パイプライン、バスを作成できます。値を省略すると入力を促されます。
am asset sound create explosion --file audio/explosion.wav --bus sfxミスを見つける
すべてのアセット、バスファイル、エンジン設定を SDK のスキーマに照らして検証します。参照も対象で、作業中は種類ごとに絞ることもできます。
am project validate --sounds-onlyエンジンへ届ける
検証したうえで、ランタイム用のアセットをビルドフォルダーに出力します。事前にクリーンすることも、最初のエラーで停止することもできます。
am project build --output dist/ --clean今すぐ使えるコマンド
全コマンドの一覧は am --help で、各コマンドの詳しい説明はコマンドに --help を付けると表示されます
am project init [name] --template --no-register登録済みのテンプレートから新しいプロジェクトを作成します。
am project register [path] 既存のプロジェクトを登録します。
am project unregister <name> --delete-filesプロジェクトの登録を解除します。ファイルを削除することもできます。
am project list --favorite --no-favorite登録済みのプロジェクトをすべて一覧表示します。
am project favorite <name> --set --unsetプロジェクトをお気に入りに追加または解除します。
am project info [name] プロジェクトの詳細を表示します。名前を省略すると現在のディレクトリが対象です。
am project validate --sounds-only --rtpc-only --buses-only …プロジェクト内のすべてのアセット、バスファイル、エンジン設定を検証します。種類を絞ることもできます。
am project build --output --clean --fail-fastプロジェクトのアセットをランタイム用にビルドします。
--json--non-interactive-q, --quiet-v, --verbose手作業では親切、スクリプトでは予測可能
値を省略すると CLI が入力を促します。--non-interactive を付けると、プロンプトを出さずにエラーで終了します。
- どのコマンドでも
--jsonで機械可読な出力が得られます - 検証、アセット、プロジェクト、SDK、ビルドの失敗ごとに異なるエラーコード
- 参照は厳密です。存在しないアセットはエラーになり、使用中のアセットは削除できません
- bash、zsh、fish 用のシェル補完
# 出力を独自のツールで処理 $ am project list --json $ am asset sound list --json $ am project validate --json # プロンプトを待たない $ am --non-interactive asset event delete play_music --yes
今は発展途上、オープンに成長中
CLI はバージョン 0.1 で、変化のペースが速い状態です。次に、ターミナルを離れずにプロジェクトを閲覧・編集できるターミナル UI を予定しています。
プロジェクト管理
利用可能- プロジェクトのライフサイクル: init、register、list、favorite、info
- アセットのライフサイクル: create、list、update、delete(参照チェック付き)
- プロジェクトの検証とビルド
- 独自のものを含むプロジェクトテンプレート
- JSON 出力と非対話モード
ターミナル UI
予定同じコマンドの上に構築される、キーボード操作のインタラクティブなプロジェクト表示です。このスケッチはイメージであり、変更される予定です。
am バイナリを入手
インストールスクリプトを実行するか、リリースをダウンロードするか、ソースからビルドします。
インストールスクリプト
最速の方法コマンド 1 つで CLI をインストールできます。事前にスクリプトを確認するには: install.sh · install.ps1
$ curl -fsSL https://cli.amplitudeaudiosdk.com/install.sh | bash PS> powershell -NoProfile -Command "iex (irm 'https://cli.amplitudeaudiosdk.com/install.ps1')" ビルド済みバイナリ
リリースは GitHub で 5 つのターゲット向けに公開されています。
- Linux · x86_64, aarch64
- macOS · Intel, Apple Silicon
- Windows · x86_64
各アーカイブには am、シェル補完、README、ライセンスが含まれ、SHA-256 チェックサムと、gh attestation verify で検証できるビルド来歴の証明が付属します。
# ビルド時に SDK が必要です git clone https://github.com/AmplitudeAudio/cli.git git clone https://github.com/AmplitudeAudio/sdk.git export AM_SDK_PATH="$(pwd)/sdk" cd cli && cargo build # CLI が SDK を見つけられるか確認 $ am sdk check # タブ補完 $ am completions zsh > ~/.zfunc/_am
