セットアップと設定

Suika2のインストールを完了すると、ゲーム開発者は、素材、スクリプト、設定ファイルを編集することができます。
すべてのスクリプトと設定ファイルの拡張子は.txtです。
拡張子は自由に変更することができ、その場合は特定の拡張子に対してテキストエディタで色分けや強調表示を行うこともできます。

対応するフォーマットについては、対応フォーマットをご覧ください。

ゲームフォルダ

Suika2はすべての素材、スクリプト、設定ファイルをこのフォルダに集約します。

スクリプトファイルから素材のファイル名を指定するときは、拡張子を明示し、個々のフォルダ名を書かないようにしてください。

@コマンド ファイル.拡張子

ファイルとフォルダ

Suika2 11.10の時点では、ゲームフォルダは次の構造である必要があります。

bg/ - 背景画像
bgm/ - BGM
cg/ - ユーザインタフェース等の画像
ch/ - キャラ画像
conf/ - 設定ファイル
COPYING - 著作権情報
cv/ - キャラクタボイス
font/ - フォント
gui/ - GUI定義ファイル
mac-pro.dmg - Suika2 Pro for Creators の macOS版
mac.dmg - Suika2 の macOS版
README.html - リリース情報など
rule/ - ルール画像
se/ - 音声効果
suika-pro.exe - Suika2 Pro for Creators の Windows版
suika.exe - Suika2 の Windows版
txt/ - 通常のスクリプトファイル
wms/ - WMSのスクリプトファイル

注意: 表示順はエクスプローラのソート種別によって変わります。

重要なファイルとフォルダ

ゲームフォルダには重要なファイルやフォルダがあります。
エラーを避けるために、削除や名前の変更を行わないでください。
例えば下記のファイルは最も重要です。

conf/config.txt - 設定ファイル
txt/init.txt - 最初に実行されるスクリプトファイル

生成されるファイル

Suika2は実行時にファイルを生成します。例えば、

log.txt - エラーが記録されます
sav/ - セーブデータが記録されます
sav/###.sav - 通常のセーブデータ(変数の値はセーブデータごとに異なります)
sav/q###.sav - クイックセーブデータ(###.savと同様)
sav/g###.sav - グローバルセーブデータ(変数の値はセーブデータ間で共有されます)
sav/696e69742e747874 - 既読フラグデータ(スキップの可否に利用されます)

設定

設定フォルダconf/はゲーム開発者にとって重要で、表面的なカスタマイズが可能です。

注意: オプションのデフォルト値は0です。

言語設定

この設定は日本語版のconfig.txtには含まれていません。
もしゲームを英語化や多言語化したい場合、この設定を追記してください。

多言語化のやり方や詳細については、多言語化をご覧ください。

###
### Language Settings
###

# Language mapping (system language => story language)
language.en=en
language.fr=fr
language.de=de
language.es=es
language.it=it
language.el=el
language.ru=ru
language.zh=zh
language.tw=tw
language.ja=ja
language.other=en

ウィンドウ設定

ウィンドウの設定セクションでは、ゲームで使用する解像度や、ウィンドウのタイトルを指定できます。

###
### ウィンドウの設定
###

# ウィンドウのタイトル
window.title=Suika

# ウィンドウの幅
window.width=1280

# ウィンドウの高さ
window.height=720

# 背景を白にするか(1:白, 0:黒)
window.white=1

# メニューバーを表示するか(1:表示する, 0:表示しない)
window.menubar=0

フォント設定

フォントの設定セクションでは、ゲームで使用するフォントのファイル名やサイズ、色などを指定できます。

###
### フォントの設定
###

# フォントファイル名
font.file=yasashisa.ttf

# フォントサイズ
font.size=38

# フォントの色
font.color.r=255
font.color.g=255
font.color.b=255

# フォントの縁取りの色
font.outline.color.r=128
font.outline.color.g=128
font.outline.color.b=128

# アウトラインを取り除くか(0:アウトラインあり, 1:アウトラインなし)
font.outline.remove=0

名前ボックス設定

名前ボックスの設定セクションでは、セリフのキャラ名を表示する名前ボックスの画像や表示位置などを指定できます。

###
### 名前ボックスの設定
###

# 名前ボックス画像のファイル名
namebox.file=namebox.png

# 名前ボックス画像を表示する位置
namebox.x=95
namebox.y=480

# 名前ボックス画像内のテキスト上端マージン
namebox.margin.top=6

# 名前の中央揃えをやめるか(0:中央揃え, 1:左揃え)
namebox.centering.no=0

# 名前を左揃えにするときのテキスト左端マージン
namebox.margin.left=0

# 名前ボックスを隠す (1:隠す, 0:隠さない) (省略可)
namebox.hidden=0

メッセージボックス設定

メッセージボックスの設定セクションでは、メッセージボックスの画像や表示位置などを指定できます。

###
### メッセージボックスの設定
###

# メッセージボックスの背景の画像ファイル名
msgbox.bg.file=msgbox-bg.png

# メッセージボックスの前景の画像ファイル名
msgbox.fg.file=msgbox-fg.png

# メッセージボックス画像を表示する位置
msgbox.x=43
msgbox.y=503

# メッセージボックス画像内のテキスト左端マージン
msgbox.margin.left=80

# メッセージボックス画像内のテキスト上端マージン
msgbox.margin.top=50

# メッセージボックス画像内のテキスト右端マージン
msgbox.margin.right=80

# メッセージの行間
msgbox.margin.line=55

# メッセージのスピード(毎秒x文字表示する)
msgbox.speed=20.0

# メッセージボックスを非表示にするボタンの座標(メッセージボックス内の座標, 省略可)
msgbox.btn.hide.x=1146
msgbox.btn.hide.y=16
msgbox.btn.hide.width=29
msgbox.btn.hide.height=29

# ポイントされているボタンが変化したときのSE(省略可)
msgbox.btn.change.se=btn-change.ogg

# 上キーもしくはマウスホイールでヒストリ画面を呼び出すときのSE(省略可)
msgbox.history.se=click.ogg

# ESCキーでコンフィグ画面を呼び出すときのSE(省略可)
msgbox.config.se=click.ogg

# メッセージボックスを非表示にするときのSE(省略可)
msgbox.hide.se=click.ogg

# メッセージボックスを表示するときのSE(省略可)
msgbox.show.se=click.ogg

# オートモードをキャンセルするときのSE(省略可)
msgbox.auto.cancel.se=click.ogg

# スキップモードをキャンセルするときのSE(省略可)
msgbox.skip.cancel.se=click.ogg

# 未読でもスキップする (1: スキップする, 0: スキップしない, 省略時0)
msgbox.skip.unseen=0

# 全画面小説モードで読んだメッセージを暗くするための設定 (dim=0:無効, dim=1:有効, 省略可)
msgbox.dim=0
msgbox.dim.color.r=80
msgbox.dim.color.g=80
msgbox.dim.color.b=80
msgbox.dim.color.outline.r=40
msgbox.dim.color.outline.g=40
msgbox.dim.color.outline.b=40

クリックアニメーション設定

クリックアニメーションの設定セクションでは、クリック待機中に表示されるアニメーションの画像や位置を指定できます。

###
### クリックアニメーションの設定
###

# クリックアニメーション画像の表示位置
click.x=1170
click.y=660

# クリックアニメーションの位置を移動するか(0:移動しない, 1:移動する, 省略可)
click.move=0

# クリックアニメーション画像のファイル名
click.file1=click1.png

# クリックアニメーション画像のファイル名 (省略可)
click.file2=click2.png
click.file3=click3.png
click.file4=click4.png
click.file5=click5.png
click.file6=click5.png

# クリックアニメーションの時間間隔
click.interval=1.0

# クリックアニメーションを表示しない (1:表示しない, 0:表示する) (省略可)
click.disable=0

選択肢設定

選択肢の設定セクションでは、選択肢の表示に関わる基本的な設定を指定できます。
Suika2には歴史的な経緯により選択肢を表示するコマンドが複数ありますが、
新たに開発するゲームで使用するのは@chooseコマンドのみと考えてください。

###
### 選択肢の設定 (@choose, @select, @switch, @news)
###

# 選択肢(非選択中)画像のファイル名
switch.bg.file=switch-bg.png

# 選択肢(選択中)画像のファイル名
switch.fg.file=switch-fg.png

# 選択肢の位置
switch.x=406
switch.y=129

# 選択肢の間の縦方向マージン
switch.margin.y=20

# 選択肢画像のテキストの縦方向マージン
switch.text.margin.y=12

# ポイントされた項目のテキスト色 (active=0:無効, active=1:有効) (省略可)
switch.color.active=0
switch.color.active.body.r=255
switch.color.active.body.g=0
switch.color.active.body.b=0
switch.color.active.outline.r=128
switch.color.active.outline.g=128
switch.color.active.outline.b=128

# 選択肢を選択したときの効果音(省略可)
switch.parent.click.se.file=click.ogg

# @switchで2階層目の選択肢を選択したときの効果音(省略可)
switch.child.click.se.file=click.ogg

# 選択肢の選択項目が変更されたときのSE(省略可)
switch.change.se=btn-change.ogg

セーブ・ロード画面設定

セーブ・ロード画面の設定セクションでは、セーブ・ロード画面に表示されるセーブデータのサムネイルのサイズを指定できます。

###
### セーブ・ロード画面の設定
###

# セーブデータのサムネイルのサイズ
save.data.thumb.width=213
save.data.thumb.height=120

システムメニュー設定

システムメニューの設定セクションでは、ゲーム中に表示可能なシステムメニューの画像や位置を指定できます。

###
### システムメニューの設定
###

# システムメニュー画像の座標
sysmenu.x=731
sysmenu.y=29

# システムメニュー画像(通常時)のファイル名
sysmenu.idle.file=sysmenu-idle.png

# システムメニュー画像(選択時)のファイル名
sysmenu.hover.file=sysmenu-hover.png

# システムメニュー画像(使用できない時)のファイル名
sysmenu.disable.file=sysmenu-disable.png

# システムメニューのクイックセーブボタンの座標(システムメニュー画像内での座標)
sysmenu.qsave.x=62
sysmenu.qsave.y=7
sysmenu.qsave.width=60
sysmenu.qsave.height=58

# システムメニューのクイックロードボタンの座標(システムメニュー画像内での座標)
sysmenu.qload.x=123
sysmenu.qload.y=7
sysmenu.qload.width=60
sysmenu.qload.height=58

# システムメニューのセーブボタンの座標(システムメニュー画像内での座標)
sysmenu.save.x=184
sysmenu.save.y=7
sysmenu.save.width=60
sysmenu.save.height=58

# システムメニューのロードボタンの座標(システムメニュー画像内での座標)
sysmenu.load.x=245
sysmenu.load.y=7
sysmenu.load.width=60
sysmenu.load.height=58

# システムメニューのオートボタンの座標(システムメニュー画像内での座標)
sysmenu.auto.x=306
sysmenu.auto.y=7
sysmenu.auto.width=60
sysmenu.auto.height=58

# システムメニューのスキップボタンの座標(システムメニュー画像内での座標)
sysmenu.skip.x=367
sysmenu.skip.y=7
sysmenu.skip.width=60
sysmenu.skip.height=58

# システムメニューのヒストリボタンの座標(システムメニュー画像内での座標)
sysmenu.history.x=428
sysmenu.history.y=7
sysmenu.history.width=60
sysmenu.history.height=58

# システムメニューのコンフィグボタンの座標(システムメニュー画像内での座標)
sysmenu.config.x=489
sysmenu.config.y=7
sysmenu.config.width=60
sysmenu.config.height=58

# システムメニューを呼び出すときのSE(省略可)
sysmenu.enter.se=click.ogg

# システムメニューをキャンセルするときのSE(省略可)
sysmenu.leave.se=click.ogg

# システムメニューの選択されている項目が変わったときのSE(省略可)
sysmenu.change.se=btn-change.ogg

# システムメニューのクイックセーブが選択されたときのSE(省略可)
sysmenu.qsave.se=click.ogg

# システムメニューのクイックロードが選択されたときのSE(省略可)
sysmenu.qload.se=click.ogg

# システムメニューのセーブが選択されたときのSE(省略可)
sysmenu.save.se=click.ogg

# システムメニューのロードが選択されたときのSE(省略可)
sysmenu.load.se=click.ogg

# システムメニューのオートが選択されたときのSE(省略可)
sysmenu.auto.se=click.ogg

# システムメニューのスキップが選択されたときのSE(省略可)
sysmenu.skip.se=click.ogg

# システムメニューのヒストリが選択されたときのSE(省略可)
sysmenu.history.se=click.ogg

# システムメニューのコンフィグが選択されたときのSE(省略可)
sysmenu.config.se=click.ogg

# 折りたたみシステムメニュー画像の座標
sysmenu.collapsed.x=1219
sysmenu.collapsed.y=29

# 折りたたみシステムメニュー画像(通常時)のファイル名
sysmenu.collapsed.idle.file=sysmenu-collapsed-idle.png

# 折りたたみシステムメニュー画像(選択時)のファイル名
sysmenu.collapsed.hover.file=sysmenu-collapsed-hover.png

# 折りたたみシステムメニューが選択されたときのSE(省略可)
sysmenu.collapsed.se=btn-change.ogg

# システムメニューを隠す (1:隠す, 0:隠さない) (省略可)
sysmenu.hidden=0

オートモード設定

オートモードの設定セクションでは、オートモードのスピードや、オートモード中に表示されるバナーの画像と位置を指定できます。

###
### オートモードの設定
###

# オートモードバナー画像のファイル名
automode.banner.file=auto.png

# オートモードバナーの座標
automode.banner.x=0
automode.banner.y=126

# オートモードのスピード(1文字あたりx秒待つ)
automode.speed=0.15

スキップモード設定

スキップモードの設定セクションでは、スキップモード中に表示されるバナーの画像と位置を指定できます。

###
### スキップモードの設定
###

# スキップモードバナー画像のファイル名
skipmode.banner.file=skip.png

# スキップモードバナーの座標
skipmode.banner.x=0
skipmode.banner.y=186

音量初期値

音量の初期値セクションでは、音量の初期値を指定できます。

###
### 音量の初期値
###  - これは初期値で、セーブデータがある場合はそちらが利用される
###

# BGMのボリューム初期値
sound.vol.bgm=1.0

# ボイスのボリューム初期値
sound.vol.voice=1.0

# SEのボリューム初期値
sound.vol.se=1.0

# キャラクタごとの音量の初期値
sound.vol.character=1.0

キャラクタ名ごとに音量を調節するための設定

キャラクタ名ごとに音量を調節するための設定セクションでは、キャラクタごとに個別に音量を設定するための、キャラクタ名登録を行えます。

###
### キャラクタ名ごとに音量を調節するための設定
###  - セリフの名前が下記に一致した場合、キャラクタごとの音量が適用される
###  - キャラクタごとの音量はコンフィグ画面から設定可能(0番から15番まで)
###  - 1番から15番までの15キャラ分について名前を指定可能
###  - セリフの名前がどれにも一致しないときは0番の音量が利用される
###

sound.character.name1=みどり

セリフの色設定

セリフの色の設定セクションでは、キャラクタごとに表示色を変える設定を指定できます。

###
### セリフの色の設定
###

serif.color1.name=Haruka
serif.color1.r=255
serif.color1.g=200
serif.color1.b=200
serif.color1.outline.r=0
serif.color1.outline.g=0
serif.color1.outline.b=0

serif.color2.name=Kana
serif.color2.r=200
serif.color2.g=255
serif.color2.b=200
serif.color2.outline.r=0
serif.color2.outline.g=0
serif.color2.outline.b=0

serif.color3.name=Chiaki
serif.color3.r=200
serif.color3.g=200
serif.color3.b=255
serif.color3.outline.r=0
serif.color3.outline.g=0
serif.color3.outline.b=0

# 以降、serif.color64まで続くが省略可能

その他の設定

その他セクションでは、他のカテゴリに入らない設定を指定可能です。

###
### その他
###

# クリックでボイスを止めない (1:止めない, 0:止める) (省略可)
voice.stop.off=0

# フルスクリーンを無効にする (1:無効にする, 0:有効にする) (省略可)
window.fullscreen.disable=0

# ウィンドウの最大化を無効にする (1:無効にする, 0:有効にする) (省略可)
window.maximize.disable=0

# ウィンドウタイトルと章タイトルの間のセパレータ(省略可)
window.title.separator= 

# 章タイトルをウィンドウタイトルに反映しない (1:反映しない, 0:反映する) (省略可)
window.title.chapter.disable=0

# キャラクタの変更中にメッセージボックスを隠さない (1:隠さない, 0:隠す) (省略可)
msgbox.show.on.ch=0

リリースモード

リリースモードは、ゲームをProgram Filesにインストールする場合に、
セーブデータをProgram Filesではなくユーザのホームフォルダに保存するモードです。

###
### リリースモード
###  - 有効にするとセーブデータがAppData以下に保存されます
###  - ゲームを"Program Files"にインストールする場合にお使いください
###

# リリースモード(0:無効, 1:有効) (省略可)
release=0
←対応フォーマット  スクリプトとコマンド→