サウンドテストプラグイン – SceneSoundTest.js

タイトル
サウンドテストプラグイン
作者名
ヘルプ
ゲーム中のオーディオを視聴できるサウンドテスト画面を実装します。
タイトル画面、メニュー画面およびプラグインコマンドから専用画面に遷移します。
ゲーム中に一度でも再生したことのあるオーディオを視聴できるようになります。

準備
1.CSV形式の場合
以下の書式で「SoundTest.csv」を用意し、「/data/」以下に配置します。
カンマ区切りのCSV形式で、データ中にカンマは使用できません。
また、文字コードは「UTF-8」で保存してください。
特にExcel等で編集した後は注意してください。

項目名 : 説明
fileName : BGMのファイル名です。拡張子不要。
displayName : BGMリストに表示される曲名です。
description : ヘルプウィンドウに表示される説明です。\nと記述すると改行します。
type : オーディオ種別(bgm or bgs or me or se)

なお、別プラグイン「バッチ処理プラグイン」(BatchProcessManager.js)
を使えば現在のBGMフォルダを解析して上記書式のひな形CSVを自動生成できます。

「バッチ処理プラグイン」配布先
https://raw.githubusercontent.com/triacontane/RPGMakerMV/master/BatchProcessManager.js

こちらにCSVのサンプルをあげています。
https://raw.githubusercontent.com/triacontane/RPGMakerMV/master/SoundTest.csv

2.JSON形式の場合
RPGアツマール等のCSV形式が使用できない環境の場合、
こちらのJSON形式を選択してください。
以下の書式で「SoundTest.json」を用意し、「/data/」以下に配置します。
文字コードは「UTF-8」で保存してください。

[
{"fileName":"BGMファイル名", "displayName":"BGM表示名", "description":"説明", "type":"BGM"},
{"fileName":"BGMファイル名", "displayName":"BGM表示名", "description":"説明", "type":"BGS""}
]

CSV→JSON変換ツールを使用した場合、末尾のカンマ等が正しく記述されていないと
エラーが発生するので注意してください。

プラグインコマンド詳細
イベントコマンド「プラグインコマンド」から実行。
(パラメータの間は半角スペースで区切る)

SOUND_TEST_CALL or
サウンドテスト画面の呼び出し
 サウンドテスト画面を呼び出します。
 例:SOUND_TEST_CALL

SOUND_TEST_LIBERATE_ALL or
サウンドテスト全開放
 サウンドテスト画面で???となっている曲目を全開放します。
 例:SOUND_TEST_LIBERATE_ALL

SOUND_TEST_TITLE_VALID or
タイトル画面のサウンドテスト有効化
 タイトル画面の項目にサウンドテストが追加されます。
 例:SOUND_TEST_TITLE_VALID

SOUND_TEST_MENU_VALID or
メニュー画面のサウンドテスト有効化
 メニュー画面の項目にサウンドテストが追加されます。
 例:SOUND_TEST_MENU_VALID

利用規約:
作者に無断で改変、再配布が可能で、利用形態(商用、18禁利用等)
についても制限はありません。
このプラグインはもうあなたのものです。
パラメータ
param コマンド名称
desc タイトルやメニュー画面に表示されるコマンド名です。
default サウンドテスト

param タイトルに追加
desc タイトル画面にサウンドテストを追加します。(ON/OFF)
OFFにした場合もコマンドで後から有効にできます。
default true
type boolean

param メニューに追加
desc メニュー画面にサウンドテストを追加します。(ON/OFF)
OFFにした場合もコマンドで後から有効にできます。
default true
type boolean

param 音量名称
desc BGMの設定項目「音量」のゲーム内での名称です。
空にすると、設定ウィンドウに音量が表示されなくなります。
default 音量

param ピッチ名称
desc BGMの設定項目「ピッチ」のゲーム内での名称です。
空にすると、設定ウィンドウにピッチが表示されなくなります。
default ピッチ

param 位相名称
desc BGMの設定項目「位相」のゲーム内での名称です。
空にすると、設定ウィンドウに位相が表示されなくなります。
default 位相

param 背景ピクチャ
desc 背景として表示するピクチャ(/img/pictures/)を指定できます。
サイズは画面サイズに合わせて拡縮されます。拡張子、パス不要。
default
require 1
dir img/pictures/
type file

param 読込形式
desc データファイルの読み込み形式です。
CSV形式およびJSON形式をサポートしています。
default
type select
option CSV
option JSON

param 管理番号
desc 同一サーバ内に複数のゲームを配布する場合のみ、ゲームごとに異なる値を設定してください。(RPGアツマールは対象外)
default
param リスト操作タイプ
desc リストウィンドウでの操作タイプです。
default 1
type select
option 1[OK:演奏+音量調整][Shift:演奏停止]
value 1
option 2[OK:演奏][Shift:音量調整])
value 2

param 説明文に曲名表示
desc BGMの説明ウィンドウに曲名を表示します。
default true
type boolean

param ヘルプ行数
desc 説明ウィンドウの行数です。0を指定するとデフォルトの2行になります。
default 0
type number

ライセンス表記
「バッチ処理プラグイン」配布先
作者に無断で改変、再配布が可能で、利用形態(商用、18禁利用等)
(C)2016 Triacontane
This software is released under the MIT License.
http://opensource.org/licenses/mit-license.php

紹介ページ https://github.com/triacontane/RPGMakerMV/blob/master/SceneSoundTest.js