バーチャルキャストの config.json にメモを書きたい

概要

というタイトルの要望をもらったので、なにかできないか考えてみることにしました。
まず json というフォーマットはコメントを書くことができません。
調べてみると、既に作成ツールなど ¹ がいくつかあるのですが、今回はちょっとメモしたいだけなので
Hjson というものを利用して、自分で環境を作ってみることにします。
Hjson は json にコメントが書けるフォーマットです。

環境構築

色々とインストールしますが初回だけなので。

1. Node.js をインストールします
   • ここではリンク先の推奨版をインストールしました
2. コマンドプロンプトを開きます
   • Windows キー + R で「ファイル名を指定して実行」が出るので、そこに「cmd」と入れるのが楽です
3. hjson-js を npm 経由でインストールします
   • コマンドプロンプトに npm i -g hjson と入力し実行します

ちゃんとインストールされたかは以下のコマンドで確認できます。

> node --version
v10.15.0
> npm --version
6.4.1
> hjson --version
Hjson.js 3.1.2

さらに「VirtualCast.exe」があるフォルダに「config.hjson」（※拡張子は hjson ）を作成します。
内容は「config.json」そのままで大丈夫です。パラメータはこのあたり ^{2 3} を参考に。

最後に「VirtualCastRun.bat」を用意します。これは以下の内容をコピーしてファイルを作成してください。
ファイルの場所は「config.hjson」と同じ場所です。

VirtualCastRun.bat

@echo off

rem hjson から json に変換後 VirtualCast を起動する
hjson -j ./config.hjson > ./config.json && call VirtualCast.exe

使い方

おおまかな使い方は以下のとおりです。

1. 「config.hjson」を編集して保存します
2. 「VirtualCastRun.bat」を実行します

以上。

これで元々「config.json」を編集してた時と同じ感じで利用できます。やったー！
…だけだと説明不足ですね。
「VirtualCastRun.bat」で何をしているのかといいますと hjson から json への変換をしてます。

config.hjson

{
  "niconico": {
    "character_models": [
      // デフォルト
      32797, // ニコニ立体ちゃん, https://3d.nicovideo.jp/works/td32797
      // 追加したもの
      34492, // ピコラボ, https://3d.nicovideo.jp/works/td34492
    ],
    "background_models": [
      //43907, // 【サンプル】オータムガーデン, https://3d.nicovideo.jp/works/td43907
      43367, // 【サンプル】あいえるらいぶ　スタジオ, https://3d.nicovideo.jp/works/td43367
    ],
  },
}

↓↓↓　変換　↓↓↓

config.json

{
  "niconico": {
    "character_models": [
      32797,
      34492
    ],
    "background_models": [
      43367
    ],
  },
}

という具合に、赤線が引かれてエラーになっているコメント部分がすべて除去されています。
また、コンマ（,）なども適切に取り除いてくれています。便利。

まとめ

Hjson も基本的にコメントを書ける json なので、今後バーチャルキャスト側で
パラメータが増えたりしても、そのまま追記すれば普通に使えます。
モデルを色々試したいけど、どれがどれか分からない…やいっぱい追加して初回起動に時間がかかる…
などのお悩みがあれば、コメントアウトを付けると少しだけ幸せになります。

hjson-cs もあるのでバーチャルキャスト側で対応されるととても素敵。

参考

• https://co.bsnws.net/article/131

1. https://virtualcast.jp/link/ 「config.jsonを作るのに便利」 ↩

2. https://qiita.com/miyumiyu/items/d029e3cdd498aa263cfe ↩

3. https://www.infiniteloop.co.jp/blog/2018/11/virtualcast-142c-release/ ↩