Builder リファレンス

概要

Builder は、制作した O₂ KAG スクリプトをコンパイルした上で、コンテンツの再生に必要なファイルを1つのフォルダにまとめるためのコマンドラインアプリケーションです。

Builder は Windows のほか、Mono をインストールした Mac 上で動作します。Mac 上での操作については「Mac 上での利用について」をご覧ください。

使用法

コマンドの形式

builder.exe (option) [source dir] [export dir]

機能

[source dir]引数に指定した O₂ Engine コンテンツのプロジェクトフォルダをビルドします。

コンパイルサーバと通信しながらビルドを行うため、ビルドの際にはインターネットに接続されている必要があります。

出力されるコンテンツフォルダは[export dir]となります。[export dir]にすでに同名のフォルダが存在していた場合、そのフォルダを上書きする形でコンテンツフォルダを出力します。

[export dir]にフォルダが存在しなかった場合、フォルダを新たに作成してそこにコンテンツフォルダを出力します。

オプション一覧

オプション	機能
-a	コンパイルサーバと通信するにあたり、認証を行います。実際には、-i オプションおよび -p オプションと組み合わせて使用します。このオプションを指定しなかった場合、初期設定ファイルの compileServerAuthentication の値を解釈し、True ならば認証を行い、False ならば認証を行わずにコンパイルを試みます。
-c (--config)	Builder の初期設定ファイルのパスを指定します。 このオプションを指定しなかった場合、初期設定ファイルは "settings.ini" であるとみなされます。
-d (--debug-build)	デバッグモードでビルドします。 この場合、コンテンツはデバッグ用にビルドされます。
-e (--engine) [engine dir]	ビルドに使用する O₂ Engine のバージョンを指定します。 このオプションを指定しなかった場合、自動的に最新のエンジンが使用されます。
--encoding [charset]	ビルドするプロジェクトのシナリオファイルがどの文字コードで記述されているかを指定します。指定できる値は、"utf-8"、"shift_jis"、"euc-jp"、"iso-2022-jp" のいずれかです。 このオプションを指定しなかった場合、初期設定ファイルの ksEncoding の値をシナリオファイルの文字コードとみなしてビルドを行います。
-i [id]	コンパイルサーバにおける Basic 認証の ID を指定します。 このオプションを指定しなかった場合、初期設定ファイルの compileServerId の値を ID とみなして認証を試みます。
-p [password]	コンパイルサーバにおける Basic 認証のパスワードを指定します。 このオプションを指定しなかった場合、初期設定ファイルの compileServerPassword に暗号化されて格納されている値をパスワードとみなして認証を試みます。
-s (--site) [address]	コンパイルサーバの URL を指定します。 このオプションを指定しなかった場合、初期設定ファイルの compileServerUrl の値をコンパイルサーバの URL とみなしてビルドを行います。
-t	コンパイルサーバとの通信のタイムアウト時間を秒単位で指定します。 このオプションを指定しなかった場合、タイムアウト時間は120秒です。
-v	動作中の状況を逐一出力します。
-x	Ajax モードでビルドします。
-y	ビルド中、対話的に質問される事項を全て承認した（y を入力した）とみなし、エラーのない限りビルドを最後まで続行します。
--version	Builder のバージョン情報を返して終了します。

使用例

以下の使用例は Windows の「コマンド プロンプト」からの利用を想定したものです。

他の環境で利用する場合には、パスの区切り文字などを考慮して読みかえてください。

最も簡単な使用例です。

「C:¥Users¥hoge¥Desktop」にあるプロジェクトフォルダ「test」をビルドします。「C:¥Users¥hoge¥Desktop」には「test-built」フォルダが作成され、それがコンテンツフォルダとなります。もし、すでに「C:¥Users¥hoge¥Desktop」に「test-built」フォルダが存在している場合、このフォルダを上書きする形でコンテンツフォルダが出力されます。

ビルドするフォルダ、ビルド結果の出力先フォルダは先の例と同様ですが、この場合はデバッグモードでビルドされます。

ビルドするフォルダ、ビルド結果の出力先フォルダは先の例と同様ですが、この場合はバージョン 1.00 のエンジンを使用してビルドされます。

ビルドするフォルダ、ビルド結果の出力先フォルダは先の例と同様ですが、コンパイルサーバに「http://hoge.hg/comp」を使い、かつデバッグモードでビルドします。コンパイルの際には ID を「hoge」、パスワードを「pswdpswd」として認証を試みます。

settings.ini の設定

Builder の動作は、Builder のあるフォルダ内の「settings.ini」を編集することで設定できます。

項目名と値の間は半角イコール "=" で区切り、1つの行には1つの項目だけを記述するようにしてください。

値をダブルクォーテーション（"）などでくくってはいけません。

また、余分なスペースなどを入力してはいけません。スペースは全て文字通り解釈されますので、半角スペースを含む文字列を値とすることは可能です。

項目名	値の型	値の意味
compileServerUrl	文字列	コンパイルサーバの URL を指定します。Builder を起動する際に -s (--site) オプションで URL を指定した場合は、そちらが優先されます。
compileServerAuthentication	True / False	コンパイルサーバとの通信において認証を行うか否かを指定します。True を指定すると、認証が行われます。False を指定すると、認証は行われません。
compileServerId	文字列	コンパイルサーバの認証 ID を指定します。Builder を起動する際に -i オプションで認証 ID を指定した場合は、そちらが優先されます。
compileServerPassword	文字列	この項目にはコンパイルサーバの認証パスワードが指定されていますが、暗号化されています。そのため、この項目を直接編集することはできません。 -a -i -p の各オプションを指定して Builder を起動すれば、Builder が自動的に、-p オプションで指定された値を暗号化してこの項目に記録します。
ksEncoding	文字列	ビルドするプロジェクトのシナリオファイルがどの文字コードで記述されているかを指定します。指定できる値は、"utf-8"、"shift_jis"、"euc-jp"、"iso-2022-jp" のいずれかです。Builder を起動する際に --encoding オプションで文字コードを指定した場合は、そちらが優先されます。

ビルドに使用する O₂ Engine の設置

ビルドの際には「engines」フォルダ内に存在している O₂ Engine が使われます。

「engines」フォルダの中には、バージョン番号を名前に冠したフォルダ別に、O₂ Engine が格納されています。

O₂ Engine のアップデートなどが配布された場合には、「engines」フォルダ内に配置することで、そのバージョンの O₂ Engine をコンパイルに使用することができるようになります。

ビルドの際には、自動的に最新のバージョンの O₂ Engine が使われます。また、-e (--engine) オプションで明示的に指定することで、そのバージョンのエンジンを使うよう指定することもできます。

Builder の機能

デバッグモードによるビルド

-d (--debug-build) オプションを指定することで、デバッグモードでビルドすることができます。

デバッグモードでビルドされた O₂ Engine コンテンツは、再生中にデバッグ用の情報をブラウザの JavaScript コンソールやデバッグ用ウィンドウに出力します。

Ajax モードによるビルド

-x オプションを指定することで、Ajax モードでビルドすることができます。現在、特にこのモードを使う必要はありません。

Ajax モードでビルドされた O₂ Engine コンテンツは、スクリプトを Ajax（JavaScript における XMLHttpRequest メソッド）で読み込みます。

Ajax モードではない形でビルドされた O₂ Engine コンテンツは、JSONP の機構を用いてスクリプトを読み込みます。

Mac 上での利用について

Builder を Mac 上で利用するには、Mono Runtime をインストールする必要があります。詳しくは「準備する」を参照してください。

ビルドを行うには、Finder を起動した状態で ⌘(Command キー) + ⇧(Shift キー) + U キーを押して「ユーティリティ」の内容を表示し、その中にある「ターミナル」を起動します。 ターミナルを起動したら、「cd 」（cdの後には半角スペースを1つ入れてください）と入力します。さらに、Finder から builder.exe の入っているフォルダ（SDK 内の「builder」フォルダがそれにあたります）を、ターミナルへとドラッグアンドドロップします。すると、「cd /Users/name/Desktop/o2sdk-170/builder 」というような文字列が自動で入力されますので、return キーを押してください。

この状態で、「mono 」と入力し、さらにその後に本リファレンスに従ってオプションなどを入力した上で、return キーを押してください。

フォルダのパスを入力しなければならない箇所に関しては、先ほど「cd /Users/name/Desktop/o2sdk-170/builder 」を入力した際と同じように、入力したいフォルダをターミナルへとドラッグアンドドロップすれば自動的に入力してくれるので便利です。

上記は、最も基本的なビルドを行った例です。Mac の場合、パスの区切り文字が "¥" ではなく "/" なので注意してください。

一度ビルドを行った後は、「cd …」コマンドを入力する必要はありませんので、「mono builder.exe …」コマンドを再び入力して return キーを押せば、再度ビルドが行われます。

ターミナルでは、↑ キーを押すことで、それまでに入力したコマンドを呼び出せますので便利です。

Copyright©2012-2013 Gengosha Inc. all rights reserved.