Shell設定

Shell

descript.txt

descript.txt

descript.txt（Shellの）

概要

シェルの基本設定ファイル。
シェル名や作者情報の他、バルーンの表示位置設定や、オーナードローメニュー（右クリックメニュー）の画像設定、着せ替えのオーナードローメニューでの表示設定などもここで行う。

記述例と基本の書き方

charset,Shift_JIS
type,shell
name,master

craftman,ukadog
craftmanw,うか犬
craftmanurl,http://ssp.shillest.net/ukadoc/manual/index.html

menu.background.bitmap.filename,menu_background.png
menu.foreground.bitmap.filename,menu_foreground.png
menu.sidebar.bitmap.filename,menu_sidebar.png

sakura.balloon.offsetx,0
sakura.balloon.offsety,80
kero.balloon.offsetx,-20
kero.balloon.offsety,10
sakura.balloon.alignment,none
kero.balloon.alignment,none

sakura.bindgroup0.name,服,エプロンドレス,apron
sakura.bindgroup1.name,リボン,白リボン,ribbonwhite
sakura.bindgroup2.name,服,黒服,black
sakura.bindgroup3.name,リボン,黒リボン,ribbonblack
sakura.bindgroup0.default,1
sakura.bindgroup1.default,1

kero.bindgroup0.name,ネクタイ,ネクタイ
kero.bindgroup1.name,腕章,黒腕章
kero.bindgroup2.name,腕,ドリル
kero.bindgroup0.default,1
kero.bindgroup1.default,1

sakura.menuitem0,2
sakura.menuitem1,3
sakura.menuitem2,-
sakura.menuitem3,0
sakura.menuitem4,1

kero.menuitem0,0
kero.menuitem1,1
kero.menuitem2,-
kero.menuitem3,2

type、nameは必須。

SSPでは、シェルに対してもhomeurlを設定しておくことで、エクスプローラなどからネットワーク更新が可能になる。

着せ替え設定の各項目については後述のそれぞれの節を参照。
基本的な仕組みは、surfaces.txtで定義した、タイミングbindのanimationIDに対して、着せ替え名と着せ替えカテゴリ名を与え（sakura(kero).bindgroup*.name,～）、またオーナードローメニュー上での配置を指定する必要がある（sakura(kero).menuitem*,～）。

なお、\や%で始まる文字列はさくらスクリプトや環境変数のタグと見なされ、セキュリティ上のリスクから破棄される。もし単なる文字としてそれらを含めたい場合は、\\や\%などとしてエスケープする必要がある。

charset,文字コード

表示する文字コード。旧い環境との互換性を考慮する場合はShift_JIS、それ以外はUTF-8を推奨。

(OSの標準設定またはSSP->国際化->省略時の文字コード->テキスト定義)

  • SSP
  • CROW
name,シェル名

そのシェルの名前。

省略不可

  • Materia
  • SSP
  • CROW
id,ID名

そのシェルのID名。半角英数のみ。(SSPは全文字許容)
今のところ起動時のコンソールのような表示に出てくる以外の用途はない。
SSPは設定-一般-透明ステータス表示ウインドウを有効にする をONしないと見えない。

値なし

  • Materia
  • SSP
  • CROW
type,種別

ファイルセットの種別。シェルの場合はshell。

省略不可/SSPの場合はシェルフォルダ内にあるものはshellと自動識別される

  • Materia
  • SSP
  • CROW
craftman,作者名

そのシェルの作者名。半角英数のみ。

値なし

  • Materia
  • SSP
  • CROW
craftmanw,作者名

そのシェルの作者名。

値なし

  • Materia
  • SSP
  • CROW
craftmanurl,URL

作者のURL。

値なし

  • Materia
  • SSP
  • CROW
homeurl,URL

ネットワーク更新用のURL。

値なし

  • SSP
readme,ファイル名

インストール時やメニューから開かれるシェルの説明テキストファイル名。

readme.txt

  • Materia
  • SSP
readme.charset,文字コード

説明テキストファイルの文字コード。

(OSの標準設定またはSSP->国際化->省略時の文字コード->readme)

  • SSP 2.5.10
sakura.name,名前

本題側のゴーストの名前。

ghostのdescript設定

  • Materia
  • SSP
  • CROW
sakura.name2,名前

本題側のゴーストの名前。愛称等。

ghostのdescript設定

  • SSP
kero.name,名前

相方側のゴーストの名前。

ghostのdescript設定

  • Materia
  • SSP
  • CROW
char*.name,名前

\p[*]の名前。

ghostのdescript設定

  • SSP
seriko.zorder,スコープID,スコープID,...

\![set,zorder,スコープID,スコープID,...]のdescript版。タグを実行しなくてもあらかじめ設定できる。

値なし

  • SSP 2.4
seriko.sticky-window,スコープID,スコープID,...

\![set,sticky-window,スコープID,スコープID,...]のdescript版。タグを実行しなくてもあらかじめ設定できる。

値なし

  • SSP 2.4
seriko.dpi,推奨DPI

このシェルで推奨する画面のDPI値。何も指定しなければWindows標準の96固定となる。
シェルを創った環境のWindows設定で システム-ディスプレイ-拡大縮小を確認し、以下の対照表に合わせて値を選ぶとよい。

  • 100% - 96
  • 125% - 120
  • 150% - 144
  • 175% - 168
  • 200% - 192

目安：4Kモニタなら144(150%)、最近のノートPCなら120-144(125-150%)

96

  • SSP2.7.21
seriko.alignmenttodesktop,位置情報

全体のサーフェスのデフォルト※表示位置情報。
ゴースト側指定より優先度が高く、シェル側個別指定（sakura.seriko.alignmenttodesktopなど）より優先度が低い。
※ゴースト側全体指定＜ゴースト側スコープ個別指定＜これ＜シェル側スコープ個別指定

値なし

  • SSP
  • CROW
sakura.seriko.alignmenttodesktop,位置情報

本体側のデフォルト※表示位置情報。
シェル側全体指定（seriko.alignmenttodesktop）より優先度が高い。すなわち全てのalignmenttodesktop系指定で一番優先度が高い。
※ゴースト側全体指定＜ゴースト側スコープ個別指定＜シェル側全体指定＜これ

値なし

  • SSP
kero.seriko.alignmenttodesktop,位置情報

相方側のデフォルト※表示位置情報。
シェル側全体指定（seriko.alignmenttodesktop）より優先度が高い。すなわち全てのalignmenttodesktop系指定で一番優先度が高い。
※ゴースト側全体指定＜ゴースト側スコープ個別指定＜シェル側全体指定＜これ

値なし

  • SSP
char*.seriko.alignmenttodesktop,位置情報

2人目以降の相方側のデフォルト※表示位置情報。
シェル側全体指定（seriko.alignmenttodesktop）より優先度が高い。すなわち全てのalignmenttodesktop系指定で一番優先度が高い。
※ゴースト側全体指定＜ゴースト側スコープ個別指定＜シェル側全体指定＜これ

値なし

  • SSP
sakura.defaultx,X座標

本体側の画像ベースX座標。

ghostのdescript設定（無ければ画像中央）

  • SSP
kero.defaultx,X座標

相方側の画像ベースX座標。

ghostのdescript設定（無ければ画像中央）

  • SSP
char*.defaultx,X座標

2人目以降の相方側の画像ベースX座標。

ghostのdescript設定（無ければ画像中央）

  • SSP
sakura.defaulty,Y座標

本体側の画像ベースY座標。

ghostのdescript設定（無ければ画像下端）

  • SSP
kero.defaulty,Y座標

相方側の画像ベースY座標。

ghostのdescript設定（無ければ画像下端）

  • SSP
char*.defaulty,Y座標

2人目以降の相方側の画像ベースY座標。

ghostのdescript設定（無ければ画像下端）

  • SSP
sakura.defaultleft,X座標

本体側のディスプレイ上でのデフォルトX座標。

ghostのdescript設定

  • SSP
kero.defaultleft,X座標

相方側のディスプレイ上でのデフォルトX座標。

ghostのdescript設定

  • SSP
char*.defaultleft,X座標

2人目以降の相方側のディスプレイ上でのデフォルトX座標。

ghostのdescript設定

  • SSP
sakura.defaulttop,Y座標

本体側のディスプレイ上でのデフォルトY座標。
seriko.alignmenttodesktopがfreeである場合のみ有効。

ghostのdescript設定

  • SSP
kero.defaulttop,Y座標

相方側のディスプレイ上でのデフォルトY座標。
seriko.alignmenttodesktopがfreeである場合のみ有効。

ghostのdescript設定

  • SSP
char*.defaulttop,Y座標

2人目以降の相方側のディスプレイ上でのデフォルトY座標。
seriko.alignmenttodesktopがfreeである場合のみ有効。

ghostのdescript設定

  • SSP
sakura.balloon.offsetx,座標

本体側バルーン位置X座標。
offsetx / offsety の後ろに方向を表す1文字を付けると、バルーンをどこに出すかによって違う値を使わせることができる(SSPのみ)。

offsetx / offsety
方向指定なし。下記が書かれていない時に使われる既定値。
offsetxl / offsetyl
バルーンをシェルの左に出す時。
offsetxr / offsetyr
バルーンをシェルの右に出す時。
offsetxc / offsetyc
バルーンをシェルの頭上・足元に出す時。中央寄せになる2通りで共通。
offsetxb / offsetyb
バルーンをシェルの足元に出す時。頭上と足元で違う値にしたい場合に使う。

書かれていない時に何が使われるかは以下の通り。X座標とY座標はそれぞれ独立に決まる。

offsetxb が無い時
offsetxc → offsetx の順に探す。
offsetxc / offsetxl / offsetxr が無い時
offsetx を使う。

どちらに出すかは、バルーンのdescript.txtのwindowposition.x、 シェルのsakura.balloon.alignment、 さくらスクリプトの\![set,balloonalign,ID]で決まる。

符号に注意。X座標の＋はどの場合もシェルに近づく向きで、左に出す時は右方向、右に出す時は左方向が＋になる (頭上・足元は右方向が＋)。Y座標の＋は常に下方向。
ただし0の位置(基準)が方向ごとに違う。左右はバルーンの上端とシェル画像の上端が揃う位置、頭上はバルーンの下端がシェル画像の上端に接する位置、足元はバルーンの上端がシェル画像の下端に接する位置。

ghostのdescript設定

  • Materia
  • SSP
  • CROW
sakura.balloon.offsety,座標

本体側バルーン位置Y座標。
方向を表す1文字(l / r / c / b)を後ろに付ける書き方についてはsakura.balloon.offsetxを参照。

ghostのdescript設定

  • Materia
  • SSP
  • CROW
kero.balloon.offsetx,座標

相方側バルーン位置X座標。
方向を表す1文字(l / r / c / b)を後ろに付ける書き方についてはsakura.balloon.offsetxを参照。

ghostのdescript設定

  • Materia
  • SSP
  • CROW
kero.balloon.offsety,座標

相方側バルーン位置Y座標。
方向を表す1文字(l / r / c / b)を後ろに付ける書き方についてはsakura.balloon.offsetxを参照。

ghostのdescript設定

  • Materia
  • SSP
  • CROW
sakura.balloon.alignment,位置情報

本体側の吹き出しの※位置情報。

ghostのdescript設定

  • Materia
  • SSP
  • CROW
kero.balloon.alignment,位置情報

相方側の吹き出しの※位置情報。

ghostのdescript設定

  • Materia
  • SSP
  • CROW
sakura.balloon.dontmove,数値

本体側の吹き出しのユーザーによる移動操作を禁止する。1(もしくはtrue)で禁止。
ユーザーの操作を阻害するので、濫用しないこと。

ghostのdescript設定(balloon.dontmove)

  • SSP 2.4.96
kero.balloon.dontmove,数値

相方側の吹き出しのユーザーによる移動操作を禁止する。1(もしくはtrue)で禁止。

ghostのdescript設定(balloon.dontmove)

  • SSP 2.4.96
char*.balloon.dontmove,数値

2人目以降の吹き出しのユーザーによる移動操作を禁止する。1(もしくはtrue)で禁止。

ghostのdescript設定(balloon.dontmove)

  • SSP 2.4.96
sakura.balloon.syncscale,true

本体側のバルーン拡大縮小率のゴーストとの連動を強制的にONにする(trueのみ有効)。
ユーザーの操作を阻害するので、濫用しないこと。

ghostのdescript設定(balloon.syncscale)

  • SSP 2.7 RC1
kero.balloon.syncscale,true

相方側のバルーン拡大縮小率のゴーストとの連動を強制的にONにする(trueのみ有効)。

ghostのdescript設定(balloon.syncscale)

  • SSP 2.7 RC1
char*.balloon.syncscale,true

2人目以降のバルーン拡大縮小率のゴーストとの連動を強制的にONにする(trueのみ有効)。

ghostのdescript設定(balloon.syncscale)

  • SSP 2.7 RC1
sakura.bindgroup*.name,カテゴリ名,パーツ名,サムネイル名

アニメーションID*番のパーツにカテゴリ名とパーツ名を定義。(本体側)
アニメーションIDはsurfaces.txtにおけるアニメーション定義の「animation*.interval,bind」の*にあたる数字。
オーナードローメニューの着せ替えに表示するために必要。
Sakura Scriptの\![bind,カテゴリ名,パーツ名,数値]で操作するためにも必要。（SSPのみ）

動作なし

  • Materia
  • SSP
sakura.bindgroup*.default,数値

アニメーションID*番の着せ替えを最初から表示するか否か。1で表示、0で非表示。(本体側)

0

  • Materia
  • SSP
sakura.bindgroup*.addid,ID

着せ替えの同時実行設定。アニメーションID*番の着せ替えが有効になった（表示された）時に、addidとして指定した着せ替えも同時に有効にする。カンマ区切りで複数指定可。
同時実行中の着せ替えは、元となった着せ替えが無効になった時点で無効になる。複数の着せ替えのaddidとして同一の着せ替えが同時実行指定されている場合、元となったすべての着せ替えが無効になるまで同時実行指定の着せ替えも無効にならない。(本体側)

動作なし

  • SSP
sakura.bindoption*.group,カテゴリ名,オプション

その着せ替えカテゴリにオプションを設定。*は単に0から始まる通し番号(本体側)。
mustselectでパーツを必ず1つ選択、multipleで複数のパーツを選択可能。
オプションは+区切りで複数可。

選択解除可能、複数選択不可

  • SSP
sakura.menuitem*,ID

着せ替えメニュー上の*の位置にそのアニメーションIDの着せ替えを表示。*は0から始まる通し番号。(本体側)
IDの代わりに「-」を指定すると、その位置に仕切り線表示。

動作なし

  • Materia
  • SSP
sakura.menuitemex*,メニュー名,ID

着せ替えメニュー上の*の位置にそのアニメーションIDの着せ替えを「メニュー名」で示した階層以下に表示。*は0から始まる通し番号。(本体側)
IDの代わりに「-」を指定すると、その位置に仕切り線表示。

動作なし

  • Materia
  • SSP
sakura.menu,autoまたはhidden

シェルの本体側の着せ替えメニューの表示。
autoで自動表示、hiddenで非表示。

動作なし（手動設定）

  • SSP
kero.bindgroup*.name,カテゴリ名,パーツ名,サムネイル名

アニメーションID*番のパーツにカテゴリ名とパーツ名を定義。(相方側)
アニメーションIDはsurfaces.txtにおけるアニメーション定義の「animation*.interval,bind」の*にあたる数字。
オーナードローメニューの着せ替えに表示するために必要。
Sakura Scriptの\![bind,カテゴリ名,パーツ名,数値]で操作するためにも必要。（SSPのみ）

動作なし

  • Materia
  • SSP
kero.bindgroup*.default,数値

アニメーションID*番の着せ替えを最初から表示するか否か。1で表示、0で非表示。(相方側)

0

  • Materia
  • SSP
kero.bindgroup*.addid,ID

着せ替えの同時実行設定。アニメーションID*番の着せ替えが有効になった（表示された）時に、addidとして指定した着せ替えも同時に有効にする。カンマ区切りで複数指定可。
同時実行中の着せ替えは、元となった着せ替えが無効になった時点で無効になる。複数の着せ替えのaddidとして同一の着せ替えが同時実行指定されている場合、元となったすべての着せ替えが無効になるまで同時実行指定の着せ替えも無効にならない。(相方側)

動作なし

  • SSP
kero.bindoption*.group,カテゴリ名,オプション

その着せ替えカテゴリにオプションを設定。*は単に0から始まる通し番号(相方側)。
mustselectでパーツを必ず1つ選択、multipleで複数のパーツを選択可能。
オプションは+区切りで複数可。

選択解除可能、複数選択不可

  • SSP
kero.menuitem*,ID

着せ替えメニュー上の*の位置にそのアニメーションIDの着せ替えを表示。*は0から始まる通し番号。(相方側)
IDの代わりに「-」を指定すると、その位置に仕切り線表示。

動作なし

  • Materia
  • SSP
kero.menuitemex*,メニュー名,ID

着せ替えメニュー上の*の位置にそのアニメーションIDの着せ替えを「メニュー名」で示した階層以下に表示。*は0から始まる通し番号。(相方側)
IDの代わりに「-」を指定すると、その位置に仕切り線表示。

動作なし

  • SSP
kero.menu,autoまたはhidden

シェルの相方側の着せ替えメニューの表示。
autoで自動表示、hiddenで非表示。

動作なし（手動設定）

  • SSP
char*.bindgroup*.name,カテゴリ名,パーツ名,サムネイル名

アニメーションID*番のパーツにカテゴリ名とパーツ名を定義。(3人目以降)
アニメーションIDはsurfaces.txtにおけるアニメーション定義の「animation*.interval,bind」の*にあたる数字。
オーナードローメニューの着せ替えに表示するために必要。
Sakura Scriptの\![bind,カテゴリ名,パーツ名,数値]で操作するためにも必要。（SSPのみ）

動作なし

  • SSP
char*.bindgroup*.default,数値

アニメーションID*番の着せ替えを最初から表示するか否か。1で表示、0で非表示。(3人目以降)

0

  • SSP
char*.bindgroup*.addid,ID

着せ替えの同時実行設定。アニメーションID*番の着せ替えが有効になった（表示された）時に、addidとして指定した着せ替えも同時に有効にする。カンマ区切りで複数指定可。
同時実行中の着せ替えは、元となった着せ替えが無効になった時点で無効になる。複数の着せ替えのaddidとして同一の着せ替えが同時実行指定されている場合、元となったすべての着せ替えが無効になるまで同時実行指定の着せ替えも無効にならない。(3人目以降)

動作なし

  • SSP
char*.bindoption*.group,カテゴリ名,オプション

その着せ替えカテゴリにオプションを設定。*は単に0から始まる通し番号(3人目以降)。
mustselectでパーツを必ず1つ選択、multipleで複数のパーツを選択可能。
オプションは+区切りで複数可。

選択解除可能、複数選択不可

  • SSP
char*.menuitem*,ID

着せ替えメニュー上の*の位置にそのアニメーションIDの着せ替えを表示。*は0から始まる通し番号。(3人目以降)
IDの代わりに「-」を指定すると、その位置に仕切り線表示。

動作なし

  • SSP
char*.menuitemex*,メニュー名,ID

着せ替えメニュー上の*の位置にそのアニメーションIDの着せ替えを「メニュー名」で示した階層以下に表示。*は0から始まる通し番号。(3人目以降)
IDの代わりに「-」を指定すると、その位置に仕切り線表示。

動作なし

  • SSP
char*.menu,autoまたはhidden

シェルの3人目以降の着せ替えメニューの表示。
autoで自動表示、hiddenで非表示。

動作なし（手動設定）

  • SSP
seriko.paint_transparent_region_black,数値

画像の透過色（画像左上の色）になっているにも関わらず、透明度の値では透明でない領域の表示設定。
0の場合は画像本来の色（透過色）を指定の透明度で表示する。
1の場合は画像の色の替わりに黒で塗りつぶされてから指定の透明度で表示する。
例えば0を指定した上で全面真っ白のpnaを用意した画像は、透過色なしで画像のまま表示される。

指定なし（pnaを透明度としている画像では1相当、画像自体のアルファチャンネルを透明度としている画像では0相当の動作になる）

  • SSP
seriko.use_self_alpha,値

1またはtrueを指定した場合は、透明度のある画像（アルファチャンネル付きPNG）および.pnaのある画像はアルファチャンネルを参照して透明度として使用する。アルファチャンネルも.pnaも存在しない場合は画像左上の色をキー色とする従来挙動になる。
fullを指定した場合は上記に加え、アルファチャンネルのない画像も全て不透明として扱う（左上のキー色透過を行わない）。

0

  • SSP
seriko.force_disable_crossfade,値

1またはtrueを指定した場合は、サーフェス切り替え時のクロスフェード効果を強制的に無効化する。

0

  • SSP2.8.43
sakura.icon.frame.color.r,数値

本体側のアイコン(顔サムネイル)がバックログ(発言履歴)ウィンドウに表示される際の、枠の赤成分(0～255)。※注意

値なし

  • SSP 2.8.53
sakura.icon.frame.color.g,数値

本体側のアイコン(顔サムネイル)がバックログ(発言履歴)ウィンドウに表示される際の、枠の緑成分(0～255)。※注意

値なし

  • SSP 2.8.53
sakura.icon.frame.color.b,数値

本体側のアイコン(顔サムネイル)がバックログ(発言履歴)ウィンドウに表示される際の、枠の青成分(0～255)。※注意

値なし

  • SSP 2.8.53
kero.icon.frame.color.r,数値

相方側のアイコン(顔サムネイル)がバックログ(発言履歴)ウィンドウに表示される際の、枠の赤成分(0～255)。※注意

値なし

  • SSP 2.8.53
kero.icon.frame.color.g,数値

相方側のアイコン(顔サムネイル)がバックログ(発言履歴)ウィンドウに表示される際の、枠の緑成分(0～255)。※注意

値なし

  • SSP 2.8.53
kero.icon.frame.color.b,数値

相方側のアイコン(顔サムネイル)がバックログ(発言履歴)ウィンドウに表示される際の、枠の青成分(0～255)。※注意

値なし

  • SSP 2.8.53
char*.icon.frame.color.r,数値

2人目以降の相方側のアイコン(顔サムネイル)がバックログ(発言履歴)ウィンドウに表示される際の、枠の赤成分(0～255)。※注意

値なし

  • SSP 2.8.53
char*.icon.frame.color.g,数値

2人目以降の相方側のアイコン(顔サムネイル)がバックログ(発言履歴)ウィンドウに表示される際の、枠の緑成分(0～255)。※注意

値なし

  • SSP 2.8.53
char*.icon.frame.color.b,数値

2人目以降の相方側のアイコン(顔サムネイル)がバックログ(発言履歴)ウィンドウに表示される際の、枠の青成分(0～255)。※注意

値なし

  • SSP 2.8.53

サーフェスの位置情報

top
上部に貼り付き表示。
bottom
下部に貼り付き表示。
free
自由移動。

バルーンの位置情報

none
自動調整、shellのY座標が画面中央より左なら右、右なら左に表示。
left
常に左に表示。
right
常に右に表示。

メニュー画像の位置指定

寄せる方向のいずれか+繰り返し(タイリング)指定 という形式で指定する。
例：lefttop
例：leftbottom+repeat-x+repeat-y

lefttop
[background/foreground]左上端に寄せる。
centertop
[background/foreground]上端中央に寄せる。 [SSP]
righttop
[background/foreground]右上端に寄せる。
leftbottom
[background/foreground]左下端に寄せる。 [SSP]
centerbottom
[background/foreground]下端中央に寄せる。 [SSP]
rightbottom
[background/foreground]右下端に寄せる。 [SSP]
top
[sidebar]上端に寄せる。
bottom
[sidebar]下端に寄せる。
+repeat-x
[background/foreground]横方向に繰り返して（タイリングして）画像を表示する。 [SSP 2.5.39]
+repeat-y
[background/foreground/sidebar]縦方向に繰り返して（タイリングして）画像を表示する。 [SSP 2.5.39]

アイコン枠色の明度調整について

sakura(kero/char*).icon.frame.color.(r/g/b)で指定した色は、そのままバックログ(発言履歴)ウィンドウの枠色として使われるわけではない。
ダークモード/ライトモードなど、ウィンドウのUI配色に合わせて明度を上げ下げする演算が加えられた上で表示される。
そのため、指定はできるだけ混じりけのない原色に近い値が望ましい。(例：赤にしたい場合はRGB＝255,0,0など)