XML:SUBT: Difference between revisions

From OniGalore
Jump to navigation Jump to search
m (+cat)
m (linked to the Prompts and Speech pages so you can see the contents of the SUBT files)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==onisplit commands==
{{XML_File_Header | prev=StNA | type=SUBT | next=TRAC | name=Subtitle Array}}
:-extract:txt <target directory> <filenames> Rips all SUBT as .txt into target folder from source .dat or .oni
:-create:subt <target directory> <filename> Creates a SUBT .oni file in target folder from a .txt file
:: no asterisk (*) in the file name allowed


==General information==
* SUBT files are global, stored in level0_Final.dat.
* There are only these two files, the use of which is hardcoded, so you can't add other SUBT files:
** SUBTmessages.oni: [[Quotes/Prompts|Autoprompt lines]] looked up by [[XML:ONGS|ONGS]] and messages used for training the player in Chapters 0 and 1.
** SUBTsubtitles.oni: [[Quotes/Speech|Dialogue lines]] which appear when the corresponding sounds are played via the BSL commands "sound_dialog_play" and "sound_dialog_play_block".


==general information==
==OniSplit commands==
* SUBT files are stored inside Oni\Edition\GameDataFolder\level0_Final
-extract:txt <target directory> <SUBTfilename.oni>
* You can't use other files, only these two:
Rips a SUBT as .txt into the target folder from source .dat or .oni.
** SUBTmessages.oni (contains some autoprompt lines for [[OBD_talk:ONGS#XML|ONGS]])
** SUBTsubtitles.oni
*** Subtitles show up when corresponding sounds get played via bsl command "sound_dialog_play", "sound_dialog_play_block", and "sound_dialog_play_interrupt"


-create:subt <target directory> <SUBTfilename.txt>
Creates a SUBT .oni file in the target folder from a .txt file.


==BSL support: messages==
==Displaying messages==
{|
{|
{{table}}
{{table}}
!width=33%|command
!width=33%|Command
!width=33%|description
!width=33%|Description
!width=34% colspan=2|example
!width=34% colspan=2|Example
|-
|-
| message keyword [time]
| message keyword [time]
| sends a message from the subtitle file
| Sends a message from the subtitle file.
|colspan=2| message begin_fight 240
|colspan=2| message begin_fight 240
|-
|-
| message_remove [keyword]
| message_remove [keyword]
| removes a currently displayed message
| Removes a currently displayed message.
| width=17% |message_remove c01_50_23
| width=17% |message_remove c01_50_23
| width=17% |message_remove
| width=17% |message_remove
|-
|-
| ui_suppress_prompt
| ui_suppress_prompt
| suppresses UI prompting about new objectives or moves
| Suppresses UI prompts about new objectives or moves.
|colspan=2| ui_suppress_prompt = 1
|colspan=2| ui_suppress_prompt = 1
|}
|}


 
==File structure==
==file structure==
'''Each line has the following layout:'''
'''Each line has following element:'''
:''keyword''=''text''
: ''keyword''
: =
: ''text''
'''Example from SUBTmessages:'''
'''Example from SUBTmessages:'''
  xmouse=To change your orientation, [c.move the mouse].
  xmouse=To change your orientation, [c.move the mouse].
'''Optional color formating, it starts with "[" and ends with "]":'''
'''Color formatting tokens, enclosed in "[ ]":'''
: b. (blue)
: b. (blue)
: c. (cyan)
: c. (cyan)
: g. (green)
: g. (green)
: l. (lila)
: l. (lavender)
: o. (orange)
: o. (orange)
: r. (red)
: r. (red)
Line 52: Line 50:
: y. (yellow)
: y. (yellow)


 
==Missing dialogue lines==
==missing dialogue lines==
Most of Shinatama's lines in the training level were never subtitled, so you won't find them in SUBTsubtitles. Iritscen transcribed those lines (00_01_35 through 00_01_90) from the audio on the [[Quotes/Speech#CHAPTER_00_._COMBAT_TRAINING|Chapter 0 section]] of the Quotes/Speech page.
Some of Shinatama's talk in the training level is [[Talk:Quotes/Speech|missing]]. Iritscen added those lines to the [[Quotes/Speech#CHAPTER_00_._COMBAT_TRAINING|Speech]] page.


[[Category:XML data docs]]
[[Category:XML data docs]]

Latest revision as of 15:49, 9 October 2023

SUBT : Subtitle Array
XML modding tips
  • See HERE to start learning about XML modding.
  • See HERE if you are searching for information on how to handle object coordinates.
  • See HERE for some typical modding errors and their causes.
 XML.png
XML

StNA << Other file types >> TRAC

switch to OBD page

General information

  • SUBT files are global, stored in level0_Final.dat.
  • There are only these two files, the use of which is hardcoded, so you can't add other SUBT files:
    • SUBTmessages.oni: Autoprompt lines looked up by ONGS and messages used for training the player in Chapters 0 and 1.
    • SUBTsubtitles.oni: Dialogue lines which appear when the corresponding sounds are played via the BSL commands "sound_dialog_play" and "sound_dialog_play_block".

OniSplit commands

-extract:txt <target directory> <SUBTfilename.oni>

Rips a SUBT as .txt into the target folder from source .dat or .oni. 

-create:subt <target directory> <SUBTfilename.txt>

Creates a SUBT .oni file in the target folder from a .txt file.

Displaying messages

Command Description Example
message keyword [time] Sends a message from the subtitle file. message begin_fight 240
message_remove [keyword] Removes a currently displayed message. message_remove c01_50_23 message_remove
ui_suppress_prompt Suppresses UI prompts about new objectives or moves. ui_suppress_prompt = 1

File structure

Each line has the following layout:

keyword=text

Example from SUBTmessages: 

xmouse=To change your orientation, [c.move the mouse].

Color formatting tokens, enclosed in "[ ]":

b. (blue)
c. (cyan)
g. (green)
l. (lavender)
o. (orange)
r. (red)
u. (umber)
y. (yellow)

Missing dialogue lines

Most of Shinatama's lines in the training level were never subtitled, so you won't find them in SUBTsubtitles. Iritscen transcribed those lines (00_01_35 through 00_01_90) from the audio on the Chapter 0 section of the Quotes/Speech page.

Retrieved from "https://wiki.oni2.net/w/index.php?title=XML:SUBT&oldid=41215"