SHIORI Resource

SHIORI Resourceは、旧プロトコルSHIORI/2.5において、オーナードローメニューの表示やhomeurlなどの単純な文字列情報を取得するためのリクエストとして定義されたものが元になっています。
この仕様によって、そうした情報をゴースト側の状態に応じて制御することができます。

SHIORI/3.0以降では、旧仕様の整理の結果通常のSHIORI Eventと実装上明確には区別されていません。

通常のSHIORI Eventと異なる特徴として、戻り値はさくらスクリプトでなく単なる（短い）テキスト（bool値様の物含む）として扱われることが挙げられます。またリクエストIDは「On」から始まらず、英字は小文字で表記されます。

SHIORI情報

以下4つのIDのリクエストは、通常SHIORIが自動的に返却し、各ゴースト作者サイドは関知しないものです。

version

SHIORIのロード直後に発生。
SHIORIはこのイベントに対し、SHIORIのバージョン情報を返却する（SHIORIプロトコルのバージョンではない）。

craftman

SHIORIのロード直後に発生。
SHIORIはこのイベントに対し、SHIORIの作者名を返却する。使用できるのは7ビット文字のみ。

craftmanw

SHIORIのロード直後に発生。
SHIORIはこのイベントに対し、SHIORIの作者名を返却する。7ビット文字に加え8ビット文字およびデフォルトエンコーディングのマルチバイト文字も使用可能。

name

SHIORIのロード直後に発生。
SHIORIはこのイベントに対し、SHIORIの名前を返却する（ゴースト名ではない）。使用できるのは7ビット文字のみ。

log_path

開発者用パレットの「開く」を操作した際に発生。SHIORIログファイルまでのフルパスを返す。
SHIORI Event : enable_log も参照。

ゴースト情報

homeurl

ネットワーク更新用ファイルの位置。
何かSHIORIに重大な不具合が生じた際のバックアップ用にdescript.txtにも書ける。
どちらの記述が優先されるかはdescript.txtの説明を参照。

useorigin1

ネットワーク更新時のファイル数の開始数値。
1でファイル数1から開始、0でMATERIAと同じ0から開始。

username

ユーザーの名称。

sakura.defaultx

本体側(\0)の既定位置のX座標。サーフェスの基準点(通常はサーフェスの中央下)をこの位置に置く。
既定位置は、表示位置の記憶が無いとき(初回起動時や、表示位置を初期化したときなど)に使われる。どれも指定しなければ、プライマリモニタの作業領域の右下に置かれる。
値の単位はピクセルで、プライマリモニタの左上を原点とするスクリーン座標(マルチモニタの場合は仮想デスクトップ全体での位置)。
負の値は、プライマリモニタの作業領域の右端からの距離になる。-0は右端そのもの。[2.9.13]
プライマリモニタより左にあるモニタを指すなど、負の座標そのものを指定したいときは、--100のように-を2つ重ねる(この例はX座標-100)。[2.9.13]
同じ軸にsakura.defaultleftも指定されている場合は、こちら(defaultx)が優先される。
ゴースト・シェルのdescript.txtにも同じ項目を書ける[2.9.13]。SHIORIリソースのほうが優先される。
デスクトップの左端/右端に沿って表示する設定のときは、X座標はその設定で決まるため無効。

kero.defaultx

相方側(\1)の既定位置のX座標。書式と意味はsakura.defaultxと同様。
どれも指定しなければ、本体側の左隣に置かれる。

char*.defaultx

*番目のキャラクター(\p[*])の既定位置のX座標。書式と意味はsakura.defaultxと同様。
主に3人目以降(char2以降)に使う。char0・char1は、sakura・keroの指定が無いときに使われる。
どれも指定しなければ、1つ前のキャラクターの左隣に置かれる。

sakura.defaulty

本体側(\0)の既定位置のY座標。サーフェスの基準点(通常はサーフェスの中央下)をこの位置に置く。
既定位置が使われる場面と、値の単位・座標系はsakura.defaultxと同じ。
負の値は、プライマリモニタの作業領域の下端からの距離になる。-0は下端そのもの。ここでの下端は、SSPの設定の「デスクトップ下端オフセット」の分だけ上にずらした位置。[2.9.13]
-を2つ重ねると負の座標そのものになる(--100はY座標-100)。[2.9.13]
同じ軸にsakura.defaulttopも指定されている場合は、こちら(defaulty)が優先される。
ゴースト・シェルのdescript.txtにも同じ項目を書ける[2.9.13]。SHIORIリソースのほうが優先される。
デスクトップの上端/下端に沿って表示する設定のときは、Y座標はその設定で決まるため無効(自由移動モードなどのときに有効)。

kero.defaulty

相方側(\1)の既定位置のY座標。書式と意味はsakura.defaultyと同様。
どれも指定しなければ、本体側と同じ高さに置かれる。

char*.defaulty

*番目のキャラクター(\p[*])の既定位置のY座標。書式と意味はsakura.defaultyと同様。
char0・char1は、sakura・keroの指定が無いときに使われる。
どれも指定しなければ、1つ前のキャラクターと同じ高さに置かれる。

sakura.defaultleft

本体側(\0)の既定位置のX座標。キャラクターウィンドウの左端をこの位置に置く。
既定位置が使われる場面と、値の単位・座標系・無効になる条件はsakura.defaultxと同じ。sakura.defaultxも指定されている場合はそちらが優先される。
負の値は、プライマリモニタの作業領域の右端から、キャラクターの右端までの距離になる。-0で右端にぴったり付く。サーフェスの幅を気にせず、画面右端からの余白として指定できる。[2.9.13]
-を2つ重ねると負の座標そのものになる(--100はX座標-100)。[2.9.13]
ゴースト・シェルのdescript.txtにも同じ項目を書ける。SHIORIリソースのほうが優先される。

kero.defaultleft

相方側(\1)の既定位置のX座標。書式と意味はsakura.defaultleftと同様。

char*.defaultleft

*番目のキャラクター(\p[*])の既定位置のX座標。書式と意味はsakura.defaultleftと同様。
char0・char1は、sakura・keroの指定が無いときに使われる。

sakura.defaulttop

本体側(\0)の既定位置のY座標。キャラクターウィンドウの上端をこの位置に置く。
既定位置が使われる場面と、値の単位・座標系・無効になる条件はsakura.defaultyと同じ(自由移動モードなどのときに有効)。sakura.defaultyも指定されている場合はそちらが優先される。
負の値は、プライマリモニタの作業領域の下端から、キャラクターの下端までの距離になる。-0で下端にぴったり付く。ここでの下端は、SSPの設定の「デスクトップ下端オフセット」の分だけ上にずらした位置。[2.9.13]
-を2つ重ねると負の座標そのものになる(--100はY座標-100)。[2.9.13]
ゴースト・シェルのdescript.txtにも同じ項目を書ける。SHIORIリソースのほうが優先される。

kero.defaulttop

相方側(\1)の既定位置のY座標。書式と意味はsakura.defaulttopと同様。

char*.defaulttop

*番目のキャラクター(\p[*])の既定位置のY座標。書式と意味はsakura.defaulttopと同様。
char0・char1は、sakura・keroの指定が無いときに使われる。

(入力ボックス種類).defaultleft　(入力ボックス種類).defaulttop

入力ボックスの初期スクリーンX・Y座標。leftがX、topがY。leftとtopの両方を返したときだけ有効。
ユーザーが入力ボックスを動かした位置を記憶している場合は、そちらが優先される。
負の値は、本体側が表示されているモニタの作業領域の右端/下端から、入力ボックスの右端/下端までの距離になる。-0で右端/下端にぴったり付く。[2.9.13]
-を2つ重ねると負の座標そのものになる(--100は座標-100)。[2.9.13]
ボックス種類は以下の通り：communicatebox、scriptbox、addressbar、teachbox、dateinput、timeinput、ipinput、sliderinput、passwordinput、inputbox

sakura.recommendsites

本体側のおすすめリスト。
値は
項目名1[バイト値1]url1[バイト値1]バナー画像パス1[バイト値1]選択時トークスクリプト1[バイト値2]項目名2[バイト値1]...
という形式で返す。
ただしその形式への変換はSHIORIが内部的に行っている場合があるので詳しくは各SHIORIの解説を参照。
トークスクリプト部分は単なる文字列ではなくさくらスクリプト。
url部分にurlの変わりにscript:から始まる記述でそのスクリプトが実行される（\![raise]なども可能）。

sakura.portalsites

本体側のポータルリスト。
値は
項目名1[バイト値1]url1[バイト値1]バナー画像パス1[バイト値1]選択時トークスクリプト1[バイト値2]項目名2[バイト値1]...
という形式で返す。
ただしその形式への変換はSHIORIが内部的に行っている場合があるので詳しくは各SHIORIの解説を参照。
トークスクリプト部分は単なる文字列ではなくさくらスクリプト。
url部分にurlの変わりにscript:から始まる記述でそのスクリプトが実行される（\![raise]なども可能）。

kero.recommendsites

相方側のおすすめリスト。
値は
項目名1[バイト値1]url1[バイト値1]バナー画像パス1[バイト値1]選択時トークスクリプト1[バイト値2]項目名2[バイト値1]...
という形式で返す。
ただしその形式への変換はSHIORIが内部的に行っている場合があるので詳しくは各SHIORIの解説を参照。
トークスクリプト部分は単なる文字列ではなくさくらスクリプト。
url部分にurlの変わりにscript:から始まる記述でそのスクリプトが実行される（\![raise]なども可能）。

char*.recommendsites

\p[*]側のおすすめリスト。
値は
項目名1[バイト値1]url1[バイト値1]バナー画像パス1[バイト値1]選択時トークスクリプト1[バイト値2]項目名2[バイト値1]...
という形式で返す。
ただしその形式への変換はSHIORIが内部的に行っている場合があるので詳しくは各SHIORIの解説を参照。
トークスクリプト部分は単なる文字列ではなくさくらスクリプト。
url部分にurlの変わりにscript:から始まる記述でそのスクリプトが実行される（\![raise]なども可能）。

sakura.recommendbuttoncaption

本体側のおすすめの名称。

sakura.portalbuttoncaption

本体側のポータルの名称。

kero.recommendbuttoncaption

相方側のおすすめの名称。

char*.recommendbuttoncaption

\p[*]のおすすめの名称。

updatebuttoncaption

ネットワーク更新の名称。

vanishbuttoncaption

消滅通告の名称。

readmebuttoncaption

Read Me!の名称。

vanishbuttonvisible

消滅通告の表示。1で表示、0で非表示。応答がない場合は表示。

sakura.popupmenu.visible

本体側のオーナードローメニューの表示。1で表示、0で非表示。応答がない場合は表示。

kero.popupmenu.visible

相方側のオーナードローメニューの表示。1で表示、0で非表示。応答がない場合は表示。

char*.popupmenu.visible

\p[*]のオーナードローメニューの表示。1で表示、0で非表示。応答がない場合は表示。

sakura.popupmenu.type

本体側のオーナードローメニューの変更。0で本体側メニュー、1で省略メニュー。

kero.popupmenu.type

相方側のオーナードローメニューの変更。0で本体側メニュー、1で省略メニュー。

char*.popupmenu.type

\p[*]のオーナードローメニューの変更。0で本体側メニュー、1で省略メニュー。

sakura.popupmenu.applybindtoself

オーナードローメニューの種類を変更した時の着せ替えメニューの挙動を変える。
メニューの種類に応じて変える＝0　メニューが所属するスコープ（キャラクターID）の着せ替えを出す＝1
標準設定は1となり、SSP 2.7.25より前の挙動と異なるので、戻したい場合は明示的に0を設定すること。

2.7.26

kero.popupmenu.applybindtoself

2.7.26

char*.popupmenu.applybindtoself

2.7.26

getaistate

AIグラフのSHIORI/3.0版。
ゴースト内部状態(トーク数、好感度など)に関するレーダーチャートを描く。
以下のフォーマットで返す。

グラフ表示値群 [バイト値1] グラフラベル群 [バイト値1] グラフ加算値群 [バイト値1] グラフ最大値群

グラフ表示値群: グラフに表示したい値を半角数値・カンマ区切りで返してください。
2.4.26から小数点以下可。
グラフラベル群(省略可): グラフに表示したいラベルをカンマ区切りで返してください。
省略時：Neuron,NeuronM,NeuronK,NeuronD,NeuronE,Synapse
グラフ加算値群(省略可): グラフの「加算値」を半角数値・カンマ区切りで返してください。
2.4.26から小数点以下可。
加算値とは、学習で増えた値や、直近で変化した値などを強調表示する機能で、グラフ表示値に加算されて表示されます。
省略時：すべてゼロで非表示
グラフ最大値群(省略可): グラフの最大値を半角数値・カンマ区切りで返してください。最大値 ≧ (表示値 + 加算値) です。
2.4.26から小数点以下可。
省略時：表示値＋加算値を計算しその最大値をすべての要素に設定

例：1250,1500,45,65,19500,4[b1]馬力,rpm,km/h,t,kgf,軸[b1]100,50,40,0,0,1[b1]1350,1550,130,96,20000,8
[b1]はバイト値1を示す。
表示結果は以下の通りとなる。
AI Graph

2.4.26から小数点以下認識

getaistateex

getaisateの複数指定可能版。Reference0に何個目のグラフ用のデータを要求しているかが渡される(数値は0スタート)。
グラフを2コだけ表示したい場合は、Reference0が0,1の時応答し、2以上なら値なし(204)を返すこと。
フォーマットはgetaistateと同じ。

Reference0: 何個目のグラフ用のデータか（ゼロベース）。0、1、2…

2.4.26

legacyinterface

右クリックメニュー中の、レガシーインターフェースを使うか否か。
これに 0 を返すと、「ゴースト、シェル、バルーンの各切り替えボタン」が表示されなくなる。
materia582でのみ動作。

更新情報

other_homeurl_override

\![updateother]やシェル・バルーン同時更新機能において、更新対象の更新先URL(homeurl)を強制的に置き換える。
置き換える必要がない場合は、204を返すか空文字列とすること。

Reference0: 更新対象の種類(shell,balloon,headline,plugin,languageなど)
Reference1: 更新対象の名前(descript.txtのname)
Reference2: 更新対象の作者名(descript.txtのcraftmanname)
Reference3: 更新対象のフォルダ名。
Reference4: 本来更新に使用すべきだったhomeurl。

2.5.33

オーナードローメニュー画像

オーナードローメニュー文字色

オーナードローメニュー項目表示

以下項目名の「caption」の部分を「visible」に置き換えたものが、それぞれその項目の表示を制御するたのイベントとして存在する。
返却が1なら表示、0なら非表示（クリック出来なくなる）。

オーナードローメニュー項目名

ショートカットキー

以下の項目名を取得するSHIORI Resource系イベントに対して返却する文字列中で、「&○」というような、&に続けた一字があった場合、○に当たる文字のキーがその項目のショートカットキーになります。
例えばportalrootbutton.captionに対して「きほん(&P)」と返すと、オーナードローメニュー展開中にpキーを押した場合にポータルの項目が選択されるようになります（表示上はPに下線が引かれる）。

半角英数・記号が有効です。入力にshiftキーが必要なものも有効ですが、アルファベットの大文字・小文字は区別されません。

-

[変更不可]Languageの名称。

activaterootbutton.caption

手前に出て来るの名称。

addressbarbutton.caption

アドレスバーの名称。

alignrootbutton.caption

キャラクター自由移動の名称。

alwaysstayontopbutton.caption

常に手前に表示の名称。

alwaystrayiconvisiblebutton.caption

常にトレイアイコンを表示の名称。

balloonhistorybutton.caption

(最近使ったもの)バルーンの名称。

balloonrootbutton.caption

バルーンの名称。

biffallbutton.caption

全アカウントの名称。

biffbutton.caption

メールチェックの名称。

calendarbutton.caption

カレンダーの名称。

callghosthistorybutton.caption

(最近使ったもの)他のゴーストを呼ぶの名称。

callghostrootbutton.caption

他のゴーストを呼ぶの名称。

callsstpsendboxbutton.caption

SSTPボックスの名称。

char*.recommendsites.caption

\p[*]を使用した際のおすすめの名称。

charsetbutton.caption

文字コードの名称。

closeballoonbutton.caption

バルーンを消すの名称。

closebutton.caption

終了の名称。

collisionvisiblebutton.caption

頭／顔／胸当たり判定表示の名称。

configurationbutton.caption

設定の名称。

configurationrootbutton.caption

設定の名称。

debugballoonbutton.caption

バルーンマーカー全表示の名称。

definedsurfaceonlybutton.caption

定義なしサーフェスを無視の名称。

dressuprootbutton.caption

着せ替えの名称。

duibutton.caption

開発用インターフェイスの名称。

enableballoonmovebutton.caption

バルーン位置補正有効の名称。

firststaffbutton.caption

バージョン情報の名称。

ghostexplorerbutton.caption

ゴーストエクスプローラの名称。

ghosthistorybutton.caption

(最近使ったもの)ゴーストに切り替えの名称。

ghostinstallbutton.caption

ゴーストインストールの名称。

ghostrootbutton.caption

ゴーストの名称。

headlinesensehistorybutton.caption

(最近使ったもの)ヘッドラインの名称。

headlinesenserootbutton.caption

ヘッドラインの名称。

helpbutton.caption

説明書の名称。

hidebutton.caption

アイコン化の名称。

historyrootbutton.caption

最近使ったものの名称。

inforootbutton.caption

情報の名称。

leavepassivebutton.caption

制限モード強制解除の名称。

messengerbutton.caption

SSPメッセンジャの名称。

pluginhistorybutton.caption

(最近使ったもの)プラグインの名称。

pluginrootbutton.caption

プラグインの名称。

portalrootbutton.caption

ポータルの名称。

purgeghostcachebutton.caption

ゴーストキャッシュ開放の名称。

quitbutton.caption

全て終了の名称。

rateofuseballoonbutton.caption

バルーン - 個別の名称。

rateofusebutton.caption

使用頻度表示の名称。

rateofuserootbutton.caption

使用率グラフの名称。

rateofusetotalbutton.caption

ゴースト - 合算の名称。

readmebutton.caption

キャラクタについての名称。

termsbutton.caption

キャラクタの利用条件の名称。

recommendrootbutton.caption

おすすめの名称。

regionenabledbutton.caption

リージョンを切らずに表示の名称。

reloadinfobutton.caption

動作情報再読み込みの名称。

resetballoonpositionbutton.caption

バルーン位置初期化の名称。

resettodefaultbutton.caption

設定を標準に戻すの名称。

scriptlogbutton.caption

スクリプトログの名称。

shellrootbutton.caption

シェルの名称。

shellscaleotherbutton.caption

その他の倍率の名称。

shellscalerootbutton.caption

シェル倍率の名称。

sntpbutton.caption

時計合わせの名称。

switchactivatewhentalkbutton.caption

喋る時は常時の名称。

switchactivatewhentalkexceptupdatebutton.caption

更新時以外の名称。

switchautobiffbutton.caption

自動メールチェックの名称。

switchautoheadlinesensebutton.caption

自動ヘッドラインセンスの名称。

switchblacklistingbutton.caption

ブラックリスティングの名称。

switchcompatiblemodebutton.caption

旧仕様をサポートの名称。

switchconsolealwaysvisiblebutton.caption

コンソール常時可視の名称。

switchconsolevisiblebutton.caption

コンソール不可視の名称。

switchdeactivatebutton.caption

喋り終わると裏へ沈むの名称。

switchdontactivatebutton.caption

常に出て来ないの名称。

switchdontforcealignbutton.caption

ゴースト設定の名称。

switchduivisiblebutton.caption

開発用インターフェースの名称。

switchforcealignfreebutton.caption

常に自由移動の名称。

switchforcealignlimitbutton.caption

常に制限の名称。

switchignoreserikomovebutton.caption

SERIKO Moveを無視の名称。

switchlocalsstpbutton.caption

ローカルSSTPの名称。

switchmovetodefaultpositionbutton.caption

シェル位置初期化の名称。

switchproxybutton.caption

プロキシサーバを有効にするの名称。

switchquietbutton.caption

サウンドを鳴らさないの名称。

switchreloadbutton.caption

ゴースト再読み込みの名称。

switchreloadtempghostbutton.caption

一時起動ゴーストを保持の名称。

switchremotesstpbutton.caption

リモートSSTPの名称。

switchrootbutton.caption

スイッチ類の名称。

switchtalkghostbutton.caption

話すタイミングをゴースト任せの名称。

systeminfobutton.caption

システム情報を提出の名称。

updatebutton.caption

ネットワーク更新の名称。

updatefmobutton.caption

FMOの整理／更新の名称。

updateplatformbutton.caption

本体ネットワーク更新の名称。

utilityrootbutton.caption

機能の名称。

vanishbutton.caption

消滅通告の名称。

aistatebutton.caption

AIグラフの名称。

dictationbutton.caption

音声認識の名称。

texttospeechbutton.caption

音声合成の名称。

SHIORI Resourceリスト

SHIORI Resource

Ghost Status

SHIORI情報

ゴースト情報

更新情報

オーナードローメニュー画像

オーナードローメニュー文字色

オーナードローメニュー項目表示

オーナードローメニュー項目名

ツールチップイベント

SHIORI Resource

SHIORI情報

ゴースト情報

更新情報

オーナードローメニュー画像

オーナードローメニュー文字色

オーナードローメニュー項目表示

オーナードローメニュー項目名

ショートカットキー

ツールチップ系