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 Ghost)
Summary
Basic ghost configuration file.
Various information such as the ghost name and author name, shiori settings, base balloon position information, icons, etc., can be set.
Basic format and description examples
charset,UTF-8
type,ghost
name,Mr. Example Ghost
sakura.name,Mr. Example Ghost
kero.name,Example Sidekick
homeurl,http://ssp.shillest.net/ukadoc/manual/hogehoge/example/
craftman,ukadog
craftmanw,うか犬
craftmanurl,http://ssp.shillest.net/ukadoc/manual/index.html
shiori,satori.dll
type, name, sakuraname, keroname, craftman, and craftmanw are required (in SSP, some are optional).
If you use a SHIORI with a dll name that is not "shiori.dll", such as satori, be careful not to forget to specify the dll name.
The homeurl can be set either by writing it in the descript.txt file, or by returning it in the SHIORI Resource request from the baseware (the method is omitted because it depends on the SHIORI).
If both are specified, be careful not to make a mistake such as forgetting to correct one of them when the site has moved.
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,(ghost name)
-
Name of the ghost.
Cannot be omitted
- type,(type)
-
Fileset type. For ghosts, "ghost".
Cannot be omitted/In SSP, if descript.txt is in ghost/master, it is automatically identified as ghost
- craftman,(author name)
-
The name of the author of the ghost. Alphanumeric characters only.
Cannot be omitted/No value in SSP
- craftmanw,(author name)
-
The name of the author of the ghost.
Cannot be omitted/No value in SSP
- id,(ID name)
-
ID name of the ghost. 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
- title,(display name)
-
The name displayed instead of the ID in the startup log for that ghost. Alphanumeric characters only.
In SSP, it is valid only in startup log display mode.No value
- craftmanurl,(URL)
-
Author's URL.
No value
- homeurl,(URL)
-
Network update URL.
While the ghost is running, the SHIORI side description takes precedence. This option takes precedence when updating via the Explorer, and with call by the property system (to avoid SHIORI loading costs).
Be careful not to forget the / at the end of the url.No value
- readme,(filename)
-
The name of the ghost explanation text file that is opened during installation or from the owner draw 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.
Cannot be omitted
- sakura.name2,(name)
-
The name of the main character of the ghost. A nickname, etc.
No value
- kero.name,(name)
-
The name of the side character of the ghost.
Cannot be omitted/sakura.name in SSP ※Used to set window title
- char*.name,(name)
-
The name of the \p[*] character of the ghost.
Cannot be omitted/kero.name in SSP ※Used to set window titles
- sakura.seriko.defaultsurface,(number)
-
Default surface number of the main character of the ghost.
0
- kero.seriko.defaultsurface,(number)
-
Default surface number of the side character of the ghost.
10
- char*.seriko.defaultsurface,(number)
-
Default surface number of the \p[*] character of the ghost.
10
- balloon.defaultsurface,(number)
-
Default surface number of the balloon.
0
- sakura.balloon.defaultsurface,(number)
-
Default surface of the balloon for the main character.
0
- kero.balloon.defaultsurface,(number)
-
Default surface number of the balloon for the side character.
0
- char*.balloon.defaultsurface,(number)
-
Default surface number of the balloon for the \p[*] character.
0
- seriko.alignmenttodesktop,(position)
-
Default ※display position information for the entire surface.
Lower priority than individual scope specification (such as sakura.seriko.alignmenttodesktop).
※This setting < ghost side scope individual specification < shell side overall specification < shell side scope individual specification.bottom
- sakura.seriko.alignmenttodesktop,(position)
-
Default ※display position information for the main character.
Higher priority than ghost side overall specification (seriko.alignmenttodesktop) lower priority than shell side overall specification.
※Ghost side overall specification < this setting < shell side overall specification < shell side scope individual specification.No value
- kero.seriko.alignmenttodesktop,(position)
-
Default ※display position information for the side character.
Higher priority than ghost side overall specification (seriko.alignmenttodesktop) lower priority than shell side overall specification.
※Ghost side overall specification < this setting < shell side overall specification < shell side scope individual specification.No value
- char*.seriko.alignmenttodesktop,(position)
-
Default ※display position information for the third and subsequent characters.
Higher priority than ghost side overall specification (seriko.alignmenttodesktop) lower priority than shell side overall specification.
※Ghost side overall specification < this setting < shell side overall specification < shell side scope individual specification.No value
- sakura.defaultx,(X coordinate)
-
The image's base X coordinate for the main character.
X coordinate of the center of the image
- kero.defaultx,(X coordinate)
-
The image's base X coordinate for the side character.
X coordinate of the center of the image
- char*.defaultx,(X coordinate)
-
The image's base X coordinate for the third and subsequent characters.
X coordinate of the center of the image
- sakura.defaulty,(Y coordinate)
-
The image's base Y coordinate for the main character.<
Y coordinate of the bottom of the image
- kero.defaulty,(Y coordinate)
-
The image's base Y coordinate for the side character.
Y coordinate of the bottom of the image
- char*.defaulty,(Y coordinate)
-
The image's base Y coordinate for the third and subsequent characters.
Y coordinate of the bottom of the image
- sakura.defaultleft,(X coordinate)
-
Default X coordinate of the main character's display.
Unknown
- kero.defaultleft,(X coordinate)
-
Default X coordinate of the side character's display.
Unknown
- char*.defaultleft,(X coordinate)
-
Default X coordinate of the third and subsequent characters's display.
Unknown
- sakura.defaulttop,(Y coordinate)
-
Default Y coordinate of the main character's display.
Only valid when seriko.alignmenttodesktop is set to free.Unknown
- kero.defaulttop,(Y coordinate)
-
Default Y coordinate of the side character's display.
Only valid when seriko.alignmenttodesktop is set to free.Unknown
- char*.defaulttop,(Y coordinate)
-
Default Y coordinate of the third and subsequent character's display.
Only valid when seriko.alignmenttodesktop is set to free.Unknown
- seriko.defaultsurfacedirectoryname,(directory name)
-
Specify the directory name of the shell to be loaded by default in the initial startup, or when the shell has never been switched.
master
- sstp.allowunspecifiedsend,(number)
-
0 to not recieve SSTP that does not specify a ghost. Default is 1.
1
- sstp.allowcommunicate,(number)
-
0 to not recieve COMMUNICATE. Default is 1.
1
- sstp.alwaystranslate,(number)
-
1 to always execute MAKOTO translate + SHIORI OnTranslate, regardless of SSTP options. Default is 0.
0
- name.allowoverride,(number)
-
0 to not use sakura.name/kero.name on the shell side. Default is 1.
1
- shiori.version,(version)
-
SHIORI protocol version specification.
This may need to be specified for older directories that only support SHIORI/2.0, for example.No value (Called with 3.0 when there is no response after a call is executed with 2.0)
- shiori.cache,(number)
-
0 to always unload SHIORI even under conditions where the ghost cache is running. Default is 1 until SSP 2.4.73, 0 after 2.4.74.
1
- shiori.encoding,(character code)
-
Communication with the SHIORI is performed in the specified character set. If a Charset header is returned from the SHIORI side, the SHIORI side takes precedence.
No value
- shiori.forceencoding,(character code)
-
Forces communication with the SHIORI in the specified character set, regardless of whether or not the SHIORI returns a Charset header.
No value
- don't need onmousemove,(number)
-
When set to 1, it will no longer send OnMouseMove.
0
- don't need bind,(number)
-
When set to 1 it will disable dressups.
0
- don't need seriko talk,(number)
-
When set to 1 it will disable the SERIKO talk method (lip-syncing) function.
0
- balloon.dontmove,true
-
Turn off the standard setting for balloon position adjutsment.
false
- icon,(filename)
-
Task tray icon for the ghost.
No value (SSP displays the standard SSP icon)
- icon.minimize,(filename)
-
The icon when the ghost is minimized.
icon
- cursor,(filename) / mousecursor,(filename)
-
Cursor used for interactable areas of the ghost (pointing finger). Can be written as mousecursor since SSP 2.5.41.
Cursor (pointing finger) set by OS (system:finger)
- mousecursor.text,(filename)
-
Cursor used for ghost input boxes (I-BEAM).
Cursor (I type) set by OS (system:text)
- 2.5.41
- mousecursor.wait,(filename)
-
Cursor used when the ghost is processing something and cannot respond (wristwatch type).
Cursor (wristwatch) set by OS (system:wait)
- 2.5.43
- mousecursor.hand,(filename)
-
Cursor indicating areas of the ghost that can be grabbed (open hand shape). Usually used automatically for Bust collision area.
Hand shaped cursor (system:hand)
- 2.6.11
- mousecursor.grip,(filename)
-
Cursor indicating that areas of the ghost which can be grabbed are currently being held (grasping hand shape). Usually used automatically for the state where the mouse button is pressed in the Bust collision area.
Grasping hand cursor (system:grip)
- 2.6.11
- mousecursor.arrow,(filename)
-
Cursor indicating areas of the ghost that are not interactable (arrow).
Arrow cursor (system:arrow)
- 2.6.11
- shiori,(filename)
-
The filename of the SHIORI file used by the ghost.
shiori.dll
- makoto,(filename)
-
The filename of the MAKOTO used by the ghost.
makoto.dll
- menu.font.name,(font name)
-
Font to be used for the owner draw menu.
UI standard font set by the OS
- menu.font.height,(font size)
-
Font size to be used for the owner draw menu.
UI standard font height set by the OS
- shiori.logo.file,(filename)
-
The name of the image file to be used for the AI graph background.
For multiple graph displays, a number is added before the extension.
ExampleL: If you specify aigraph.png, then it will be aigraph0.png, aigraph1.png...
The image size is 288x288px and fills the entire graph drawing area.ai.png (ai0.png, ai1.png...), baseware standard background if none
- Multiple designation from 2.4.26+
- shiori.logo.x,(X coordinate)
-
X coordinate for displaying the image file to be used for the AI graph background.
Also see shiori.logo.align.0
- shiori.logo.y,(Y coordinate)
-
Y coordinate for displaying the image file to be used for the AI graph background.
Also see shiori.logo.align.0
- shiori.logo.align,(position)
-
Specify the reference point of the coordinates specified by shiori.logo.x,y. Usually the upper left.
Possible specifications are "lefttop" for upper left, "leftbottom" for lower left, "righttop" for upper right, and "rightbottom" for lower right.lefttop (upper left reference point)
- install.accept,(name 1),(name 2),(name 3)...
-
Enable installation of nar files for this ghost with a comma-separated list of names.
No behavior
Surface position information
- top
- Display stuck to the top.
- bottom
- Display stuck to the bottom.
- free
- Freely moveable.
descript.txt - Recommended balloon
- balloon,(balloon name)
-
The name of the standard balloon to be used.
Unknown | SSP balloon or user-configured standard balloon (on SSP)
- default.balloon.path,(path)
-
The relative path of the standard balloon to be used.
Unknown | SSP balloon or user-configured standard balloon (on SSP)
- recommended.balloon,(balloon_name)
-
The name of the recommended balloon to be used. If you try to switch to something with a different name, you will get a strong warning.
Not specified
- 2.4
- recommended.balloon.path,(path)
-
The relative path of the recommended balloon to be used. If you try to switch to something with a different name, you will get a strong warning.
Not specified
- 2.4
Standard vs. Recommended usage
- Standard
- What should be selected at the first start-up, or when resetting the settings.
The user is free to change it later. - Recommended
- Same behavior as "standard", but with greater dependencies.
When you try to switch to another balloon, you will get a warning.
Carelessly setting this will deprive the user of choices, so do not specify it unless there is a very strong dependency.
If you simply want to suppress the deletion of some balloons, a warning will appear even if you specify "standard". - Other
- The "recommended" relationship can also be set from the balloon side. See the description in the balloon's descript.txt for details.