----------------------------------------------------------------------- ブラウザ連携プラグイン for Chararina 取扱説明書 Copyright(C) 2001-2005 Praesens, Inc. All rights reserved. http://www.praesens.co.jp/pws/ ----------------------------------------------------------------------- 1.はじめに ブラウザ連携プラグインをダウンロードいただきありがとうございます. ブラウザ連携プラグイン(以下本プラグイン)はホームページ上に特定のタ グ(EMBEDタグ)を埋め込むことにより,ホームページを閲覧した際に特定の キャラクターに対してメッセージをしゃべらせることができるようになるも のです. 第2章にてキャラクターとの連携に用いるプラグイン関数,HTMLの実装方法 を,3, 4, 5章にて各種ファイルフォーマット,関数リファレンスを記述い たしますので,本プラグインに対応したキャラクターを作成する方は参考に してください. 2.チュートリアル ブラウザからのメッセージを受け取るための最低限の手順を以下の2.1〜 2.2章で順をおって説明します.各データファイル,関数に関しての詳細は 3,4,5章に記述していますのでそちらを参考にしてください. 2.1 綾織側での準備 ブラウザからのメッセージを受け取るには,綾織側でブラウザからのメッ セージを受け取るためのhttpserverプラグインを起動する必要があります. 以下にその方法を記述いたします. 1.プラグイン関数を使うために以下のプロトタイプ宣言行う import int LF_HTTPSERVER_StartServer(); 2.綾織プログラム中のStartUpアクション内にで上記プラグイン関数を呼 ぶ action StartUp@( false ) { //ブラウザからのメッセージ受け取り用サーバの起動 LF_HTTPSERVER_StartServer(); . .(その他のStartUp処理) . } 3.ブラウザからのメッセージを受け取るためのコールバック関数の宣言 及びメッセージ表示処理 export void LF_HTTPSERVER_cMessageRequest( string options, string data ) { //data部にメッセージが入っているので,Talkで表示 Talk( data ); } 2.2 HTMLファイル側の準備 メッセージをキャラクターに送るために,ホームページ側ではキャラクター をしゃべらせたいHTMLにEMBEDタグを埋め込む,メッセージを記述する.pmsg ファイルを用意するの2点の準備が必要です. 1.以下のようなtest.pmsgファイルを作成してください. ここではtest.pmsgファイルとしていますが,拡張子が.pmsgファイル であればファイル名はお好きな名前を付けていいただいて結構です. -------- test.pmsg (ここから) ----------------- [common] '対象とするキャラクターのベンダコードを記述してください 'ここでは仮に絢夏のベンダーコードを記述しておきます. PERSONA=LF-HPX-02 'openingセクション [opening] 'contents=以下に実際にキャラクターに送りたいメッセージを記述してく 'ださい. contents= 私のホームページにお越しいただきありがとうございます. -------- test.pmsg (ここまで) ----------------- 注意: 記述は全てShift-JISをご使用ください,EUC,JISコードは使 えませんのでご注意ください. 2.キャラクターにメッセージを送りたいHTMLファイルに以下のようなEMBEDタ グを埋め込んでください. 上記記述中ののxxxxの部分にメッ セージを記述した.pmsg拡張子を持つファイルを指定してください. タグ中のSRC=以下にも同様のファイル名を記述してください. ここではtest.pmsgファイルとします. 次に,のxxxxの部分に指定し た.pmsgファイル中における実際のメッセージを記述したセクション を指定します.手順1で用意したtest.pmsgファイルの[opening]セク ションの内容を表示させたいので,"opening"と記述してください. タグ中のSECTION=以下にも同様に"opening"と記述してくだ さい. その他の指定についてはそのまま記述してください. 3.プラグイン関数リファレンス 本プラグインは常駐プラグインです.キャラクターからLoadPlugin関数を 用いる必要はありません. ブラウザ連携プラグインは綾織から呼び出せる下記のプラグイン関数を 実装しています.キャラクターからこれらのプラグイン関数を呼び出すこ とで,キャラクターからブラウザ連携プラグインを操作できます. 3.1 プラグイン関数 import int LF_HTTPSERVER_StartServer() 機能 サーバを起動する. 引数 なし 戻り値 0 成功 それ以外 エラー import int LF_HTTPSERVER_StopServer() 機能 サーバを停止する. 引数 なし 戻り値 0 成功 それ以外 エラー 3.2 コールバック関数 ホームページに埋め込んであるメッセージを受け取るための綾織コール バック関数です.このコールバック関数によりホームページ上に埋め込 まれたメッセージを受け取ることができます. export void LF_HTTPSERVER_cMessageRequest( string options, string data ) 機能 ホームページに埋め込まれたメッセージを受け取る. 引数 options: 各メッセージのセクションに書かれた値が\n(改行コー ド)区切りで そのまま渡される. また,Chararia Ver3.20β以降に添付しているバージョ ンより追加で"location=[URL]"の形でhtml中で指定し た.pmsgファイルのURLが渡されるようになりました. data: 表示するべきメッセージが渡される. 戻り値 なし 4.pmsgファイルフォーマット .pmsgファイルのフォーマットの基本的な形式としては,Windowsのini ファイルのような形式をとり,複数のセクションと各セクション毎の (キー名)=(値)という記述で成り立っています. コメントは行頭に'(シングルクォート)を記述した場合のみその行をコメ ント行として扱います.行の途中で'を記述してもコメントとしては扱われ ません. また,特殊セクション名としてこのpmsgファイルにおける共通設定を行う [common]セクション,特殊キー名として以降をフリースタイルで記述でき るcontentsキーがあります. 日本語文字コードについては,Shift-JISコードを使用して記述してくだ さい.他の文字コードを記述された場合の動作は保証されません. 4.1 [common]セクション .pmsgファイル中における共通設定を記述することができます.本バー ジョンでは以下のキーのみサポートしています. PERSONA=(キャラクターの型番(LF-HPX-01等)) また,キャラクターの型番指定には以下のような簡易ワイルドカード指定 が行えます. PERSONA=LF* 上記のような記述をした場合はベンダ名LFのキャラクター全てに対してメッ セージが送付されます.但しこの記述のおいて*(アスタリスク)は一個の み指定でき,*以降の文字を記述しても無視されます. 4.2 ユーザセクション .pmsgファイル中にはページ作成者が自由にセクションを切り,メッセー ジを記述し,そのセクションをHTMLファイル側で指定することでメッセー ジを送付するようになっています. ユーザセクション内はオプション部とcontents部(メッセージ部)に分か れており,オプション部には(キー名)=(値)の形式で自由に設定等を記述 することができます. 綾織側に渡される際オプション部に関しては, LF_HTTPSERVER_cMessageRequestのoptions引数により, (キー名)=(値)\n(キー名)=(値)\n.... ※\nは改行コードをあらわします. のような形式で渡され,メッセージ部にはcontents=以下に書かれた文字が そのままの形で渡されます. ------- ユーザセクションの記述例 --------------- 'オープニング処理 [opening] version=1 situation=morning contents= おはようございます. ------------------------------------------------- 上記の例では,コールバック関数のoptions引数には, version=1\nsituation=morning (※\nは改行コードをあらわします) が入り,contents引数には おはようございます. が入っています. 5.HTML側の指定方法詳細 HTMLファイル中には以下のようにOBJECTタグとEMBEDタグによってパラ メータを指定することでキャラクターにメッセージを送ることができま す. これは,InternetExplorerとNetscape Navigator両方で正常にメッセー ジを送るために必要な措置となります. ですので,タグのパラメータ指定である, でよって指定したものと同じものを,以下のようにEMBEDタグの属性の 部分で指定する必要があります. 例. タグのパラメータであるtest.pmsgがEMBEDタグ内に同様に 指定してあるのが分かると思います.その他ないにある CLASSID,CODEBASEやないにあるTYPE等はそのまま記述して ください. パラメータとしては,最低限SRC, SECTIONについては記述してください. SRCには対象となるメッセージが記述されている.pmsgファイルを指定し, SECTIONには.pmsgファイル内の該当メッセージのセクションを指定します. パラメータにはSRC, SECTION以外に以下のものが指定できます. パラメータ名: PERSONA 指定例 PARAM指定: EMBED内指定: PERSONA="(キャラクターベンダ名)" 機能: 対象とするキャラクターの型番を指定します. .pmsgファイル中に指定できるのと同じような*による簡易ワイルド カード指定も行えます. また,EMBEDタグ内と.pmsgファイル両方に対象キャラクターの指定が あった場合は,EMBEDタグ内に指定したものが優先されます. 使用例: 対象キャラクターをLF-HPX-02(絢夏)と指定するサンプル パラメータ名: SIMPLEMSG 指定例 PARAM指定: EMBED内指定: SIMPLEMSG="(メッセージ)" 機能: 簡易的なメッセージのみ送付したい場合のみ指定します.この属性 を指定した場合はSECTION属性は無視され,.pmsgファイル内の設定は 全て無視されます.ただし.pmsgファイルは空でも良いですので用意 する必要があります. 使用例: 絢夏に対して「こんにちわ」というメッセージを送るサンプル 6.著作権,免責事項など 知的財産権 ・本ソフトウェア(画像・ドキュメントを含む)に関する一切の著作権その他 の無体財産権は,プラエセンス株式会社が所有します. 禁止事項 ・お客様は,本ソフトウェアについて,変更,改変,複製を行うことはでき ません. ・お客様は,本ソフトウェアについて,リバースエンジニアリング,逆コン パイル・逆アセンブル,その他の方法でソースコードを解析することはで きません.また,本ソフトウェアが生成するデータファイルについて,リ バースエンジニアリングすることはできません. 免責事項 ・本ソフトウェアは現状のままで提供されるものであり,当社は,本ソフト ウェアに関して,完全性・正確性・有用性・第三者の権利不侵害性・その 他一切の保証を致しません. ・当社は,本ソフトウェアの瑕疵,不具合等ならびに本ソフトウェアを使用 した結果および使用不可につき,修補義務・保守義務・その他いかなる責 任も負いません. 7. 変更履歴 2005/06/xx for Chararina Ver 3.20β2 ・.pmsgファイルに書かれたcontents部分の改行コードがなくなっていた点を修正 ・\nについての解説をドキュメントに追加 2005/06/02 for Chararina Ver 3.20β ・LF_HTTPSERVER_cMessageRequestの呼び出し方式を変更(Ver3.00の形式に対応) ・LF_HTTPSERVER_cMessageRequestコールバックのoptions引数に渡されるパラ メータが\nで区切られていなかった点を修正 ・LF_HTTPSERVER_cMessageRequestコールバックのoptions引数に指定された .pmsgファイルのURLを渡すようした(location=[url]の形式) 2004/11/15 for Chararina Ver 3.10β3 ・Opera7, Mozilla Firefoxに対応 2001/12/22 ・クライアントが接続後してHTTP要求を出さずに切断した場合、内部資源を消 費してしまうのを修正 2001/12/12 for ver 1.51β4 ・2重起動時のエラーメッセージの修正 2001/11/22 for ver 1.51β3 ・ドキュメント微調整 ・Opera6に仮対応 2001/10/27 for ver 1.51β2 ・IE5.5sp2以降からEMBEDタグによるプラグインの起動のサポートがされなく なったため,新たにActiveXバージョンのAxPerMsg.dllを追加. ・上記変更に伴うHTML側の表記の説明を刷新 2001/9/16 for 1.50 ・プロトタイプ完成