@akashic/complete-audio

complement audio asset files

Usage no npm install needed!

<script type="module">
  import akashicCompleteAudio from 'https://cdn.skypack.dev/@akashic/complete-audio';
</script>

README

complete-audio

Akashic Engine のゲームに必要な音声ファイルの形式を取り揃えるための変換ツールです。

  • wavファイルをoggファイルとaacファイルに変換
  • mp4ファイルをoggファイルとaacファイルに変換
  • mp3ファイルをoggファイルとaacファイルに変換
  • oggファイルとaacファイルを相互に変換

以上の機能を実装しています。

インストール方法

このソフトウェアを利用するには、 FFmpeg のインストールが必要です。 FFmpeg のインストール方法は 公式サイト を参照してください。

$ npm install -g @akashic/complete-audio

利用方法

akashicコンテンツで使用する音声ファイル名を指定してください。

$ complete-audio sound.wav

生成された音声ファイルの詳細な利用方法については、 Akashic Engine 入門 (v2版) - 音を鳴らす を参照してください。

FFmpegのライブラリについて

oggファイルを生成するときに libvorbis が存在する場合は

libvorbis > ffmpeg default

の順に使用されます。

aacファイルを生成するときに libfaac か libvo_aacenc が存在する場合は

libfaac > libvo_aacenc > ffmpeg default

の順に使用されます。

FFmpegのバイナリを直接指定して使う

complete-audio sound.wav --ffmpeg /path/to/your/ffmpeg

または、環境変数 FFMPEG_PATH にバイナリへのフルパスが設定されている場合、 complete-audio は環境変数 FFMPEG_PATH をFFmpegへのフルパスとして使用します。

ファイルの上書きについて

出力先のファイルが既に存在する場合、デフォルトでは上書きするかどうかの確認が行われます。

常に上書きしたい場合は

complete-audio sound.wav -f

のように指定してください。

常に上書きを行わないようにしたい場合は

complete-audio sound.wav -i

のように指定してください。

ライセンス

本リポジトリは MIT License の元で公開されています。 詳しくは LICENSE をご覧ください。

ただし、画像ファイルおよび音声ファイルは CC BY 2.1 JP の元で公開されています。