Skip to content

Latest commit

 

History

History
148 lines (107 loc) · 8.08 KB

README.md

File metadata and controls

148 lines (107 loc) · 8.08 KB
Raw

Unity EasySoundPlayer

Unityで簡単に使えるBGM・SE再生用アセットです。

初心者の方でも手順通り導入すれば簡単に使えることを目標に作りました。
「できること」以上のことを求める場合は逆に使いづらいと思うので自作するか別のアセットを探してください。

できること

簡単に言うと

  • BGM/SEの再生ができます。
  • 音量変更のUIがノーコーディングで作れます。
    • スクリーンショット 2021-03-17 2 04 51

もう少し詳しく

  • BGMの再生／停止／再開ができます。
  • BGMのループ再生ができます。
  • SEの再生（複数同時再生）ができます。
  • BGM/SEの音量変更ができます。
  • 音量変更UIの作成ができます。（コード不要）

できないこと

  • 複数のBGMファイルのループ再生やランダム再生
  • BGMのクロスフェード再生
  • オーディオミキサーの利用
  • など

動作環境

  • Unity 2019.4(LTS)以上
  • システムに Gitクライアント がインストールされている必要があります

導入方法

UniRxの導入

一部UniRxを使用しているため先に導入します。
すでに別の方法（unitypackage等）を利用してUniRxを導入している場合、一度消す必要があります。わからない場合は諦めてください。

  1. Window -> Package Manager
    • スクリーンショット 2021-03-17 1 04 29
  2. "+" -> Add package from git URL...
    • スクリーンショット 2021-03-17 1 07 16
  3. 以下のURLを入力し、Addを押す
    • https://github.com/neuecc/UniRx.git?path=Assets/Plugins/UniRx/Scripts
  4. UniRxが導入済みとなれば成功
    • スクリーンショット 2021-03-17 1 10 08

EasySoundPlayer(本アセット)の導入

UniRxと同様の手順で、以下のURLを使って導入してください。

https://github.com/naichilab/unity-easy-sound-player.git?path=Assets/naichilab/EasySoundPlayer

こちらもリストに表示されれば成功です。

スクリーンショット 2021-03-17 1 13 20

使い方

準備

  1. プロジェクトビューのこのアイコンが押されていないことを確認します。
    • スクリーンショット 2021-04-25 0 04 20
    • もし押されてる場合は次の手順で必要な Packages/EasySoundPlayer/ フォルダが見えません。
  2. プロジェクトビューの Packages/EasySoundPlayer/Prefabs/ にある２つのプレハブをシーンに配置します。（ヒエラルキービューにドラッグ＆ドロップ）
    • スクリーンショット 2021-03-17 1 17 06
  3. プロジェクトビューの Assets/ 以下に、使用するBGMやSEのオーディオファイルを配置します。
    • フォルダ名はなんでも良いです。
    • スクリーンショット 2021-03-17 1 19 33
  4. ヒエラルキービューにて BgmPlayer を選択し、インスペクタからオーディオファイルをセットします。
    • スクリーンショット 2021-03-17 1 23 26
  5. 同様の手順で SePlayer の方にもオーディオファイルをセットします。
    • スクリーンショット 2021-03-17 1 26 46

BGMの再生方法

  • BgmPlayerのインスペクタで PlayOnAwake をオンにしておくとシーン読み込み完了時に自動的に再生開始されます。
    • 複数のオーディオファイルをセットした場合は１つ目が利用されます。
    • スクリーンショット 2021-03-17 1 35 05

スクリプトから手動で鳴らしたい場合や、曲を変更したい場合は以下のコードを書いてください。

// BGM再生方法A：ファイル番号を指定して再生する
BgmPlayer.Instance.Play(0);
// BGM再生方法B：ファイル名を指定して再生する
BgmPlayer.Instance.Play("bgm_maoudamashii_fantasy03");
// BGMを一時停止
BgmPlayer.Instance.Pause();
// BGMを停止
BgmPlayer.Instance.Stop();

SEの再生方法

SEを鳴らしたい時に、以下のコードを書いてください。

// SE再生方法A：ファイル番号を指定して再生する
SePlayer.Instance.Play(0);
// SE再生方法B：ファイル名を指定して再生する
SePlayer.Instance.Play("se_maoudamashii_system28");

uGUIのボタンをクリックした時にSEを鳴らすだけであれば、
インスペクタのOnClick()を使うことでも同様のことができます。

スクリーンショット 2021-03-17 21 47 47

音量調整UIの作成

  1. ヒエラルキービューで、Slider を２つ作成します。（BGM/SEそれぞれ用）
    • スクリーンショット 2021-03-17 1 37 21
  2. ２つのSliderに分かりやすい名前をつけます。
    • スクリーンショット 2021-03-17 1 38 45
    • ここでは BgmVolumeSlider と SeVolumeSlider としました。
  3. 位置や見た目は自由に編集してください。
    • Unity標準のuGUIという仕組みなので、わからない場合はググってください。
    • 例なので適当に位置だけ調整しました。
    • スクリーンショット 2021-03-17 1 41 15
  4. BgmPlayerのインスペクタを開き、作成したSliderをセットします。
    • スクリーンショット 2021-03-17 1 42 00
  5. SePlayerの方にも同様にセットします。
    • スクリーンショット 2021-03-17 1 42 56

以上で完了です。

実行すればスライダーを操作することで音量が変更できます。
SEの方は、変更するたびに１つ目のSEが鳴ります。

もしスクリプトから音量を変更したい場合は以下のように書いてください。

// BGM音量を変更（0〜1）
BgmPlayer.Instance.Volume = 0.5f;
// SE音量を変更（0〜1）
SePlayer.Instance.Volume = 0.5f;

ライセンス

  • MITライセンス
  • This library is under the MIT License.