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.
SHIORI Resource
SHIORI Resource is based on the old protocol SHIORI/2.5, which was defined as a request to get simple string information, such as the display of the owner draw menu and homeurl.
This specification allows such information to be controlled on the ghost's side, changing according to its state.
In SHIORI/3.0 and later, as a result of reorganization of the old specifications, there is now no clear distinction in implementation compared to regular SHIORI events.
A feature that differs from normal SHIORI events is that the return value is treated as a simple (short) text (including bool-like objects) rather than SakuraScript. Also, the request ID does not start with "On", and all letters are written in lowercase.
SHIORI Information
The following four ID requests are usually returned automatically by the SHIORI, and are of no concern on the ghost author's side.
- version
-
Occurs immediately after loading the SHIORI.
The SHIORI returns the SHIORI version information (not the SHIORI protocol version) for this event.
- craftman
-
Occurs immediately after loading the SHIORI.
The SHIORI returns the name of the SHIORI author for this event. Only 7-bit characters can be used.
- craftmanw
-
Occurs immediately after loading the SHIORI.
The SHIORI returns the name of the SHIORI author for this event. 8-bit characters and multibyte characters with default encoding can also be used.
- name
-
Occurs immediately after loading the SHIORI.
The SHIORI returns the name of the SHIORI (not the ghost name) for this event. Only 7-bit characters can be used.
- log_path
-
Occurs when the "Open" button of the developer palette is clicked. Returns the full path to the SHIORI log file.
Refer to SHIORI Event : enable_log.
Ghost Information
- homeurl
-
Location of files for network updates.
You can also write it in descript.txt as a backup in case something goes terribly wrong with the SHIORI.
See the description in descript.txt for which takes precedence.
- useorigin1
-
The number to start counting network update files from.
1 to count from 1, 0 to count from 0, the same as in MATERIA.
- username
-
Name of the user.
- sakura.defaultx
-
Base X coodinate of the main character's image.
- kero.defaultx
-
Base X coodinate of the side character's image
- char*.defaultx
-
Base X coodinate of the image for the 2nd and subsequent characters.
- sakura.defaulty
-
Base Y coodinate of the main character's image.
- kero.defaulty
-
Base Y coodinate of the side character's image
- char*.defaulty
-
Base Y coodinate of the image for the 2nd and subsequent characters.
- sakura.defaultleft
-
Default X coordinate of the main character's display.
- kero.defaultleft
-
Default X coordinate of the side character's display.
- char*.defaultleft
-
Default X coordinate of the display of the 2nd and subsequent characters.
- sakura.defaulttop
-
Default Y coordinate of the main character's display. (Valid only in free movement mode.)
- kero.defaulttop
-
Default Y coordinate of the side character's display. (Valid only in free movement mode.)
- char*.defaulttop
-
Default Y coordinate of the display of the 2nd and subsequent characters. (Valid only in free movement mode.)
- (Input box type).defaultleft (Input box type).defaulttop
-
Initial screen X and Y coordinates of the input box, where left is X and top is Y.
The box types are as follows: communicatebox, scriptbox, addressbar, teachbox, dateinput, timeinput, ipinput, sliderinput, passwordinput, inputbox
- sakura.recommendsites
-
Recommended list on the main character's side.
The value is returned in the following format:
item name 1 [byte value 1]url 1[byte value 1]banner image path 1[byte value 1]talk script on selection 1[byte value 2]...
However, conversion to that format may be done internally by the SHIORI, so refer to the explanation of each SHIORI for details.
The "talk script" is not just a string, but a SakuraScript.
If the url portion begins with "script:" instead of a url, the script will be executed. (\![raise] tags, etc., can also be used).
- sakura.portalsites
-
Portal list on the main character's side.
The value is returned in the following format:
item name 1 [byte value 1]url 1[byte value 1]banner image path 1[byte value 1]talk script on selection 1[byte value 2]...
However, conversion to that format may be done internally by the SHIORI, so refer to the explanation of each SHIORI for details.
The "talk script" is not just a string, but a SakuraScript.
If the url portion begins with "script:" instead of a url, the script will be executed. (\![raise] tags, etc., can also be used).
- kero.recommendsites
-
Recommended list on the side character's side.
The value is returned in the following format:
item name 1 [byte value 1]url 1[byte value 1]banner image path 1[byte value 1]talk script on selection 1[byte value 2]...
However, conversion to that format may be done internally by the SHIORI, so refer to the explanation of each SHIORI for details.
The "talk script" is not just a string, but a SakuraScript.
If the url portion begins with "script:" instead of a url, the script will be executed. (\![raise] tags, etc., can also be used).
- char*.recommendsites
-
Recommended list on the \p[*] side.
The value is returned in the following format:
item name 1 [byte value 1]url 1[byte value 1]banner image path 1[byte value 1]talk script on selection 1[byte value 2]...
However, conversion to that format may be done internally by the SHIORI, so refer to the explanation of each SHIORI for details.
The "talk script" is not just a string, but a SakuraScript.
If the url portion begins with "script:" instead of a url, the script will be executed. (\![raise] tags, etc., can also be used).
- sakura.recommendbuttoncaption
-
Name of the recommended button for the main character.
- sakura.portalbuttoncaption
-
Name of the portal button for the main character.
- kero.recommendbuttoncaption
-
Name of the recommended button for the side character.
- char*.recommendbuttoncaption
-
Name of the recommended button for \p[*] characters.
- updatebuttoncaption
-
Name of the network update button.
- vanishbuttoncaption
-
Name of the uninstall button.
- readmebuttoncaption
-
Name of the Read Me.
- vanishbuttonvisible
-
Display of the uninstall button. 1 to show, 0 to hide.
- sakura.popupmenu.visible
-
Display of the owner draw menu for the main character. 1 to show, 0 to hide.
- kero.popupmenu.visible
-
Display of the owner draw menu for the side character. 1 to show, 0 to hide.
- char*.popupmenu.visible
-
Display of the owner draw menu for \p[*] characters. 1 to show, 0 to hide.
- sakura.popupmenu.type
-
Change the owner draw menu for the main character. 0 for the main character menu, 1 for an abbreviated menu.
- kero.popupmenu.type
-
Change the owner draw menu for the side character. 0 for the main character menu, 1 for an abbreviated menu.
- char*.popupmenu.type
-
Change the owner draw menu for \p[*] characters. 0 for the main character menu, 1 for an abbreviated menu.
- getaistate
-
SHIORI/3.0 version of the AI graph.
Draws a radar chart based on the ghost's internal state (number of talks, relationship, etc.).
Returns in the following format:Graph display value group [byte value 1] Graph label group [byte value 1] Graph additive value group [byte value 1] Graph maximum value group
- Graph display value group
- Return the values you want to display on the graph as single-byte numbers, separated by commas.
Decimal points allowed since 2.4.26. - Graph label group (optional)
- Return a comma-separated list of the labels you want to display on the graph.
When omitted: Neuron, NeuronM, NeuronK, NeuronD, NeuronE, Synapse - Graph additive value group (optional)
- Return the "additive value" of the graph as single-byte numbers, separated by commas.
Decimal points allowed since 2.4.26.
"Additive value" is a function that highlights values that have increased through learning, or values that have changed recently, and is added to the graph display value when displayed.
When omitted: All 0s, therefore hidden. - Graph maximum value group (optional)
- Return the maximum value of the graph as single-byte numbers, separated by commas. Maximum value ≧ (displayed value + additive value).
Decimal points allowed since 2.4.26.
When omitted: Calculate the display value plus the additive value, and set the maximum value to all elements.
Example: 1250,1500,45,65,19500,4 [b1] HP,rpm,km/h,t,kgf,axis [b1] 100,50,40,0,0,1 [b1] 1350,1550,130,96,20000,8
[b1] indicates byte value 1.
The result will be displayed as follows:
Decimal point recognition since 2.4.26
- getaistateex
-
A multiple-specification version of getaistate, where Reference0 receives the number of graphs for which data are requested (numbers start from 0).
To display only two graphs, respond when Reference0 is 0 or 1, and return no value (204) if Reference0 is 2 or more.
The format is the same as getaistate.- Reference0
- Data for the graph of the same number (0-based). 0, 1, 2...
- 2.4.26
- legacyinterface
-
Whether or not to use the legacy interface in the right click menu.
If 0 is returned, the "ghost, shell, and balloon toggle buttons" will not be displayed.
Only works with materia582.
Update Information
- other_homeurl_override
-
Forcibly replace the update target url (homeurl) in \![updateother] and the shell/balloon simultaneous update function.
If no replacement is needed, return 204 or an empty string.- Reference0
- Type of update target (shell, balloon, headline, plugin, language, etc.)
- Reference1
- Name of update target (name in descript.txt)
- Reference2
- Name of the update target's author (craftmanname in descript.txt)
- Reference3
- Folder name of the update target.
- Reference4
- The homeurl originally meant to be used for updating.
- 2.5.33
Owner Draw Menu Image
- menu.sidebar.bitmap.filename
-
Name of the sidebar display image file, relative to the location of the SHIORI.
- menu.background.bitmap.filename
-
Name of the background display image file, relative to the location of the SHIORI.
- menu.foreground.bitmap.filename
-
Name of the foreground display image file, relative to the location of the SHIORI.
Owner Draw Menu Text Color
- menu.background.font.color.r
-
Red value of the background text color (0–255).
- menu.background.font.color.g
-
Green value of the background text color (0–255).
- menu.background.font.color.b
-
Blue value of the background text color (0–255).
- menu.foreground.font.color.r
-
Red value of the foreground text color (0–255).
- menu.foreground.font.color.g
-
Green value of the foreground text color (0–255).
- menu.foreground.font.color.b
-
Blue value of the foreground text color (0–255).
- menu.separator.color.r
-
Red value of the separator color (0–255).
- menu.separator.color.g
-
Green value of the separator color (0–255).
- menu.separator.color.b
-
Blue value of the separator color (0–255).
- menu.frame.color.r
-
Red value of the frame color (0–255).
- 2.5.41
- menu.frame.color.g
-
Green value of the frame color (0–255).
- 2.5.41
- menu.frame.color.b
-
Blue value of the frame color (0–255).
- 2.5.41
- menu.disable.font.color.r
-
Red value of unselectable text (0–255).
- menu.disable.font.color.g
-
Green value of unselectable text (0–255).
- menu.disable.font.color.b
-
Blue value of unselectable text (0–255).
Owner Draw Menu Item Display
Regarding the following items: there are also events to control whether the item is displayed or not. The names are the same as the following events, but "caption" is replaced with "visible".
If the return is 1, it is displayed. If it is 0, it is not displayed (cannot be clicked).
Owner Draw Menu Item Mame
- -
-
[Unchangeable]Name of the language button.
- activaterootbutton.caption
-
Name of the come to foreground button.
- addressbarbutton.caption
-
Name of the address bar button.
- alignrootbutton.caption
-
Name of the free character movement button.
- alwaysstayontopbutton.caption
-
Name of the always display in foreground button.
- alwaystrayiconvisiblebutton.caption
-
Name of the always show tray icon button.
- balloonhistorybutton.caption
-
The name of the (recently used) balloon button
- balloonrootbutton.caption
-
Name of the balloon button.
- biffallbutton.caption
-
Name of the check all email accounts button.
- biffbutton.caption
-
Name of the email check button.
- calendarbutton.caption
-
Name of the calendar button.
- callghosthistorybutton.caption
-
Name of the call (recently used) ghost button.
- callghostrootbutton.caption
-
Name of the call ghost button.
- callsstpsendboxbutton.caption
-
Name of the SSTP Box button.
- char*.recommendsites.caption
-
Name of the recommended button for \p[*].
- charsetbutton.caption
-
Name of the character code button.
- closeballoonbutton.caption
-
Name of the hide balloons button.
- closebutton.caption
-
Name of the close button.
- collisionvisiblebutton.caption
-
Name of the head/face/chest collision display button.
- configurationbutton.caption
-
Name of the configuration button.
- configurationrootbutton.caption
-
Name of the configuration button.
- debugballoonbutton.caption
-
Name of the balloon marker display button.
- definedsurfaceonlybutton.caption
-
Name of the ignore undefined surfaces button.
- dressuprootbutton.caption
-
Name of the dressup button.
- duibutton.caption
-
Name of the development interface button.
- enableballoonmovebutton.caption
-
Name of the balloon move button.
- firststaffbutton.caption
-
Name of the version information button.
- ghostexplorerbutton.caption
-
Name of the ghost explorer button.
- ghosthistorybutton.caption
-
Name of the change to (recently used) ghost button.
- ghostinstallbutton.caption
-
Name of the ghost installation button.
- ghostrootbutton.caption
-
Name of the change to ghost button.
- headlinesensehistorybutton.caption
-
Name of the (recently used) headline button.
- headlinesenserootbutton.caption
-
Name of the headline button.
- helpbutton.caption
-
Name of the help button.
- hidebutton.caption
-
Name of the iconify button.
- historyrootbutton.caption
-
Name of the recently used items button.
- inforootbutton.caption
-
Name of the information button.
- leavepassivebutton.caption
-
Name of the forcibly leave restricted modes button.
- messengerbutton.caption
-
Name of the SSP Messenger button.
- pluginhistorybutton.caption
-
Name of the (recently used) plugin button.
- pluginrootbutton.caption
-
Name of the plugin button.
- portalrootbutton.caption
-
Name of the portal button.
- purgeghostcachebutton.caption
-
Name of the purge ghost cache button.
- quitbutton.caption
-
Name of the quit all button.
- rateofuseballoonbutton.caption
-
Balloon - individual names.
- rateofusebutton.caption
-
NAme of the rate of use button.
- rateofuserootbutton.caption
-
Name of the utilization graph.
- rateofusetotalbutton.caption
-
Ghost - Name of the aggregate button.
- readmebutton.caption
-
Name of the about the character button.
- termsbutton.caption
-
Name of the character's terms of use button.
- recommendrootbutton.caption
-
Name of the recommended button.
- regionenabledbutton.caption
-
Name of the display without clipping region button.
- reloadinfobutton.caption
-
Name of the reload operation information button.
- resetballoonpositionbutton.caption
-
Name of the reset balloon position button.
- resettodefaultbutton.caption
-
Name of the restore default settings button.
- scriptlogbutton.caption
-
Name of the script log button.
- shellrootbutton.caption
-
Name of the change shell button.
- shellscaleotherbutton.caption
-
Name of the custom shell scaling button.
- shellscalerootbutton.caption
-
Name of the shell scaling button.
- sntpbutton.caption
-
Name of the clock adjustment button.
- switchactivatewhentalkbutton.caption
-
Name of the activate when talking button.
- switchactivatewhentalkexceptupdatebutton.caption
-
Name of the activate when talking except updating button.
- switchautobiffbutton.caption
-
Name of the automatic email check button.
- switchautoheadlinesensebutton.caption
-
Name of the automatic headline sense button.
- switchblacklistingbutton.caption
-
Name of the black list button.
- switchcompatiblemodebutton.caption
-
Name of the old specification support button.
- switchconsolealwaysvisiblebutton.caption
-
Name of the console always visible button.
- switchconsolevisiblebutton.caption
-
Name of the console invisible button.
- switchdeactivatebutton.caption
-
Name of the deactivate when done talking button.
- switchdontactivatebutton.caption
-
Name of the don't activate button.
- switchdontforcealignbutton.caption
-
Name of the ghost setting button.
- switchduivisiblebutton.caption
-
Name of the development interface button.
- switchforcealignfreebutton.caption
-
Name of the always allow free movement button.
- switchforcealignlimitbutton.caption
-
Name of the alignment limitation button.
- switchignoreserikomovebutton.caption
-
Name of the ignore SERIKO move button.
- switchlocalsstpbutton.caption
-
Name of the local SSTP button.
- switchmovetodefaultpositionbutton.caption
-
Name of the reset shell position button.
- switchproxybutton.caption
-
Name of the enable proxy server button.
- switchquietbutton.caption
-
Name of the mute sound button.
- switchreloadbutton.caption
-
Name of the ghost reload button.
- switchreloadtempghostbutton.caption
-
Name of the keep temporary ghost button.
- switchremotesstpbutton.caption
-
Name of the remote SSTP button.
- switchrootbutton.caption
-
Name of the switch button.
- switchtalkghostbutton.caption
-
Name of the button that leaves the timing of speaking up to the ghost.
- systeminfobutton.caption
-
Name of the system info output button.
- updatebutton.caption
-
Name of the network update button.
- updatefmobutton.caption
-
Name of the FMO cleanup/update button.
- updateplatformbutton.caption
-
Name of the baseware network update button.
- utilityrootbutton.caption
-
Name of the utility menu button.
- vanishbutton.caption
-
Name of the uninstall button.
- aistatebutton.caption
-
Name of the AI Graph button.
- dictationbutton.caption
-
Name of the speech recognition button.
- texttospeechbutton.caption
-
Name of the speech synthesis button.
Tooltip System
- tooltip
-
Obtaining tooltip content in the shell.
Notified when the mouse cursor hovers over a shell surface.
If there is a shell-side setting, that takes precedence.- Reference0
- X-coordinate of the mouse cursor (local coordinates)
- Reference1
- Y-coordinate of the mouse cursor (local coordinates)
- Reference2
- Always 0.
- Reference3
- 0 for the main character, 1 for the partner. In SSP/CROW, there are also 2 and beyond.
- Reference4
- The collision identifier name.
- Reference5
- Always 0.
- balloon_tooltip
-
Obtaining tooltip content for balloon choices.
Notified when the mouse cursor hovers over a choice.- Reference0
- Choice text (label).
- Reference1
- ID of choice.
- Reference*
- Extended information (the third and subsequent arguments in the \q tag).