SSP/仕様書/INSTALL-1.5

INSTALL/1.5

Last Modified:20061008 シェルwithバルーンの例を追加 SSP 1.04.00 Beta7～

この文書は未だ開発者版です。予告なくごっそり変更される可能性があります。

設計思想

• ゴーストと共にヘッドライン-プラグイン等を配布する機会が増えてきたのでその仕様追加。

影響評価

• なし。

NARファイル (Nanika ARchive)

ルートにinstall.txtというインストール指示ファイルを含むZIPファイルです。
拡張子は.nar、または単に.zipが使われます。
※必ずinstall.txtはルートに格納してください。それ以外の場所では認識されません。

install.txt（インストール指示ファイル）について

以下のようなフォーマットのファイルです。

//このファイルのエンコード
charset,[Shift_JIS | UTF-8 | EUC-JP ...]
type,[ghost | shell | balloon | headline | plugin | calendar skin | calendar  plugin | directory service setting]
directory,インストール先ディレクトリ名（アルファベット＋数字のみで構成を推奨）
name,パッケージ名
//ここまで必須
accept,インストール先の\0(Sakura)名。一致しないと失敗。
script,デフォルトスクリプト
//インストール先を一度消去するか否か
refresh,[true | false]
//refresh時に削除してはいけないファイル名のリスト
refreshundeletemask,ファイル:ファイル:ファイル

type = ghost / shell の場合

※???にはballoon,headline,plugin,calendar.skin,calendar.pluginのいずれかが入ります。

//インストール先のディレクトリ名
???.directory

//アーカイブ内に格納されているディレクトリ名
//（省略時 ???.directoryエントリと同じ）
???.source.directory

???.refresh
???.refreshundeletemask
//上のrefresh / refreshundeletemaskの説明と同じ

これらはゴースト／シェルと同時にインストールされます。
特にバルーンの場合、その指定されたバルーンでゴーストが起動します。

ghost / shell以外でこれらを指定することは想定されていません。
必ず指定しないよう注意してください。

type = directory service setting の場合

descript,サービスの説明 url,サービスのURL

• typeにcalendar skin-calendar plugin-directory service settingを設定できるのは現状SSPのみです。

実例1-Ghost with いっぱい

test.narの中身

install.txt
ghost\master\...
shell\master\...
hogeballoon\...
mogeheadline\...
sageplugin\...

install.txtの中身

charset,Shift_JIS
name,ほげほげゴースト
type,ghost
directory,hogeghost
script,\0ほげほげっ！\e
refresh,true
refreshundeletemask,savefile.sav:pointfile.sav

balloon.directory,hoge
balloon.source.directory,hogeballoon
balloon.refresh,true

headline.directory,mogeheadline
plugin.directory,sageplugin

実例2-Shell with Balloon

testshell.narの中身

install.txt
hogeballoon\...
（以下、シェル用PNGやTXTなどがベタにばらまかれている）

install.txtの中身
charset,Shift_JIS
name,ほげほげシェル
type,shell
directory,hogeshell

balloon.directory,hogeballoon

SHIORIへのインストール時のリクエスト

OnInstallFailure - 失敗

Reference0 = 失敗理由
unsupported - install.txtがない、もしくは無効なアーカイブ

OnInstallRefuse - accept不一致

Reference0 = インストールすべきゴーストのSakura名

OnInstallComplete

Reference0 = タイプ (typeエントリそのまま)
Reference1 = 名前 (nameエントリそのまま)
Reference2 = 実際の名前 (descript.txtから取得してきたnameエントリ)

その他考慮すべき挙動

インストール先が現在起動中のゴーストだった場合、モジュール群(SHIORI,MAKOTO,PIRO)はすべていったん開放され、終了後に再度読み込まれます。そのため、ゴーストがOnBootイベント等で内部の変数を設定し、OnClose等で保存するような処理は推奨されません。必ずload/unloadが呼ばれた場合に処理するようにしてください。

追記

この文書はINSTALL/1.0～1.4仕様のすべてを"上書き"します。