Home
Downloads
Documents
Index
Tutorial
Command Reference
Search
Japanese
Light
Dark
Auto
Light
Dark
Auto
Tutorial - Polaris Engine Wiki
Wiki Top
Edit
New
Duplicate
Rename
Upload
Attached
Backup
Start:
* Suika2 Tutorial [#g5506b8b]
This is a Suika2 tutorial. It will take 30 minutes for yo...
** Nice to meet you! [#a62eef07]
Welcome to the world of Suika2!
This document explains how to make a basic visual novel u...
Okay, Ready? Let's get started!
** Preparation [#r58895bf]
We'll be using Windows for this tutorial, but the process...
Firstly, download the Suika2 binary.
Run the downloaded file and install Suika2 to your comput...
1. Start Suika2.
2. Press "Yes" to "Going to create a new game." and you'l...
3. Create a folder and open a file.
4. Press "No" to "Do you want to use the full screen styl...
5. A sample game project will be opened.
6. Click "File" -> "Open Game Folder"
You'll see the following folders:
anime/ A folder to store anime files.
bg/ A folder to store background image files.
bgm/ A folder to store background music files.
cg/ A folder to store system image files such as for mes...
ch/ A folder to store character image files.
conf/ A folder to store setting file.
cv/ A folder to store voice files.
font/ A folder to store font files.
gui/ A folder to store GUI files. For me information on ...
rule/ A folder to store rule files.
se/ A folder to store sound effect files.
txt/ A folder to store script files.
When you run Suika2, a sav/ folder will be automatically ...
At the moment, we're just going to use demo-game chunks t...
*** Open a Script File [#jaae4fa7]
Within the txt folder we can find init.txt. When Suika2 s...
Whenever you see Insert the following into init.txt:, mak...
This will let you watch each example without interruption...
You can, of course, mix these examples and your own work ...
*** Comments [#g999cdd6]
Before we get into things, it's important to note that Su...
** My first Suika2 script! [#hb59d0f5]
*** Show a Background Image [#r3bd3ec8]
For our first real step, we'll change the background imag...
Insert the following into init.txt:
@bg roof.png 1.0
@click
@bg is the command to show a background image. roof.png i...
After saving it, run Suika2 and click "Continue". Suika2 ...
*** Show a Character Image [#e769db1f]
Showing character images is pretty similar to the @bg com...
Insert the following into init.txt, between the @bg and @...
@ch center 001-fun.png 1.0
@ch is the command to show a character. center is the hor...
After saving it, run Suika2 and click "Continue". Suika2 ...
*** Show a Message [#da087a84]
Showing dialogue is fundamental to visual novels. Message...
Hi, my name is Midori.
After saving it, run Suika2 and click "Continue". Suika2 ...
Any script lines which don't start with @, : or \* are re...
*** Show a Message with a Character's Name [#z7bd830c]
In most cases, it's important to know whose speaking, thi...
Insert the following into init.txt:
*Midori*Now that you know my name, you can use it in you...
*** Show a Message with Voice [#sa8938bc]
Sometimes, you will have voice files that match the dialo...
Using voice follows a similar structure to names, however...
Insert the following into init.txt:
*Midori*025.ogg*Messages can even be shown with voice li...
025.ogg is a file inside the cv folder. Note: The English...
*** Playing Background Music [#q76212dc]
You can play background music (BGM) using the @bgm comman...
@bgm 01.ogg
Playing BGM.
@bgm is the command to play BGM. 01.ogg is a file inside ...
After saving it, run Suika2 and click "Continue". Suika2 ...
Note: Suika2 can only play sound files encoded using Ogg ...
*** Showing Options [#a4621a93]
A game may have options for multiple endings. Insert the ...
Ok, I'm gonna go to school.
@choose label1 "By foot." label2 "On my bicycle." label3...
:label1
I'm gonna go to school by foot.
@goto end
:label2
I'm gonna go to school on my bicycle.
@goto end
:label3
I'm home sick from school.
:end
After saving it, run Suika2 and click "Continue". Suika2 ...
:label1 is a label to specify a jump destination. Label l...
*** Easier and Label-less Options [#l53e2fb5]
<<<
Ok, I'm gonna go to school.
switch "By foot." "On my bicycle." "I decided not to." {
case:
I'm gonna go to school by foot.
break
case:
I'm gonna go to school on my bicycle.
break
case:
I'm home sick from school.
break
}
>>>
*** Set a Flag and Branch [#gca5711e]
Next, we set a flag and create a branch.
Insert the following into init.txt:
@bg roof.png 1.0
@ch center 001-fun.png 1.0
Ok, I'm gonna go to school.
@choose label1 "By foot." label2 "By bicycle." label3 "I...
:label1
I'm gonna go to school by foot.
@set $1 = 1
@goto next
:label2
I'm gonna go to school by bicycle.
@goto next
:label3
I'm home sick from school.
:next
@if $1 == 0 end
I found money on the ground.
:end
After saving it, run Suika2 and click "Continue". Suika2 ...
Here, we use a combination of @set and @if.
@set is the command to set variables. $1 on the LHS means...
All variables are initially zero. $1 is set to 1 only whe...
@if is the command to jump by condition. $1 == 0 means wh...
*** Easier and Label-less If [#nb147645]
<<<
if $1 == 1 {
I found money on the ground.
}
>>>
*** Show a Menu [#g2f6701d]
You can make a menu screen using GUI.
@gui menu.txt
After saving it, run Suika2 and click "Continue". Suika2 ...
@gui is a command to show a menu. In this case, the comma...
*** Split Script Files [#hb809cad]
When script files start becoming to combresome to organis...
Inside init.txt
@load second.txt
Create second.txt in the txt folder as follows.
Inside second.txt
Now we are on the second script!
After saving these files, run Suika2 and click "Continue"...
@load is the command to jump to a specified script file.
** Creating a Package [#k7242d0d]
We can create a single package file that contains scripts...
It will create a deplayable game folder. At least you nee...
** Support [#s4947287]
Please don't hesitate to reach out via Discord or E-Mail ...
End:
* Suika2 Tutorial [#g5506b8b]
This is a Suika2 tutorial. It will take 30 minutes for yo...
** Nice to meet you! [#a62eef07]
Welcome to the world of Suika2!
This document explains how to make a basic visual novel u...
Okay, Ready? Let's get started!
** Preparation [#r58895bf]
We'll be using Windows for this tutorial, but the process...
Firstly, download the Suika2 binary.
Run the downloaded file and install Suika2 to your comput...
1. Start Suika2.
2. Press "Yes" to "Going to create a new game." and you'l...
3. Create a folder and open a file.
4. Press "No" to "Do you want to use the full screen styl...
5. A sample game project will be opened.
6. Click "File" -> "Open Game Folder"
You'll see the following folders:
anime/ A folder to store anime files.
bg/ A folder to store background image files.
bgm/ A folder to store background music files.
cg/ A folder to store system image files such as for mes...
ch/ A folder to store character image files.
conf/ A folder to store setting file.
cv/ A folder to store voice files.
font/ A folder to store font files.
gui/ A folder to store GUI files. For me information on ...
rule/ A folder to store rule files.
se/ A folder to store sound effect files.
txt/ A folder to store script files.
When you run Suika2, a sav/ folder will be automatically ...
At the moment, we're just going to use demo-game chunks t...
*** Open a Script File [#jaae4fa7]
Within the txt folder we can find init.txt. When Suika2 s...
Whenever you see Insert the following into init.txt:, mak...
This will let you watch each example without interruption...
You can, of course, mix these examples and your own work ...
*** Comments [#g999cdd6]
Before we get into things, it's important to note that Su...
** My first Suika2 script! [#hb59d0f5]
*** Show a Background Image [#r3bd3ec8]
For our first real step, we'll change the background imag...
Insert the following into init.txt:
@bg roof.png 1.0
@click
@bg is the command to show a background image. roof.png i...
After saving it, run Suika2 and click "Continue". Suika2 ...
*** Show a Character Image [#e769db1f]
Showing character images is pretty similar to the @bg com...
Insert the following into init.txt, between the @bg and @...
@ch center 001-fun.png 1.0
@ch is the command to show a character. center is the hor...
After saving it, run Suika2 and click "Continue". Suika2 ...
*** Show a Message [#da087a84]
Showing dialogue is fundamental to visual novels. Message...
Hi, my name is Midori.
After saving it, run Suika2 and click "Continue". Suika2 ...
Any script lines which don't start with @, : or \* are re...
*** Show a Message with a Character's Name [#z7bd830c]
In most cases, it's important to know whose speaking, thi...
Insert the following into init.txt:
*Midori*Now that you know my name, you can use it in you...
*** Show a Message with Voice [#sa8938bc]
Sometimes, you will have voice files that match the dialo...
Using voice follows a similar structure to names, however...
Insert the following into init.txt:
*Midori*025.ogg*Messages can even be shown with voice li...
025.ogg is a file inside the cv folder. Note: The English...
*** Playing Background Music [#q76212dc]
You can play background music (BGM) using the @bgm comman...
@bgm 01.ogg
Playing BGM.
@bgm is the command to play BGM. 01.ogg is a file inside ...
After saving it, run Suika2 and click "Continue". Suika2 ...
Note: Suika2 can only play sound files encoded using Ogg ...
*** Showing Options [#a4621a93]
A game may have options for multiple endings. Insert the ...
Ok, I'm gonna go to school.
@choose label1 "By foot." label2 "On my bicycle." label3...
:label1
I'm gonna go to school by foot.
@goto end
:label2
I'm gonna go to school on my bicycle.
@goto end
:label3
I'm home sick from school.
:end
After saving it, run Suika2 and click "Continue". Suika2 ...
:label1 is a label to specify a jump destination. Label l...
*** Easier and Label-less Options [#l53e2fb5]
<<<
Ok, I'm gonna go to school.
switch "By foot." "On my bicycle." "I decided not to." {
case:
I'm gonna go to school by foot.
break
case:
I'm gonna go to school on my bicycle.
break
case:
I'm home sick from school.
break
}
>>>
*** Set a Flag and Branch [#gca5711e]
Next, we set a flag and create a branch.
Insert the following into init.txt:
@bg roof.png 1.0
@ch center 001-fun.png 1.0
Ok, I'm gonna go to school.
@choose label1 "By foot." label2 "By bicycle." label3 "I...
:label1
I'm gonna go to school by foot.
@set $1 = 1
@goto next
:label2
I'm gonna go to school by bicycle.
@goto next
:label3
I'm home sick from school.
:next
@if $1 == 0 end
I found money on the ground.
:end
After saving it, run Suika2 and click "Continue". Suika2 ...
Here, we use a combination of @set and @if.
@set is the command to set variables. $1 on the LHS means...
All variables are initially zero. $1 is set to 1 only whe...
@if is the command to jump by condition. $1 == 0 means wh...
*** Easier and Label-less If [#nb147645]
<<<
if $1 == 1 {
I found money on the ground.
}
>>>
*** Show a Menu [#g2f6701d]
You can make a menu screen using GUI.
@gui menu.txt
After saving it, run Suika2 and click "Continue". Suika2 ...
@gui is a command to show a menu. In this case, the comma...
*** Split Script Files [#hb809cad]
When script files start becoming to combresome to organis...
Inside init.txt
@load second.txt
Create second.txt in the txt folder as follows.
Inside second.txt
Now we are on the second script!
After saving these files, run Suika2 and click "Continue"...
@load is the command to jump to a specified script file.
** Creating a Package [#k7242d0d]
We can create a single package file that contains scripts...
It will create a deplayable game folder. At least you nee...
** Support [#s4947287]
Please don't hesitate to reach out via Discord or E-Mail ...
Page: