翻訳(Translate)

起動オプション一覧

ssp.exeには以下のオプション(スイッチ)をつけて起動することができます。

起動オプションとは?

windowsのソフトウェアの起動時に、設定を切り替えて実行するための仕組みです。
詳しい事は実行時オプション、コマンドラインオプション、起動オプションなどの言葉を調べてみてください。

利用方法

方法はいろいろあります。
例えば「コマンドプロンプト」や「ファイル名を指定して実行」からも使用できます。
ここでは、オプション専用のショートカットを作る方法を書いておきます。

  1. ssp.exeのショートカットを作成します。
    例:ssp.exeを右クリック→ショートカットの作成
  2. 作成したショートカットのプロパティを開きます。
    例:ショートカットを右クリック→プロパティ
  3. プロパティの「リンク先」欄にssp.exeのパスがあるのを確認したら、その全体を「""」で囲います。
  4. 囲ったパスに続けて半角スペースを一つ置き、その後ろに下記の起動オプションを記入します。
    例:"C:/User/Document/略/SSP/ssp.exe" --random
  5. そのままOKボタンを押してプロパティを閉じ、ついでにショートカットに解りやすい名前をつけましょう。
    例:SSP-ランダム起動
  6. そのショートカットを実行すれば、普通にssp.exeを起動した場合とは異なり、オプション設定が反映された状態で起動できます。

オプション一覧

各オプションは --オプション名 形式を推奨します。後方互換のため /x / -x 形式のショートオプションも引き続き使用できます。

値を取るオプションは --オプション名 値 のように、オプション名と値を半角スペースで区切って指定します。値に空白を含む場合は「""」で囲んでください。

2.8.97以降は補助的に --オプション名=値 の形式も受け付けます(例:--sstp-listen=9900)。このページの記載は空白区切りを基本とします。なお /x 形式のショートオプションでは = 形式は使えません。

--option オプション

--option オプションはカンマ区切りで複数指定できます(例:--option bootunlock,standalone)。

スイッチ 機能
--option nobootcheck
(旧: /o nobootcheck)
異常終了チェックを無効にする
--option layered
(旧: /o layered)
半透明ウインドウ有効
--option region
(旧: /o region)
半透明ウインドウ無効(リージョンモード)
--option bootunlock
(旧: /o bootunlock)
二重起動チェックをスキップ
--option standalone
(旧: /o standalone)
SSP.exeがすでに立ち上がっていた時に、起動中のSSP.exeに対してインストールやゴースト起動などの処理を委譲する仕組みを無効化し、必ず自身でゴーストを起動したりインストールを行ったりする。
--option bootunlock,standalone のように二重起動チェックスキップと合わせて指定することで、完全に警告なしでSSP.exeを複数起動できる。
--option kiosk
(旧: /o kiosk)
KIOSKモードを有効にする。以下の通りの挙動となる。 [2.6.54~]
--option bootunlock,standaloneが有効になる
必ずalignmenttodesktopがfreeになる
マウス・キーボード入力を受けつけない
二重起動チェックに一切干渉しない
通知領域アイコン・タスクバーアイコンを表示しない
ゴーストやシェルのSSP側で管理している設定を保存しない
起動中を示すウインドウを表示しない
エラー通知しない
--option readonly
(旧: /o readonly)
読み取り専用モードを有効にする。 [2.8.96以降]
ユーザー環境に対する永続的な変更を一切行わずに起動する。設定を汚さずに動作を試したい場合や、自分以外のPCで一時的にSSPを動かしたい場合などに使う。
画面上の挙動やゴーストとの対話は通常どおりで、KIOSKモードのような入力の遮断や表示の制限は行わない。KIOSKモードとは独立しており、--option kiosk,readonly のように併用もできる。

以下の通りの挙動となる。
--option bootunlock,standaloneが有効になる(起動中のSSPへ処理を委譲してしまうと、そちらが設定を書き込んでしまうため)
二重起動チェックに一切干渉しない
本体設定・ゴースト・シェル・バルーン・プラグインの設定を一切保存しない
起動履歴・使用統計・キャッシュ・クッキー・vanish記録・SSTP設定・POP設定・伺かメッセンジャーの情報とログを保存しない
カレンダーのスケジュール(schedule.ics)を保存しない
セーブデータ共有を行わない(クラウド側への書き出しも、クラウドからローカルへの復元も行わない)
レジストリに書き込まない。ファイルの関連付け・ショートカットの作成・ジャンプリストの登録・「最近使った項目」への追加を行わない
デスクトップの壁紙・背景色を変更しない
ごみ箱を空にしない
vanishしてもゴーストのフォルダを削除しない
本体・ゴースト・バルーン・プラグイン・言語リソースの自動更新を行わない。手動でのネットワーク更新・NARのインストールも行わない
initial_install.narのインストールを行わない
SNTPによる時刻合わせを行わない

設定値の変更そのものは通常どおり行えるが、終了時にファイルへ書き戻されないため次回起動には引き継がれない。
なお動作に必要な一時ファイル(テンポラリフォルダ)は従来どおり作成され、終了時に破棄される。
--option dontloadmodule
(旧: /o dontloadmodule)
SHIORI/MAKOTO/PLUGIN/HEADLINE/CALENDAR系を読まない
--option dpiaware
(旧: /o dpiaware)
DPI Awareness ModeをPer-Monitor V2にして起動する
--option callghost
(旧: /o callghost)
--install と同時に使うと、インストール完了後にゴーストが自動で呼び出される。
--option deletesource
(旧: /o deletesource)
--install と同時に使うと、NARのインストールに成功した時にNARを削除する。

一般オプション

スイッチ 機能
--fmo-name FMO名
(旧: /f FMO名)
書き込むFMO名を強制的に指定したものに変更する。
--random
(旧: /r)
設定にかかわらずゴーストをランダム起動
--ghost フォルダ名/ゴースト名
(旧: /g フォルダ名/ゴースト名)
指定したゴーストを起動する。空白区切りで複数起動する。SSP起動時に指定された場合は、指定されたゴーストのうち最初のものを1組目のゴーストとして起動する。
2.8.99以降、SSP起動時にゴーストフォルダの絶対パス(例:ssp.exe --ghost "C:\Users\user\Desktop\myGhost")を指定した場合、そのゴーストが読み込みフォルダに含まれていなければ、親フォルダ(この例では C:\Users\user\Desktop\)をその起動中だけ一時的にゴーストの読み込みフォルダへ追加して起動する。対象は ghost\master\descript.txt が存在するフォルダのみ。
一時的に追加したフォルダは設定に保存されず、フォルダ設定画面では「(temporary)」と表示されて編集・削除などはできない。また、ゴーストのインストール先の候補にもならない。同じフォルダをフォルダ設定画面から明示的に追加した場合は、通常の読み込みフォルダとして保存される。
すでにSSPが起動している場合(指定が起動中のSSPに引き渡される場合)はこの処理は行われない。
--help
(旧: /?)
起動オプションのヘルプページをブラウザで開く
--help ファイル名
(旧: /? ファイル名)
指定ファイル名のヘルプページをブラウザで開く
--ukagaka-link x-ukagaka-link:URL
(旧: /m x-ukagaka-link:URL)
x-ukagaka-link:URLを開いた時と同じ動きをする。SSP起動時に指定された場合は、1組目のゴースト起動まで待機してから実行される。
--install NARファイル名
(旧: /i NARファイル名)
NARをインストールする。起動中のSSPがある場合はインストール処理を起動中のほうに任せ、ない場合は自身でインストール処理を行った後起動を続行する。
空白区切りで複数指定すると、複数個のNARを順番にインストールする。
任せる先のSSPがゴーストがインストールされていない旨の警告ダイアログ(「何とかして下さい」ダイアログ)が出ている状態でも対応できる。
また、その場合に --option callghost も指定した場合は、警告ダイアログの起動続行ボタンを自動的に押された状態にして起動を続行する。
--ssf SSFファイル名
(旧: /s SSFファイル名)
SSFファイルを実行する。SSP起動時に指定された場合は、1組目のゴースト起動まで待機してから実行される。
--windowmode モード [省略可] 2.8.78~ 実験的機能"ウインドウモード"で起動する。ウインドウ内を1つの仮想的なスクリーンと見立てる形でゴーストを起動し、キャプチャ操作などをやりやすくしたり、デスクトップ全体に影響を及ぼさないようにする。
2.8.86~ モードを指定できる。指定できるのは以下の通り。省略時は前回の設定(初期値はshared)に従う。
shared:起動中のゴーストすべてを1枚のウインドウにまとめる。
perghost:ゴースト1体につきウインドウを1枚ずつ用意する。
2.8.86以降はウインドウモードの状態が設定として保存されるため、このオプションを付けなくても前回の状態で起動する。オフにする場合は右クリックメニューの「設定」または本体設定の「配信」から切り替える。
--sstp-listen 待ち受け先 SSTPサーバの待ち受け先を一時的に指定して起動する。 [2.8.97以降]
保存されているSSTPサーバの待ち受け設定は読み込まず、指定した待ち受け先だけで待ち受ける。
この起動中の待ち受け設定は保存されない。本体設定のSSTPサーバ一覧は表示のみとなり、追加・削除・有効/無効の切り替えはできない。
--option readonly と組み合わせて、起動中の他のSSPと干渉しない試験用のSSPを立てる用途を想定している。

待ち受け先はカンマ区切りで複数指定できる。書式は以下の通り。
ポート番号:IPv4とIPv6のループバック(127.0.0.1 と ::1)で待ち受ける。例:9801
localhost:ポート番号:ポート番号のみの場合と同じ。
IPv4アドレス:ポート番号:指定したアドレスでのみ待ち受ける。0.0.0.0 を指定するとIPv4の全インタフェースで待ち受ける。例:192.168.0.5:9801
[IPv6アドレス]:ポート番号:IPv6アドレスは[]で囲む。[::] を指定するとIPv6の全インタフェースで待ち受ける。例:[::1]:9801
none:一切待ち受けない。待ち受け先を省略した場合も同じ。

アドレスは数値で指定する(localhost を除き、ホスト名は使えない)。
書式が正しくない待ち受け先や待ち受けに失敗した待ち受け先は無視され、エラーログに記録される。この場合も保存されている設定には戻らない。
ループバック以外のアドレスを指定すると、他のPCからのSSTPを受け付けるようになるので注意すること。

例:ssp.exe --option readonly --sstp-listen 9900,[::1]:9901
--guifont フォント名 [2.8.75以降] GUIに使用するフォントを指定する。完全にすべてが置き換わるわけではなく、メニューの一部やタイトルバーなどは今のところ変わらない。

オフラインサーフェスダンプ

スイッチ 機能
--offline-dump フォルダパス オフラインダンプモードで起動する。ゴーストを実際に起動することなく、指定したゴーストフォルダのsurfaces.txtを読み込んでサーフェス画像をダンプし、即終了する。SHIORI/MAKOTO/PIROはロードされない。ウィンドウ・メッセージループも作成されない。
引数にはゴーストのフォルダパスを指定する(末尾の\は任意)。
2.8.98以降、オフラインダンプ関連のオプション(このオプション・--dump-output-dir・--dump-error-log)に相対パスを指定した場合は、SSPを起動したときのカレントディレクトリ基準で解決される。

例:ssp.exe --offline-dump "C:\SSP\ghost\myGhost" --dump-surface-list "0,1" --dump-output-dir "C:\dump"
--dump-shell フォルダ名か名前 [省略可] --offline-dump と組み合わせて使用する。ダンプ対象のシェルをフォルダ名(=shell以下の相対パス)か名前で指定する。省略時はdescript.txtで指定されているデフォルトシェル(通常はmaster)が使われる。
2.8.98以降、指定したシェルが見つからない場合は、デフォルトシェルでダンプせず、エラーログにErrorを記録して何も出力しない。
--dump-scope (スコープID) [省略可] --offline-dump と組み合わせて使用する。ダンプ画像のスコープIDを指定する。省略時は0。
--dump-surface-list リスト [省略可] --offline-dump と組み合わせて使用する。ダンプするサーフェスをカンマ区切りで指定する。surface番号のプレフィックス(surface)は省略可能。surfaces.txtのサーフェスID指定の拡張形式も使用できる。
例:--dump-surface-list "0,1,10"
このオプションを省略した場合はサーフェスダンプは行われない(--dump-error-log と組み合わせてパースエラーのみ出力することができる)。
2.8.98以降、プレフィックスの省略は先頭の要素だけでなく各要素で有効("0,surface1" など)。また、範囲でなく単独の番号で指定したサーフェスが存在しない場合は、エラーログにWarningを記録する(範囲指定内の欠番は記録しない)。
--dump-output-dir ディレクトリ [省略可] --offline-dump と組み合わせて使用する。ダンプ画像の出力先ディレクトリを指定する。省略時はカレントディレクトリが使われる(2.8.97以前は省略するとダンプが行われなかった)。
--dump-output-prefix プレフィックス [省略可] --offline-dump と組み合わせて使用する。出力ファイル名のうち、サーフェス番号の前に付く部分を指定する。既定の「surface」がこの文字列に置き換わる(付け足しではない)。省略時は「surface」。
例:--dump-output-prefix "x_" でサーフェス0は x_0.png になる(x_surface0.png ではない)。
--dump-error-log ファイルパス [省略可] --offline-dump と組み合わせて使用する。シェル読み込み時のエラーログ(surfaces.txtのパースエラーなど)を指定パスに書き出す。
--dump-surface-list を省略してこのオプションのみ指定することで、ダンプを行わずエラーチェックのみを実行できる。
例:ssp.exe --offline-dump "C:\SSP\ghost\myGhost" --dump-error-log "C:\dump\error.csv"

出力形式:BOM付きUTF-8のCSV(改行はCRLF)。1行が1件で、各列は"で囲まれ、列中の"は""にエスケープされる。
"時刻","ゴースト名","レベル","内容"
時刻:HH:MM:SS形式。
レベル:Info / Notice / Warning / Error / Critical / System のいずれか。
内容:ログの本文。2.8.94以降、SERIKO関連のログには [SERIKO] shell\master\surfaces.txt:Line=12:Surface=10 ... のように定義元のファイル(ゴーストフォルダからの相対パス)と行番号が付く。二重定義のログには、先に定義された位置も (ファイル名:Line=n) として併記される。
2.8.94以降、このオプション指定時はログを最大10000件まで保持し、似た内容のログを要約行(レベルSystem)にまとめる処理も行わないため、ログが取りこぼされない。
ログが1件もない場合はファイルは作成されない(同じパスに既存のファイルがあっても上書き・削除はされない)。

終了コード:2.8.94以降、記録されたログのうち最も重いレベルに応じた終了コードでプロセスが終了する。
0:ログなし、またはInfo/Noticeのみ
1:Warningあり(Error/Criticalなし)
2:Errorあり(Criticalなし)
3:Criticalあり
ゴーストの読み込み自体に失敗した場合(指定フォルダのdescript.txtが読めない等)は、ログは出力されず終了コードも0になる。
--dump-surface-option オプション [省略可] [2.8.57以降] オフラインダンプ機能のオプション指定。指定できるのは以下の通り。
backlog:バックログ機能と同じ領域(顔まわり)を切り抜く。ただし拡大縮小は行わず合成画像をそのまま出力する。
collision:当たり判定(collision)の形状と名前を描き込んで出力する。開発用パレットの当たり判定表示と同じものだが、名前は常に表示され、サーフェス外枠・有効範囲・重なり判定範囲などの外形矩形は描かれない。[2.8.98以降]
2.8.98以降、カンマ区切りで複数指定できる(例:--dump-surface-option backlog,collision)。
このオプションでcollisionを指定しない場合、ユーザー設定(開発用パレットの当たり判定表示)にかかわらず当たり判定は描かれない。
--dump-bind 着せ替え指定 [省略可] [2.9.05以降] --offline-dump と組み合わせて使用する。ダンプ時の着せ替えの状態を指定する。
「カテゴリ名,パーツ名,ON/OFF」をセミコロン区切りで複数指定できる。意味は\![bind]と同じで、排他指定のカテゴリでパーツをONにすると、同じカテゴリの他のパーツはOFFになる。
パーツ名を空欄または __ALL__ にすると、カテゴリ内の全パーツが対象になる。
ON/OFFは 1 または true でON、0 または false でOFF。省略時はONとして扱う(\![bind] の省略時は反転だが、こちらは反転しない)。
例:--dump-bind "頭,帽子;服,制服;アクセサリ,__ALL__,0"

基準となる状態は、シェルのdescript.txtで指定された各パーツのデフォルト(sakura.bindgroup*.default)で、ユーザーが最後に着せ替えた状態(shell\profile内の保存値)は使われない。指定したパーツだけがそこから変更される。
着せ替えは --dump-scope で指定したスコープに対して適用される。
存在しないカテゴリ・パーツを指定した場合はWarningのログが記録され(--dump-error-log の終了コードは1)、その指定だけを無視してダンプは続行される。
カテゴリ名・パーツ名の前後の空白は取り除かれないため、カンマの後ろに空白を入れないこと。
--dump-animation アニメーションID [省略可] [2.9.05以降] --offline-dump と組み合わせて使用する。指定したアニメーションを\i[ID]と同様に再生し、コマごとの画像を連番で出力する。指定できるIDは1つだけ(数値のほか、\i[ID]と同様にsurfaces.txtでアニメーションに付けた名前も使用できる)。
各サーフェスについて、まず通常のダンプと同じ画像(runonceのアニメーションを1周させた後の状態)を surface0.png として出力し、続けて指定アニメーションのパターンが進むたびに surface0_0000.png、surface0_0001.png…と0始まり4桁の連番で出力する。--dump-output-prefix や --dump-surface-option の指定は連番の画像にも適用される。
例:ssp.exe --offline-dump "C:\SSP\ghost\myGhost" --dump-surface-list "0" --dump-animation 10 --dump-output-dir "C:\dump"

runonce・always などのアニメーションは通常のダンプと同様に動いており、その上に指定アニメーションが重なる。連番の対象になるのは指定アニメーション自身のパターンだけで、always のアニメーションが進んでも枚数は増えない。
指定アニメーションが最後のパターンまで進んだ時点(alwaysの場合は1周した時点)で終了する。他のアニメーションのstopや排他で止められた場合もそこで終了する。
start・alternativestart・parallelstart で起動された別のアニメーションは連番の対象にならない。指定アニメーションにこれらのパターンが含まれる場合はWarningのログが記録される(出力は続行される)。
start・stop系のパターンは画像が変わらないため連番の1コマとしては数えない。
指定したIDがそのサーフェスに存在しない場合、または着せ替えで無効になっている・排他中などの理由で再生できない場合は、Warningのログを記録し、そのサーフェスは通常の1枚だけを出力する。
連番は最大10000枚(_9999まで)で、これに達した場合はWarningのログを記録して打ち切る。

オフラインツール

スイッチ 機能
--offline-tool 種別 [2.9.01以降] オフラインツールモードで起動する。ゴーストを起動することなく、--target-dir で指定したフォルダからNAR・更新定義ファイル・アーカイブを作成し、即終了する。ゴーストのイベントは一切発生せず、ウィンドウ・メッセージループも作成されない。
さくらスクリプトの \![execute,createnar] / \![execute,createupdatedata] / \![execute,compressarchive] と同等の処理だが、出力先の制限(SSP管理下のフォルダに限る等)はなく自由に指定できる。
種別には以下のいずれかを指定する(大文字小文字は区別しない)。

nar:NARファイルを作成する。developer_options.txt の nonar 指定・.narignore 等による除外は通常のNAR作成と同じく適用される。フォルダ直下にinstall.txtが無い場合は、descript.txt(またはghost\master\descript.txt)から種別と名前を判定して対象フォルダにinstall.txtを作成したうえで収録する。種別と名前が判定できない場合は失敗となる。
updatedata:更新定義ファイルを作成する。--output のファイル名が.dauで終わる場合はupdates2.dauと同じ形式、それ以外の場合はupdates.txtの形式で、指定したファイル1つだけを作成する。対象フォルダ直下・ghost\master の updates2.dau / updates.txt は作成・削除とも行わない。developer_options.txt の noupdate 指定・.updateignore 等による除外は通常と同じく適用される。
archive:対象フォルダをそのまま圧縮する。.narignore 等の除外指定は読まない(隠しファイル・隠しフォルダは収録しない)。形式は --output の拡張子で決まり、.7zの場合は7z形式、それ以外はzip形式となる。

いずれの種別でも、出力先のファイルが既に存在する場合は上書きする。出力先が対象フォルダ内の場合、そのファイル自身は収録しない。出力先のフォルダはあらかじめ存在している必要がある。
--target-dir・--output に相対パスを指定した場合は、SSPを起動したときのカレントディレクトリ基準で解決される。

終了コード:
0:成功
1:引数が不正(種別が不明、--target-dir・--output の省略、--target-dir が存在しないかフォルダでない)
2:作成に失敗した(出力先に書き込めない、NARの種別と名前が判定できない、updatedataで読み取れないファイルや深すぎる階層(32段超)があった、など)。失敗時も途中まで作成したファイルが残る場合がある

例:ssp.exe --offline-tool nar --target-dir "C:\src\myGhost" --output "C:\out\myGhost.nar"
例:ssp.exe --offline-tool updatedata --target-dir "C:\src\myGhost" --output "C:\out\updates2.dau"
例:ssp.exe --offline-tool archive --target-dir "C:\src\data" --output "C:\out\data.7z" --password "pass"
--target-dir フォルダパス [2.9.01以降] --offline-tool と組み合わせて使用する(必須)。処理対象のフォルダを指定する(末尾の\は任意)。NAR・更新定義ファイルの場合はゴースト等のルートフォルダ(descript.txtやinstall.txt、ghostフォルダがあるフォルダ)を指定する。
--output ファイルパス [2.9.01以降] --offline-tool と組み合わせて使用する(必須)。作成するファイルのパスを指定する。
--password パスワード [省略可] [2.9.01以降] --offline-tool の nar または archive と組み合わせて使用する。指定したパスワードでAES暗号化ZIPを作成する(7z形式の場合は7zの暗号化となる)。updatedata では無視される。
パスワードはコマンドラインにそのまま残るため、取り扱いに注意すること。

その他

スイッチ 機能
initial_install.nar 起動オプションではないが、ssp.exeと同じフォルダにinitial_install.narという名前のNARファイルを配置しておくと、SSP起動時にサイレント(確認ダイアログなし)で上書きインストールされる。インストール完了後、initial_install.narは自動的に削除される。SSPにゴースト等を同梱して配布する場合などに利用できる。 [2.7.52~]