Builder リファレンス
下記は、SDK 2.2 系に同梱されている Builder に関する記述となります。
最新版の SDK（2.3 以降）には、GUI 上でコンテンツのビルドを行うことのできる、新しい Builder が同梱されています。
新しい Builder のためのリファレンスは現在準備中です。
概要
Builder は、制作した NS KAG スクリプトをコンパイルした上で、コンテンツの再生に必要なファイルを1つのフォルダにまとめるためのコマンドラインアプリケーションです。
Builder は Windows のほか、Mono をインストールした Mac 上で動作します。Mac 上での操作については「Mac 上での利用について」をご覧ください。
SDK には、Builder の操作を行いやすくするため、GUI 上から Builder を操作するためのアプリケーションである Builder for Windows も同梱されています。こちらの使用法は本リファレンスでは割愛させていただきます。
なお、Mac 用の GUI アプリケーションは用意されていないため（2013年8月14日現在）、お手数ですが Mac ユーザの方は以下に解説するコマンドラインアプリケーションをご利用ください。
使用法
コマンドの形式
builder.exe (option) [source dir] [export dir]
機能
[source dir]引数に指定した novelsphere.js コンテンツのプロジェクトフォルダをビルドします。
ver.2 から、ビルドの際にインターネットに接続する必要はなくなりました。
出力されるコンテンツフォルダは[export dir]となります。[export dir]にすでに同名のフォルダが存在していた場合、そのフォルダを上書きする形でコンテンツフォルダを出力します。
[export dir]にフォルダが存在しなかった場合、フォルダを新たに作成してそこにコンテンツフォルダを出力します。
オプション一覧
| オプション | 機能 |
| -e (--engine) [engine dir] |
ビルドに使用する novelsphere.js のバージョンを指定します。
このオプションを指定しなかった場合、自動的に最新のエンジンが使用されます。 |
| -l (--legacy) | KAG3 互換文法モードでビルドします。 |
| -v | 動作中の状況を逐一出力します。 |
| -y | ビルド中、対話的に質問される事項を全て承認した（y を入力した）とみなし、エラーのない限りビルドを最後まで続行します。 |
| --version | Builder のバージョン情報を返して終了します。 |
使用例
以下の使用例は Windows の「コマンド プロンプト」からの利用を想定したものです。
他の環境で利用する場合には、パスの区切り文字などを考慮して読みかえてください。
builder.exe C:¥Users¥hoge¥Desktop¥test C:¥Users¥hoge¥Desktop¥test-built
最も簡単な使用例です。
「C:¥Users¥hoge¥Desktop」にあるプロジェクトフォルダ「test」をビルドします。「C:¥Users¥hoge¥Desktop」には「test-built」フォルダが作成され、それがコンテンツフォルダとなります。もし、すでに「C:¥Users¥hoge¥Desktop」に「test-built」フォルダが存在している場合、このフォルダを上書きする形でコンテンツフォルダが出力されます。
builder.exe -e 1.00
C:¥Users¥hoge¥Desktop¥test C:¥Users¥hoge¥Desktop¥test-built
ビルドするフォルダ、ビルド結果の出力先フォルダは先の例と同様ですが、この場合はバージョン 1.00 のエンジンを使用してビルドされます。
ビルドに使用する novelsphere.js の設置
ビルドの際には「engines」フォルダ内に存在している novelsphere.js が使われます。
「engines」フォルダの中には、バージョン番号を名前に冠したフォルダ別に、novelsphere.js が格納されています。
novelsphere.js のアップデートなどが配布された場合には、「engines」フォルダ内に配置することで、そのバージョンの novelsphere.js をコンパイルに使用することができるようになります。
ビルドの際には、自動的に最新のバージョンの novelsphere.js が使われます。また、-e (--engine) オプションで明示的に指定することで、そのバージョンのエンジンを使うよう指定することもできます。
ver.2 で廃止された機能
デバッグモードによるビルド
ver.1 では、-d オプションを指定することでデバッグモードでのビルドが行えましたが、ver.2 ではこの機能は廃止となりました。今後は、novelsphere.js コンテンツのデバッグを行う際には Builder からデバッグモードを指定するのではなく、デバッグプラグインを使用してください。
Ajax モードによるビルド
ver.1 では、-x オプションを指定することで、Ajax モードでビルドすることができましたが、実質的に不要な機能であったため、この機能は ver.2 にて廃止されました。
Mac 上での利用について
Builder を Mac 上で利用するには、Mono Runtime をインストールする必要があります。詳しくは「準備する」を参照してください。
ビルドを行うには、Finder を起動した状態で ⌘(Command キー) + ⇧(Shift キー) + U キーを押して「ユーティリティ」の内容を表示し、その中にある「ターミナル」を起動します。 ターミナルを起動したら、「cd 」（cdの後には半角スペースを1つ入れてください）と入力します。さらに、Finder から builder.exe の入っているフォルダ（SDK 内の「builder」フォルダがそれにあたります）を、ターミナルへとドラッグアンドドロップします。すると、「cd /Users/name/Desktop/o2sdk-210/builder 」というような文字列が自動で入力されますので、return キーを押してください。
この状態で、「mono 」と入力し、さらにその後に本リファレンスに従ってオプションなどを入力した上で、return キーを押してください。
フォルダのパスを入力しなければならない箇所に関しては、先ほど「cd /Users/name/Desktop/o2sdk-210/builder 」を入力した際と同じように、入力したいフォルダをターミナルへとドラッグアンドドロップすれば自動的に入力してくれるので便利です。
Hostname:~ name$
cd /Users/name/Desktop/o2sdk-210/builder
Hostname:builder name$
mono builder.exe ~/Desktop/test ~/Desktop/test-built
上記は、最も基本的なビルドを行った例です。Mac の場合、パスの区切り文字が "¥" ではなく "/" なので注意してください。
一度ビルドを行った後は、「cd …」コマンドを入力する必要はありませんので、「mono builder.exe …」コマンドを再び入力して return キーを押せば、再度ビルドが行われます。
ターミナルでは、↑ キーを押すことで、それまでに入力したコマンドを呼び出せますので便利です。