Translated Document

This document has been translated from the original Japanese by members of the Ukagaka Dream Team community.
To see the original document, click here.
To submit corrections/updates, see our repository to open an issue or find where to contact us.

descript.txt

descript.txt (of Shell)

Summary

Basic shell configuration file.
In addition to the shell name and author information, the display position of the balloon, image setting of the owner draw menu (right-click menu), and the display settings for dressup in the owner draw menu are also written here.

Basic format and description examples

charset,UTF-8
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,Clothing,Apron dress,apron
sakura.bindgroup1.name,Ribbon,White ribbon,ribbonwhite
sakura.bindgroup2.name,Clothing,Black dress,black
sakura.bindgroup3.name,Ribbon,Black ribbon,ribbonblack
sakura.bindgroup0.default,1
sakura.bindgroup1.default,1

kero.bindgroup0.name,Necktie,Necktie
kero.bindgroup1.name,Arm Band,Black arm band
kero.bindgroup2.name,Arm,Drill
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 and name are required.

In SSP, it is possible to perform network updates from the Explorer, etc., by setting a homeurl for the shell as well.

See the respective sections below for more information on each of the dressup settings.
The basic mechanism is that the name and category name of each dressup are assigned to the animation ID of the bind interval defined in surfaces.txt (sakura(kero).bindgroup*.name,~), and the placement on the owner draw menu is also specified (sakura(kero).menuitem*,~).

Note that strings beginning with \ or % are considered tags in Sakura Script or environment variables, and are discarded due to security risks. If you want to include them as just characters, you need to escape them as \\ or \%.

charset,(character code)

Character code to be used. Shift_JIS is recommended for compatibility with older environments, otherwise UTF-8 is recommended.

(OS default setting or SSP -> Internationalization -> Default charset -> Text definition)

name,(shell name)

Name of the shell.

Cannot be omitted

id,(ID name)

ID name of the shell. Single-byte alphanumeric characters only. (All characters are acceptable in SSP)
So far it has no use other than to appear in a console-like display at startup.
In SSP, this setting is invisible unless Preferences → General → Show Transparent Status Display Window is turned on.

No value

type,(type)

Fileset type. For shells, "shell".

Cannot be omitted/In SSP, anything in the shell folder is automatically identified as shell

craftman,(author name)

The name of the author of the shell. Alphanumeric characters only.

No value

craftmanw,(author name)

The name of the author of the shell.

No value

craftmanurl,URL

Author's URL.

No value

homeurl,URL

Network update URL.

No value

readme,(filename)

The name of the shell explanation text file that is opened during installation or from the menu.

readme.txt

readme.charset,(character code)

Character code of the explanation text file.

(OS default setting or SSP → Internationalization → Default charset → readme)

2.5.10

sakura.name,(name)

The name of the main character of the ghost.

Ghost descript settings

sakura.name2,(name)

The name of the main character of the ghost. Nickname, etc.

Ghost descript settings

kero.name,(name)

The name of the side character of the ghost.

Ghost descript settings

char*.name,(name)

Name of the \p[*] character.

Ghost descript settings

seriko.zorder,(Scope ID),(Scope ID),...

Descript version of \![set,zorder,(scope ID),(scope ID),...]. It can be preconfigured with no need to run the tag.

No value

seriko.sticky-window,(Scope ID),(Scope ID),...

Descript version of \![set,sticky-window,(scope ID),(scope ID),...]. It can be preconfigured with no need to run the tag.

No value

seriko.alignmenttodesktop,(position)

Default ※display position information for the entire surface.
Higher priority than ghost side specification, and lower priority than shell side individual specification (such as sakura.seriko.alignmenttodesktop).
※Ghost side overall specification < ghost side scope individual specification < this setting < shell side scope individual specification.

No value

sakura.seriko.alignmenttodesktop,(position)

Default ※display position information for the main character.
Higher priority than the shell-side overall specification (seriko.alignmenttodesktop). In other words, it has the highest priority among all the alignmenttodesktop-related specifications.
※Ghost side overall specification < ghost side scope individual specification < shell-side overall specification < this setting.

No value

kero.seriko.alignmenttodesktop,(position)

Default ※display position information for the side character.
Higher priority than the shell-side overall specification (seriko.alignmenttodesktop). In other words, it has the highest priority among all the alignmenttodesktop-related specifications.
※Ghost side overall specification < ghost side scope individual specification < shell-side overall specification < this setting.

No value

char*.seriko.alignmenttodesktop,(position)

Default ※display position information for the third and subsequent characters.
Higher priority than the shell-side overall specification (seriko.alignmenttodesktop). In other words, it has the highest priority among all the alignmenttodesktop-related specifications.
※Ghost side overall specification < ghost side scope individual specification < shell-side overall specification < this setting.

No value

sakura.defaultx,(X coordinate)

The image's base X coordinate for the main character.

Ghost descript settings (center of image if none)

kero.defaultx,(X coordinate)

The image's base X coordinate for the side character.

Ghost descript settings (center of image if none)

char*.defaultx,(X coordinate)

The image's base X coordinate for the third and subsequent characters.

Ghost descript settings (center of image if none)

sakura.defaulty,(Y coordinate)

The image's base Y coordinate for the main character.

Ghost descript settings (bottom of image if none)

kero.defaulty,(Y coordinate)

The image's base Y coordinate for the side character.

Ghost descript settings (bottom of image if none)

char*.defaulty,(Y coordinate)

The image's base Y coordinate for the third and subsequent characters.

Ghost descript settings (bottom of image if none)

sakura.defaultleft,(X coordinate)

Default X coordinate of the main character's display.

Ghost descript settings

kero.defaultleft,(X coordinate)

Default X coordinate of the side character's display.

Ghost descript settings

char*.defaultleft,(X coordinate)

Default X coordinate of the third and subsequent character's display.

Ghost descript settings

sakura.defaulttop,(Y coordinate)

Default Y coordinate of the main character's display.
Only valid when seriko.alignmenttodesktop is set to free.

Ghost descript settings

kero.defaulttop,(Y coordinate)

Default Y coordinate of the side character's display.
Only valid when seriko.alignmenttodesktop is set to free.

Ghost descript settings

char*.defaulttop,(Y coordinate)

Default Y coordinate of the third and subsequent character's display.
Only valid when seriko.alignmenttodesktop is set to free.

Ghost descript settings

sakura.balloon.offsetx,(coordinate)

X coordinate of the main character's balloon position.
With a trailing l or r (e.g., offsetxr), the offset when displaying the balloon on the left and right can be set individually (SSP 2.4.58~).
However, note that when specifying r (right), the X coordinate is reversed (positive coordinates move in the left direction).

Ghost descript settings

sakura.balloon.offsety,(coordinate)

Y coordinate of the main character's balloon position.
With a trailing l or r (e.g., offsetxr), the offset when displaying the balloon on the left and right can be set individually (SSP 2.4.58~).
However, note that when specifying r (right), the X coordinate is reversed (positive coordinates move in the left direction).

Ghost descript settings

kero.balloon.offsetx,(coordinate)

X coordinate of the side character's balloon position.
With a trailing l or r (e.g., offsetxr), the offset when displaying the balloon on the left and right can be set individually (SSP 2.4.58~).
However, note that when specifying r (right), the X coordinate is reversed (positive coordinates move in the left direction).

Ghost descript settings

kero.balloon.offsety,(coordinate)

Y coordinate of the side character's balloon position.
With a trailing l or r (e.g., offsetxr), the offset when displaying the balloon on the left and right can be set individually (SSP 2.4.58~).
However, note that when specifying r (right), the X coordinate is reversed (positive coordinates move in the left direction).

Ghost descript settings

sakura.balloon.alignment,(position)

The ※position information of the main character's balloon.

Ghost descript settings

kero.balloon.alignment,(position)

The ※position information of the side character's balloon.

Ghost descript settings

sakura.balloon.dontmove,(number)

Prohibit the user from moving the main character's balloon. 1 (or true): prohibits movement.
Do not abuse this option as it inhibits user operation.

Ghost descript settings(balloon.dontmove)

2.4.96

kero.balloon.dontmove,(number)

Prohibit the user from moving the side character's balloon. 1 (or true): prohibits movement.

Ghost descript settings (balloon.dontmove)

2.4.96

char*.balloon.dontmove,(number)

Prohibit the user from moving the third and subsequent character's balloon. 1 (or true): prohibits movement.

Ghost descript settings (balloon.dontmove)

2.4.96

sakura.bindgroup*.name,(category name),(part name),(thumbnail name)

Define the category name and part name for the part with the animation ID of *. (Main character)
The animation ID is the number that corresponds to the * in "animation*.interval,bind" in the animation definition in surfaces.txt.
Required to display the dressup in the owner draw menu.
Required to be able to use Sakura Script's \![bind,(category name),(part name)] tag. (SSP only)

No action

sakura.bindgroup*.default,(number)

Whether or not the animation with the ID of * is displayed by default. (Main character)

sakura.bindgroup*.addid,ID

Simultaneous execution of dressup changes. When the dressup with animation ID * is activated (displayed), the dressup specified with addid is also activated at the same time. Multiple dressup changes can be specified by separating them with a comma.
A dressup that is running concurrently with addid is disabled when the original dressup is disabled. If the same dressup is specified as an addid for multiple dressups, the dressup specified will not be disabled until all the original dressups are disabled. (Main character)

No action

sakura.bindoption*.group,(category name),(option)

Set options for the dressup category. * is simply a serial number starting from 0. (Main character)
At least one part must always be displayed if "mustselect" is specified. Multiple parts can be displayed at once if "multiple" is specified.
Multiple options can be specified with a + separator.

Part is deselectable, and multiple selections are not allowed

sakura.menuitem*,ID

The dressup for the animation with the specified ID is displayed at the * position in the dressup menu. * is a serial number starting from 0. * is a serial number starting from 0. (Main character)
If "-" is specified instead of an ID, a dividing line is displayed at that position.

No action

sakura.menuitemex*,(menu name),(ID)

The dressup for the animation with the specified ID is displayed at the * position in the dressup menu, in the submenu specified by the "menu name". * is a serial number starting from 0. (Main character)
If "-" is specified instead of an ID, a dividing line is displayed at that position.

No action

kero.bindgroup*.name,(category name),(part name),(thumbnail name)

Define the category name and part name for the part with the animation ID of *. (Side character)
The animation ID is the number that corresponds to the * in "animation*.interval,bind" in the animation definition in surfaces.txt.
Required to display the dressup in the owner draw menu.
Required to be able to use Sakura Script's \![bind,(category name),(part name)] tag. (SSP only)

No action

kero.bindgroup*.default,(number)

Whether or not the animation with the ID of * is displayed by default.(Side character)

kero.bindgroup*.addid,ID

No action

kero.bindoption*.group,(category name),(option)

Set options for the dressup category. * is simply a serial number starting from 0.
At least one part must always be displayed if "mustselect" is specified. Multiple parts can be displayed at once if "multiple" is specified.
Multiple options can be specified with a + separator.

Part is deselectable, and multiple selections are not allowed

kero.menuitem*,ID

The dressup for the animation with the specified ID is displayed at the * position in the dressup menu. * is a serial number starting from 0. (Side character)
If "-" is specified instead of an ID, a dividing line is displayed at that position.

No action

kero.menuitemex*,(menu name),(ID)

The dressup for the animation with the specified ID is displayed at the * position in the dressup menu, in the submenu specified by the "menu name". * is a serial number starting from 0. (Side character)
If "-" is specified instead of an ID, a dividing line is displayed at that position.

No action

char*.bindgroup*.name,(category name),(part name),(thumbnail name)

Define the category name and part name for the part with the animation ID of *. (3rd character and after)
The animation ID is the number that corresponds to the * in "animation*.interval,bind" in the animation definition in surfaces.txt.
Required to display the dressup in the owner draw menu.
Required to be able to use Sakura Script's \![bind,(category name),(part name)] tag. (SSP only)

No action

char*.bindgroup*.default,(number)

Whether or not the animation with the ID of * is displayed by default.(3rd character and after)

char*.bindgroup*.addid,ID

No action

char*.bindoption*.group,(category name),(option)

Set options for the dressup category. * is simply a serial number starting from 0. (3rd character and after)
At least one part must always be displayed if "mustselect" is specified. Multiple parts can be displayed at once if "multiple" is specified.
Multiple options can be specified with a + separator.

Part is deselectable, and multiple selections are not allowed

char*.menuitem*,ID

The dressup for the animation with the specified ID is displayed at the * position in the dressup menu. * is a serial number starting from 0. (3rd character and after)
If "-" is specified instead of an ID, a dividing line is displayed at that position.

No action

char*.menuitemex*,(menu name),(ID)

The dressup for the animation with the specified ID is displayed at the * position in the dressup menu, in the submenu specified by the "menu name". * is a serial number starting from 0.(3rd character and after)
If "-" is specified instead of an ID, a dividing line is displayed at that position.

No action

seriko.paint_transparent_region_black,(number)

Display setting for areas that are not transparent according to the transparency value, even though they are the transparency color of the image (the color of the pixel in the top left corner of the image).
If 0, the original color of the image (transparency color) is displayed with the specified transparency.
If 1, the image is filled with black instead of the color of the image, and then displayed with the specified transparency.
For example, if you specify 0 and prepare a pure white pna image, it will be displayed as it is without a transparency color.

Unspecified (behavior is equivalent to 1 for images with pna as transparency, and 0 for images with the alpha channel of the image itself as transparency)

seriko.use_self_alpha,(number)

If set to 1, the alpha channel of the image itself (32-bit PNG) is used as the transparency, not the pna.
Even if it is set to 1, pna is used for surfaces that do not have an alpha channel.

Surface position information

top: Display stuck to the top.
bottom: Display stuck to the bottom.
free: Freely moveable.

Balloon position information

none: Automatic adjustment. If the Y coordinate of the shell is left of the center of the screen, it will be displayed on the right. If the shell is to the right of center, it will be displayed on the left.
left: Always on the left.
right: Always on the right.

Positioning of menu images

It is specified in the form of (one of the directions) + (tiling option).
Example: lefttop
Example: leftbottom+repeat-x+repeat-y

lefttop: [background/foreground] Place it at the upper left edge.
centertop: [background/foreground] Place it at the center of the top edge. [SSP]
righttop: [background/foreground] Place it at the upper right edge.
leftbottom: [background/foreground] Place it at the lower left edge. [SSP]
centerbottom: [background/foreground] Place it at the center of the lower edge. [SSP]
rightbottom: [background/foreground] Place it at the lower right edge. [SSP]

top: [sidebar] Place it at the top.
bottom: [sidebar] Place it at the bottom.

+repeat-x: [background/foreground] Repeat (tile) images in the horizontal direction. [SSP 2.5.39]
+repeat-y: [background/foreground/sidebar] Repeat (tile) images in the vertical direction. [SSP 2.5.39]

Shell Settings

Shell

descript.txt

Translated Document

descript.txt

descript.txt (of Shell)

Summary

Basic format and description examples

Surface position information

Balloon position information

Positioning of menu images