ティラノゲームフェス2017入賞作品決定!

  • iPhone・Androidアプリ化対応。HTML5で動くノベルゲーム製作キット

プラグインとは

この記事の内容はVer4.40以上のティラノスクリプトで有効です。

ティラノスクリプトはプラグインという機能を使用して、従来のティラノスクリプトに機能を追加することができます。

よく利用する機能をプラグインにしておけば、複数のゲームで使いまわすことも簡単です。
また、他のゲーム作者さんにつかってもらえるように、プラグインを公開することもできます。


ティラノスクリプト公認プラグイン一覧

便利なプラグインができたら、ぜひ共有頂けると嬉しいです!


プラグインの作り方と公開方法

ティラノスクリプトVer4.40より、「サードパーティープラグイン」という機能が追加されました。 これは、他の人が作ったプラグインを自分のゲームに簡単に取り込む事ができる仕組みです。

この仕組みを使うことで、「ゲーム」と「プラグイン」を綺麗に分けることができるので、互いに干渉が起こりにくくなります。

まず、プラグインは data/others/plugin/ フォルダに配置します。

例えば今回、「my_message_style」という名前のメッセージボックスを整えるプラグインを用意するとしましょう。

この場合、data/others/plugin/my_message_styleというフォルダを作ります。

プラグインで使用する素材ファイルなどは、すべてこのフォルダの中に格納します。
プラグインを利用する人がプラグインフォルダを配置するだけで使えるようにしておきましょう。

プラグインの使用方法

配布されたプラグインは、data/others/plugin/フォルダに配置されたあと、

[plugin]タグによって、呼び出されます。

(例)
[plugin name="my_message_style"]

のような形です。そうすると最初にmy_message_styleフォルダの init.ksというシナリオファイルが呼ばれます。

あとは、ここで必要な処理を普通にティラノスクリプトを書くように記述すればよいのです。



パスの指定について

このinit.ksファイルでは、原則としてdata/others/plugin/my_message_styleフォルダ以下の画像やシナリオファイルを 使用しなければなりません。その場合、パスの指定方法にすこし、工夫が必要です。

■[bg]タグの場合の例
[bg storage="../others/plugin/my_message_style/image/bg_image.png" ]

通常は、例えば [bg]タグの場合、storageで指定するファイルの場所は、bgimageフォルダの中にありました。
しかし、プラグインでは、othres/pluginフォルダの中を参照しなければなりませんので、「../」という一つ上の階層を表す指定をしてから、パスを記述します。

その他[jump ]や [call ]などでも同じ考え方です

あと、init.ksファイルは必ず最後に[return ]が必要です。



引数を渡す

[plugin]タグは好きな引数を渡すことができます。
例えば、
[plugin name="my_message_style" frame_opacity="125" font_color="0xFFFFFF" ]

このように、引数をわたします。すると、init.ks側では

mp.frame_opacity
mp.font_color
のような形で引数を利用できます。

これを &mp.font_color のように使うことで、カスタマイズ可能なプラグインが作れます。

ただ、マクロで使用可能だった%font_color のような形の使用はできませんので注意。



引数が省略された時のデフォルト値の作り方は、以下のようにできます。

[iscript]

//初期化
mp.font_color = mp.font_color || "white";
mp.frame_opacity = mp.frame_opacity || "200";

[endscript]





参考になるプラグイン

こ・ぱんだ様よりご提供いただいている、テーマプラグインが非常に参考になります。
説明とあわせて中身をご確認ください。

プラグイン一覧へ

テーマ一括変換プラグインをご確認ください。

仕上げ

あとは、readme.txtファイルを同梱して、以下の情報を記述しておきましょう

・プラグインのタイトル
・作成時のティラノスクリプトのバージョン
・概略説明(100文字程度)
・詳しい使い方。サンプルコード含む
・開発者名(任意)
・開発者サイト(任意)

その他、ご自身で含めたい宣伝や文言を自由に入れていただいて結構です。

最後に先に用意しておいたdataフォルダを含めて圧縮して配布して下さい。
また、プラグインを開発したら、ぜひとも、このサイトに掲載させて下さい。

ティラノスクリプト公認プラグイン一覧

開発者サイト様へのリンクや広告などをさせて頂く形で恩返しできればと考えております。

作成したプラグインを掲載しても良いよ~。という方は、開発者へ連絡する
もしくは

【プラグインの作成依頼・相談所】

掲示板に書き込みいただければと思います。

何卒、よろしくお願い致します。