XML:Basic tutorial: Difference between revisions

From OniGalore
Jump to navigation Jump to search
m (...)
m (better link for supershield details)
 
(50 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==XML tutorial for 2009-7 AE release==
{{XML Home}}
'''What is XML modding?'''
: Binary data becomes converted into more human-readable form which allows easier modding. All supported file types can be seen [[#supported_file_types|HERE]].


'''Okay, what do I need?'''
Here's a step-by-step guide to creating a mod through XML modding, using an ONCC modification as an example. It will give you a grasp of the usual tools and workflow. Let's roll!
: [[OniSplit]] will be your tool. It's part of [[AE]]. Installing AE spares you some work because it splits the level achieves right away and globalize some more data. Global data can be used in any level.


'''AE installed. What now?'''
: '''Open AEInstaller, then Vago'''
: OniSplit cannot be opened in a classic way. But you are lucky. Now we have a GUI (graphical user interface) for it.
:: Open the AEI and choose the menu item Tools > Vago GUI (first, Vago has to have been installed via Tools > Manage Tools).
:: Mac user will want to get '''"[[AE:Anniversary_Edition_Tools|AETools]]"'''
:: When Vago is opened for the first time, it will ask you to locate the AE installation on your hard drive.
::: Install instructions are on same page.
:: Windows user will want to get '''"[http://oni.bungie.org/community/forum/viewtopic.php?id=692 OniSplit GUI]"''' or '''[http://oni.bungie.org/community/forum/viewtopic.php?id=2385 Vago GUI]'''
::: Unpack and put the executables into your "GameDataFolder" inside "edition" folder.


'''What mod possibilities do I have?'''
: '''Get Konoko's character file (ONCC) by splitting level0_Final.dat'''
: See [[#supported_file_types|HERE]] again. It's an overview what you could do. But note that some types can be more difficult to mod than other.
:: In Vago, go to the "Levels" tab.
: If you need some ideas look at this page: '''[[Modding_brainstorms|modding brainstorms]]'''.
:: Drag and drop the file level0_Final.dat, found in the directory AE/AEInstaller/vanilla/, into the "Sources" section of the window. Click "Convert".
: If you want to contribute AE: [[AE:Bug-fix_and_feature_requests|bug-fixes and feature requests]].
:: At the top, click on the blue folder icon. The folder with Vago's converted files will appear. Go into Levels/DAT - ONI FILES/level0_Final/.
:: Check also [[Anniversary_Edition/Team#Current_To-Do|AE's current To-Do page]] and maybe there are fields that need a modder.


'''Is there an easy exercise to get me started?'''
: '''Convert the .oni to XML'''
: Just see at the following table. Read left side if you use a Macintosh PC, read right side if you use a Windows PC.
:: In the level0_Final/ folder, there will be a lot of files. You want ONCCk4_L.oni. This is the name of the file for the version of Konoko that appears in Chapter 13, as [[Konoko's outfits|documented here]].
:: Go to Vago's "XML" tab and drag-and-drop ONCCk4_L.oni into the "Sources" section. Click "Convert".


: '''Edit the XML'''
:: Click the blue folder icon again and go into "XML/ONI - XML". There should be a file called ONCCk4_L.xml now.
:: Open that file with a plain-text editor (in Windows, you should use Notepad, and TextEdit will work on the Mac).
:: Search for the <HasSupershield> tag and change its value from 0 to '''1'''.
:: Save the file and close it.


{|
: '''Convert the XML back to a .oni'''
{{table}}
:: Go to Vago's "XML" tab. In the "From:" popup menu, choose "XML", and the "To:" popup menu should have "ONI" supplied automatically by Vago.
!colspan=4|converting an ONI file into an XML file
:: Drag-and-drop your XML file into the "Sources" section. Click "Convert".
|-
:: Click the blue folder icon again and go into "XML/XML - ONI".
|valign="top"|Open Edition's AETools_Data folder and create a new folder named "ONIfiles".
:: Create a new folder on your hard drive, preferably outside of the VagoWorkspace folder, called "level0_Final", and put your new ONCCk4_L.oni file into it.


[[Image:HasSupershield_1.png|thumb|200px|right|For more information on the supershield flag, see [[Supershield]].]]
: '''Get the file back into Oni'''
:: The best way to test your mod is to make an [[Making_a_mod_package|AE package]]. Vago can help you do this: choose the menu item Tools > AEI Mod Package Wizard.
:: Fill in all the mandatory fields. Set the Type to "Character". When choosing a package number, follow the suggested numbering range that is auto-filled in Package Number, and click "Check" to see if it has already been used by another package. Hit "Continue" once you have decided on a package number.
:: Leave the optional fields blank. Hit "Continue".
:: Drag-and-drop your level0_Final folder into the "Common" section. Hit "Done".


Run AETools, choose "Extract" tab.<br>Click on checkbox "Expract as .xml file".<br>Then click on "Extract .oni file(s)" and choose "ONCCk4_L.oni".<br>See "XMLfiles" in "AETools_Data". There you should find "ONCCk4_L.xml".
: '''Test your mod'''
|valign="top"|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_1C.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_1C_TN.png]
:: Copy your package folder into AE/AEInstaller/packages/ in your Oni installation.
|valign="top"|Open Edition's GameDataFolder and create two new folders named "XML" and "ONI".
:: Open the AEI, locate your mod by looking under the "-Local-" category or by typing its name into the Filter, and install it.
 
:: Load Oni's level "TCTF Regional HQ (redux)" (the next-to-last level).
 
:: If you raise your health above 150% (301 HP), the supershield will switch on and you will be untouchable. The "chenille" cheat is a handy alternative to finding some hypos, and it will permanently turn on the supershield.
Run the GUI, choose "ONI - XML" tab and its upper section.<br>Click first browse button and search for "ONCCk4_L.oni" inside the level0_Characters folder.<br>Click second browse button and choose the XML folder as target.<br>Now click on Convert button.
|valign="top"|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_1C.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_1C_TN.png]
|-
!colspan=4|modifing the XML file
|-
|valign="top"|Open the extracted file with a simple text editor. Search for "HasSupershield" tag and set its value to "1". Save file.
|valign="top"|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_2C.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_2C_TN.png]
|valign="top"|Open the extracted file with a simple text editor. Search for "HasSupershield" tag and set its value to "1". Save file.
|valign="top"|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_2B.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_2B_TN.png]
|-
!colspan=4|creating the ONI file
|-
|valign="top"|Choose "Convert" tab.<br>Now click onto "Select File(s) for Conversion" button and mark "ONCCk4_L.xml". Click "Choose" button.<br>Then click "Select Destination Folder". Search for your ONIfiles folder, mark it, and click "Choose button."
 
 
<font color="#888888">Made a mistake when modified the XML file? The terminal window would appear now and telling you the trouble making line. Find the line in you XML file and fix it. Line number isn't always accurate. (It can shift - often by 1.) Then try again creating the file.</font>
|valign="top"|
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_3C.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_3C_TN.png]
|valign="top"|Goto "XML -> ONI" section.<br>Click first browse button and search for "ONCCk4_L.xml" inside the XML folder.<br>Click second browse button and choose the ONI folder as target.<br>Now click on Convert button.
 
 
<font color="#888888">Try [[#way_without_Windows_GUI:_local_called_CMD|THIS]] method if no oni file was created. Use then "onisplit -create ONI XML/ONCCk4_L'''.xml'''" and look for error messages. Find the line in you XML file and fix it. Line number isn't always accurate. (It can shift - often by 1). Then try again creating the file.</font>
|valign="top"|
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_3C.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_3C_TN.png]
 
|-
!colspan=4|creating and installing a mod package
|-
|valign="top"|
Choose "Package" tab.
The GUI is actually pretty much self-explaining.<br>Fill the editboxes with following:
:90000
:Test
:[Test]
:1
:That's a package to test new mods.
:''YourNameHere''
 
 
Then click "Create package" button and search for your ONIfiles folder. Mark it and click "Choose" button.
 
 
AEInstaller should automatically open now, select your test package. Hit "Install!" button.
|valign="top"|
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_4C.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_4C_TN.png]
 
 
 
 
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_5C.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_5C_TN.png]
|valign="top"|
Click on GUI's "AE Package" tab.<br>The GUI is actually pretty much self-explaining.<br>Fill the editboxes with following:
:90000
:Test
:[Test]
:1
:That's a package to test new mods.
:''YourNameHere''
 
Browse Edition's GameDataFolder and choose the ONI folder as source folder.
Browse Edition's install folder and choose the package folder as target.
 
 
Open AEInstaller and select your test package. Hit "Install!" button.
|valign="top"|
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_4C.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_4C_TN.png]
 
 
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_6B.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_6B_TN.png]
|-
!colspan=4|testing the modification
|-
|valign="top"|Let's test our modification. Therefore we start TCTF HQ redux (pre-last level). The supershield becomes automatically switched on at 51% overpower (301 healh points). "chenille" cheat works too.
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img6.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img6_TN.png]
|valign="top"|Let's test our modification. Therefore we start TCTF HQ redux (pre-last level).<br>The supershield becomes automatically switched on at 51% overpower (301 healh points). "chenille" cheat works too.
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img6.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img6_TN.png]
|}
 
<!--
==XML tutorial for pre-2009-7 AE release==
'''What is XML modding?'''
: Binary data becomes converted into more human-readable form which allows easier modding. All supported file types can be seen [[#supported_file_types|HERE]].
 
'''Okay, what do I need?'''
: [[OniSplit]] will be your tool. It's part of [[AE]]. Installing AE spares you some work because it splits the level achieves right away and globalize some more data. Global data can be used in any level.
 
'''AE installed. What now?'''
: OniSplit cannot be opened in a classic way. But you are lucky. Now we have a GUI (graphical user interface) for it.
:: Mac user will want to get '''"[http://edt.oni2.net/AETools/AEToolsBeta.zip AETools (Beta)]"'''
::: Unpack and put "AETool" and "AETools_Data" into your "edition" folder.
:: Windows user will want to get '''"[http://oni.bungie.org/community/forum/viewtopic.php?id=692 OniSplit GUI]"'''
::: Unpack and put the executables into your "edition" folder.
 
'''What mod possibilities do I have?'''
: See [[#supported_file_types|HERE]] again. It's an overview what you could do. But note that some types can be more difficult to mod than other.
: If you need some ideas look at this page: '''[[Modding_brainstorms|modding brainstorms]]'''.
: If you want to contribute AE: [[AE:Bug-fix_and_feature_requests|bug-fixes and feature requests]].
:: Check also [[Anniversary_Edition/Team#Current_To-Do|AE's current To-Do page]] and maybe there are fields that need a modder.
 
'''Is there an easy exercise to get me started?'''
: Just see at the following table. Read left side if you use a Macintosh, read right side if you use Windows.
 
 
{|
{{table}}
!colspan=4|converting an ONI file into an XML file
|-
|valign="top"|Open AETools. Click on "Export" tab, select checkbox "Export as .xml file", then click on "Export .oni file" and choose "ONCCk4_L.oni". See "XMLfiles" in "AETools_Data". There you should find "ONCCk4_L.xml".  
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_img1.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_img1_TN.png]
|valign="top"|Open the GUI. Choose "ONI - XML" tab. Write "GameDataFolder/level0_Final/ONCCk4_L.oni" into the first line. "extracted" into the other. After clicking on "Convert" you should see a new folder named "extracted".
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img1.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img1_TN.png]
|-
!colspan=4|modifing the XML file
|-
|valign="top"|Open the extracted file with a simple text editor. Search for "HasSupershield" tag and set its value to "1". Save file.
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_img2.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_img2_TN.png]
|valign="top"|Open the extracted file with a simple text editor. Search for "HasSupershield" tag and set its value to "1". Save file.
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img2.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img2_TN.png]
|-
!colspan=4|creating, <font color="#999999">debugging,</font> and transporting the file
|-
|valign="top"|Let's choose the "Import" tab now. Click on the first drop down menu in case there is not level0_Final already chosen. AETools will create the ONI file in that folder.
 
 
Now click on "Import source file" button. Navigate to your XML file, select it and click "Choose source" button.
 
 
<font color="#888888">Made a mistake when modified the XML file? The terminal window would appear now and telling you the trouble making line. Find the line in you XML file and fix it. Line number isn't always accurate. (It can shift - often by 1.) Then try again creating the file.</font>
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_img3.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_img3_TN.png]
 
 
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_img4.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_img4_TN.png]
|valign="top"|Goto GUI's "XML -> ONI" section and write "extracted/ONCCk4_L.xml" into its first line and "created" into its second line. After clicking "Convert" you should see a new folder named "created".
 
 
<font color="#888888">Try [[#way_without_Windows_GUI:_local_called_CMD|THIS]] method if no oni file was created. Use then "onisplit -create created extracted/ONCCk4_L'''.xml'''" and look for error messages. Find the line in you XML file and fix it. Line number isn't always accurate. (It can shift - often by 1). Then try again creating the file.</font>
 
 
Copy the file from "created" folder and insert it into the "level0_Final" folder which is located in the "GameDataFolder". Confirm the replacement.
 
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img3.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img3_TN.png]
 
 
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img4.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img4_TN.png]
|-
!colspan=4|recombining the level archive
|-
|valign="top"|Click on "Select Level to rebuild" and then "LEVEL 0: GLOBAL DATA".
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_img5.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_img5_TN.png]
|valign="top"|Let's choose the GUI's first tab now, "Compile". Write "GameDataFolder/level0_Final" into the first line, "level0_Final" into the second and "GameDataFolder" into the third line. Click now on "Compile" and wait until onisplit's black window disappears again.
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img5.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img5_TN.png]
|-
!colspan=4|testing the modification
|-
|valign="top"|Let's test our modification. Therefore we start TCTF HQ redux (pre-last level). The supershield becomes automatically switched on at 51% overpower (301 healh points). "chenille" cheat works too.
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img6.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img6_TN.png]
|valign="top"|Let's test our modification. Therefore we start TCTF HQ redux (pre-last level). The supershield becomes automatically switched on at 51% overpower (301 healh points). "chenille" cheat works too.
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img6.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_img6_TN.png]
|}
-->
 
==supported file types==
In which level is chapter X and its files I'm searching for stored? See [[GDF|HERE]].
 
XML documentation status:
:[[Image:Aqua Dot-Green.png]] : available
:[[Image:Aqua Dot-Yellow.png]] : incomplete
:[[Image:Aqua Dot-Red.png]] : not available, but that doesn't mean you cannot mod the file type
 
 
===OBJC===
{|class="wikitable" width="100%"
<!-- |'''[[OBD:AKEV|AKEV]]''' [[Image:Aqua Dot-Red.png]]
:Akira Environment. You can take a look into it but it's not recommended to tweak this by hand at all.
|- -->
|'''BINA/OBCJ/[[OBD_talk:BINA/OBJC/CHAR|CHAR]]''' [[Image:Aqua Dot-Yellow.png]]
: List of characters in a specific level. There you can setup their position, script name, weapon, ammunition, items, team, combat, melee id, etc..
|-
|'''BINA/OBCJ/[[OBD_talk:BINA/OBJC/CONS|CONS]]''' [[Image:Aqua Dot-Green.png]]
: List of consoles in a specific level. There you can setup their position, script name (Id), screen images, and script functions. Basically they are used to open doors.
|-
|'''BINA/OBCJ/[[OBD:BINA/OBJC/CMBT|CMBT]]''' [[Image:Aqua Dot-Red.png]]
: List of combat profiles for global use. There you can set AI's conditions for hand-to-hand, weapon combat, and retreat - in dependence of distances and enemy's counterattack.
|-
|'''BINA/OBCJ/[[OBD_talk:BINA/OBJC/DOOR|DOOR]]''' [[Image:Aqua Dot-Green.png]]
: List of doors in a specific level. There you write conditions when a door opens (or not), and what events are triggered by a character who come passes/comes near the door.
|-
|'''BINA/OBCJ/[[OBD_talk:BINA/OBJC/FLAG|FLAG]]''' [[Image:Aqua Dot-Green.png]]
: List of flags in a specific level. There you can setup their position. They are used by script commands and patrol paths.
|-
|'''BINA/OBCJ/[[OBD:BINA/OBJC/FURN|FURN]]''' [[Image:Aqua Dot-Red.png]]
: List of furniture in a specific level. This file type can be useful to import level objects.
|-
|'''BINA/OBCJ/[[OBD:BINA/OBJC/MELE|MELE]]''' [[Image:Aqua Dot-Red.png]]
: List of melee profiles for global use. It means how the AI use it's combat moves.
|-
|'''BINA/OBCJ/[[OBD_talk:BINA/OBJC/NEUT|NEUT]]''' [[Image:Aqua Dot-Green.png]]
: List of neutral behaviors in a specific level. Every character has melee, combat and netral behavior Id. It determines whether a non-player character (NPC) talks to you or not, this includes also rewards you could get from such characters.
|-
|'''BINA/OBCJ/[[OBD_talk:BINA/OBJC/PART|PART]]''' [[Image:Aqua Dot-Green.png]]
: List of particle in a specific level. There you can setup their position, script name and scaling.
|-
|'''BINA/OBCJ/[[OBD_talk:BINA/OBJC/PATR|PATR]]''' [[Image:Aqua Dot-Green.png]]
: List of patrol paths in a specific level. A patrol path has an Id which is used by CHAR and script command "ai2_dopath".
|-
|'''BINA/OBCJ/[[OBD_talk:BINA/OBJC/PWRU|PWRU]]''' [[Image:Aqua Dot-Green.png]]
: List of powerups (items, e.g. hyposprays) in a specific level which are spawned at level load. There you can setup their position.
|-
|'''BINA/OBCJ/[[OBD_talk:SNDD#BINACJBOSound.xml|SNDG]]''' [[Image:Aqua Dot-Yellow.png]]
: List of sound "groups" (spheres) in a specific level. It used to create sound spheres. Come near a machine and you might hear a sound, that's because of SNDG.
|-
|'''BINA/OBCJ/[[OBD_talk:BINA/OBJC/TRGV|TRGV]]''' [[Image:Aqua Dot-Green.png]]
: List of trigger volumes in a specific level. They are invisible areas which trigger script functions, this depends on character's team Id.
|-
|'''BINA/OBCJ/[[OBD_talk:BINA/OBJC/TRIG|TRIG]]''' [[Image:Aqua Dot-Green.png]]
: List of laser triggers in a specific level. There exist several forms and can trigger not only script functions.
|-
|'''BINA/OBCJ/[[OBD_talk:BINA/OBJC/TURR|TURR]]''' [[Image:Aqua Dot-Green.png]]
: List of turrets in a specific level. Not that their pods are part of the level geometry. Spawn one additional and it might be located somewhere in the air. Basicly you can setup their head's position, the weapon inside the turrent head, and the team Id which is the target.
|-
|'''BINA/OBCJ/[[OBD_talk:BINA/OBJC/WEAP|WEAP]]''' [[Image:Aqua Dot-Green.png]]
: List of weapons in a specific level which are spawned at level load. Actually only the position of them is set there.
|}
 
 
===Others===
{|class="wikitable" width="100%"
|'''BINA/[[OBD_talk:BINA/ONIE|ONIE]]''' [[Image:Aqua Dot-Yellow.png]]
: ONIE is a list of all impacts effects which can happen in the game. That includes weapon particle, hand-to-hand combat and movements. The impact effects depends on source type and the material which is hit.
|-
|'''BINA/[[OBD_talk:BINA/PAR3#XML_section|PAR3]]''' [[Image:Aqua Dot-Yellow.png]]
: 3D particle, also known as 3RAP and PART files. Particle are used as weapon's damage doer, decals and light effects.
|-
|'''BINA/[[OBD_talk:BINA/TMBD|TMBD]]''' [[Image:Aqua Dot-Green.png]]
: TMBD is a list of all materials in the game which groups texture map under them. That way environment gets materials which are used by ONIE.
|}
 
 
===Non-BINA===
{|class="wikitable" width="100%"
|'''[[OBD:CONS|CONS]]''' [[Image:Aqua Dot-Red.png]]
: Console. You can write there user's position and facing and also the screen images.
|-
|'''[[OBD_talk:DPge|DPge]]''' [[Image:Aqua Dot-Green.png]]
: Diary page. You what to write a page for a new level or alternative story then there you go.
|-
|'''[[OBD_talk:FILM|FILM]]''' [[Image:Aqua Dot-Green.png]]
: Movement record. Usually used for cutscenes. During that time of animation, AIs have no AI. ^_^
|-
|'''[[OBD:HPge|HPge]]''' [[Image:Aqua Dot-Red.png]]
: Help page.
|-
|'''[[OBD:IGHH|IGHH]]''' [[Image:Aqua Dot-Red.png]]
: In-game HUD. That's your health bar, compass, etc..
|-
|'''[[OBD_talk:IPge|IPge]]''' [[Image:Aqua Dot-Green.png]]
: Item page. If you have created a new item then there you can describe it, give warnings, whatever.
|-
|'''[[OBD_talk:Impt|Impt]]''' [[Image:Aqua Dot-Green.png]]
: Impact. This file is used to build up the hierarchy of impacts. See [[OBD_talk:BINA/ONIE|ONIE]] for more information.
|-
|'''[[OBD:M3GM|M3GM]]''' [[Image:Aqua Dot-Red.png]]
:Geometry. Some of these 3D objects are used by OBANs and PAR3 files.
|-
|'''[[OBD_talk:Mtrl|Mtrl]]''' [[Image:Aqua Dot-Green.png]]
: Material. This file is used to build up the hierarchy of materials. See [[OBD_talk:BINA/ONIE|ONIE]] for more information.
|-
|'''[[OBD_talk:OBAN|OBAN]]''' [[Image:Aqua Dot-Green.png]]
:Object Animation. Yes, used by objects but also for moving characters and cutsceen cams.
|-
|'''[[OBD_talk:ONCC|ONCC]]''' [[Image:Aqua Dot-Yellow.png]]
: Character class. It contains weapon skills, behavior Ids, view radius, jump power, sounds, 3D model (TRBS), animation collection (TRAC), textures (TRMA), and much more.
: The XML file contains also the character's body part material (CBPM), body part impacts (CBPI), and particles for animations (ONCP and ONIA).
|-
|'''[[OBD_talk:ONCV|ONCV]]''' [[Image:Aqua Dot-Green.png]]
: Character variant. 1) It's used to build up the hierarchy of randomness pools. Some characters with different appearance can form a pool for randomness. A flag in CHAR determinze if a character use one of these pools. 2) It can be also used to upgrade characters on difficult level hard - enabled by a flag in CHAR.
|-
|'''[[OBD_talk:ONGS|ONGS]]''' [[Image:Aqua Dot-Green.png]]
: Game settings. There you can modify the values of the health bar, hypospray strength, game difficult setting, at what distance item glow is displayed, and autoprompts (text message when picking up a new kind of item).
|-
|'''[[OBD_talk:ONLD|ONLD]]''' [[Image:Aqua Dot-Yellow.png]]
: Level descriptor. In other words it is the level name in the save game menu.
|-
|'''[[OBD_talk:ONLV|ONLV]]''' [[Image:Aqua Dot-Yellow.png]]
:Oni Game Level. Holds among other things: BSL folder name (<Name>), AKEV (Akira Environment) link, ONSK (Oni sky) link, and a link to AISA (AI Character Setup Array which is a bit obsolent because of [[OBD_talk:BINA/OBJC/CHAR|CHAR]]).
|-
|'''[[OBD:ONSK|ONSK]]''' [[Image:Aqua Dot-Red.png]]
: Sky. It's designed as a box so you will need five images: for top, north, east, south and west. The bottom has no image.
|-
|'''[[OBD_talk:ONVL|ONVL]]''' [[Image:Aqua Dot-Green.png]]
: Variant list of characters. It's used for randomize characters' appearance.
|-
|'''[[OBD_talk:ONWC|ONWC]]''' [[Image:Aqua Dot-Green.png]]
: Weapon class. Contains primary and secondary fire mode, more flags, particle, 3D model, and textures.
|-
|'''[[OBD_talk:OPge|OPge]]''' [[Image:Aqua Dot-Green.png]]
: Objective page. That's the place where you can write the objective for a new or modified level.
|-
|'''[[OBD_talk:SNDD#OSBD_information|OSBD]] [[Image:Aqua Dot-Yellow.png]]
:Oni Sound Binary Data. They determine how (SNDD) sound files get played.
|-
|'''[[OBD_talk:PSpc|PSpc]]''' [[Image:Aqua Dot-Green.png]]
: Part specification. Oni can decorate a page (OPge, TxtC, maybe other too) with images from one source. You write  coordinates there which means these parts.
|-
|'''[[OBD:PSpL|PSpL]]''' [[Image:Aqua Dot-Red.png]]
: Part specification list.
|-
|'''[[OBD:PSUI|PSUI]]''' [[Image:Aqua Dot-Red.png]]
: Part Specifications UI (User Interface).
|-
|'''[[OBD_talk:TRAC|TRAC]]''' [[Image:Aqua Dot-Green.png]]
: Animation collection. Every character can move and fight thanks to a collection.
|-
|'''[[OBD_talk:TRAM#list_of_tags.2C_types.2C_and_flags|TRAM]]''' [[Image:Aqua Dot-Yellow.png]]
: Animation. You can create new animations with Mod Tool. But for setting Oni-specific flags, links to particle and so on you need to edit the xml file afterwards or you create [http://oni.bungie.org/community/forum/viewtopic.php?pid=23230#p23230 precursor xml] before.
|-
|'''[[OBD_talk:TRBS|TRBS]]''' [[Image:Aqua Dot-Green.png]]
: Totoro Body Set, in other words the 3d model of a character. ONCC (character class) files links to TRBS. The 3d data itself will be exported/imported as dae files.
|-
|'''[[OBD_talk:TRGE|TRGE]]''' [[Image:Aqua Dot-Green.png]]
: Laser trigger emitter. This file type holds the 3D model and it's coordinates. Used by TRIG.
|-
|'''[[OBD_talk:TRMA#XML_area|TRMA]]''' [[Image:Aqua Dot-Green.png]]
: Character's texture map array. Every [[OBD:TRIA#Bones|body part]] is covered by textures. This file type holds links to those textures.
|-
|'''[[OBD:TRSC|TRSC]]''' [[Image:Aqua Dot-Red.png]]
:Screen (Aiming) Collection. Used for make characters aim with weapons.
|-
|'''[[OBD_talk:TXMB|TXMB]]''' [[Image:Aqua Dot-Green.png]]
: Big texture map. Only used for spalsh screens, you know .. these big Intro, WinLevel and LoseLevel images.
|-
|'''[[OBD_talk:TXMP#XML_section|TXMP]]''' [[Image:Aqua Dot-Green.png]]
: Texture map. Well, this type covers all images in Oni. (TXMB use multiple TXMPs to create a big texture.)
|-
|'''[[OBD_talk:TxtC|TxtC]]''' [[Image:Aqua Dot-Green.png]]
: Console text. Each time you access a console you get a text page. That's TxtC.
|-
|'''[[OBD:WMCL|WMCL]]''' [[Image:Aqua Dot-Red.png]]
: Window menu cursor list. Mouse pointer(s).
|-
|'''[[OBD_talk:WMDD|WMDD]]''' [[Image:Aqua Dot-Green.png]]
: Window Menu Dialog Data. It shapes pages like TxtC and WPge. However, new button functions would require engine modding.
|-
|'''[[OBD:WMM|WMM]]''' [[Image:Aqua Dot-Red.png]]
: Window menu menu.
|-
|'''[[OBD_talk:WPge|WPge]]''' [[Image:Aqua Dot-Green.png]]
: Weapon page. That's the place where you can write descriptions page about a specific weapon.
|}
 
 
==working with XML files: good to know==
* '''capitalization rules''' (use of capital and small initial letters): You need to care about it because also Onisplit does.
* '''text position in a line''': most tags have some distance towards line begin. It is not needed but preserve the overview.
* '''structure''': some tags have ''children''. Destroying the structure doesn't affect the reconversion but it is not good for the overview. Example:
good:
    <Instance id="4" type="IGSA">
        <Strings>
            <Link>#7</Link>
        </Strings>
    </Instance>
bad:
    <Instance id="4" type="IGSA"><Strings><Link>#7</Link></Strings></Instance>
 
* '''code folding''': A simple text editor (and being aware of the search function) is actually enough to work with Oni's xml. Anyway, big files might be easier to handle with code folding. So, if you like code folding, you maybe try [http://www.microsoft.com/express/download/ Microsoft Visual ... Express] (PC) or [http://developer.apple.com/technology/Xcode.html Xcode] (Mac). Both are for free.
: You can fold whole instances and parent tags.
:: Folded code can be previewed in Microsoft Visual Express applications. Xcode provides an extra scroll popup.
 
{|
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/collapse_code.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/collapse_code_preview.png]<br>Windows
|
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/hover_an_instance.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/hover_an_instance_preview.png]<br>Windows
|
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/code_folding.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/code_folding_preview.png]<br>Macintosh (xcode)
|}
 
 
==way without Windows GUI: window address bar==
{| border=0 cellspacing=20 cellpadding=0 align=right
| [http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/window_address_bar.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/window_address_bar_preview.png]
|}
Put the '''[[OniSplit|newest OniSplit.exe]]''' into the "edition\GameDataFolder" folder and use the window's address bar (that's where you can see the directory in full length).
 
Delete that address, type (for example) the code below, and hit enter.
 
onisplit -extract:xml xml_dir level0_Final/ONCCkonoko*.'''oni'''
 
The star is good for mess extraction/creation and good for shorten long unique file names. ("ONCCkonoko_generic" will be extracted in new folder "edition\GameDataFolder\xml_dir".)
 
 
It's also a good idea to keep the code in a temporary opened text file. There you can easily modify the code for other files and doesn't need you to type it from beginning into the address bar. (Be aware of Windows' short cut "CTRL + C" for coping marked text and "CTRL + V" for pasting text.)
 
==way without Mac GUI: the terminal==
Put the '''[[OniSplit|newest OniSplit.exe]]''' into the "Oni/GameDataFolder" folder.
 
Open the Terminal program then "change directory" to the GameDataFolder (Type "cd " then drag the GameDataFolder into the Terminal window, now press the RETURN key)
 
At this point you can enter the OniSplit commands, such as:
 
    mono onisplit.exe -extract:xml xml_dir level0_Final/ONCCkonoko*.oni
 
("ONCCkonoko_generic" will be extracted in new folder "GameDataFolder/xml_dir".)
 
 
==XML advanced tutorial==
Read on [[XML_advanced_tutorial|HERE]].


[[Category:Modding tutorials]]
[[Category:Modding tutorials]]

Latest revision as of 15:56, 9 May 2024

Click to return to the main XML page.

Here's a step-by-step guide to creating a mod through XML modding, using an ONCC modification as an example. It will give you a grasp of the usual tools and workflow. Let's roll!

Open AEInstaller, then Vago
Open the AEI and choose the menu item Tools > Vago GUI (first, Vago has to have been installed via Tools > Manage Tools).
When Vago is opened for the first time, it will ask you to locate the AE installation on your hard drive.
Get Konoko's character file (ONCC) by splitting level0_Final.dat
In Vago, go to the "Levels" tab.
Drag and drop the file level0_Final.dat, found in the directory AE/AEInstaller/vanilla/, into the "Sources" section of the window. Click "Convert".
At the top, click on the blue folder icon. The folder with Vago's converted files will appear. Go into Levels/DAT - ONI FILES/level0_Final/.
Convert the .oni to XML
In the level0_Final/ folder, there will be a lot of files. You want ONCCk4_L.oni. This is the name of the file for the version of Konoko that appears in Chapter 13, as documented here.
Go to Vago's "XML" tab and drag-and-drop ONCCk4_L.oni into the "Sources" section. Click "Convert".
Edit the XML
Click the blue folder icon again and go into "XML/ONI - XML". There should be a file called ONCCk4_L.xml now.
Open that file with a plain-text editor (in Windows, you should use Notepad, and TextEdit will work on the Mac).
Search for the <HasSupershield> tag and change its value from 0 to 1.
Save the file and close it.
Convert the XML back to a .oni
Go to Vago's "XML" tab. In the "From:" popup menu, choose "XML", and the "To:" popup menu should have "ONI" supplied automatically by Vago.
Drag-and-drop your XML file into the "Sources" section. Click "Convert".
Click the blue folder icon again and go into "XML/XML - ONI".
Create a new folder on your hard drive, preferably outside of the VagoWorkspace folder, called "level0_Final", and put your new ONCCk4_L.oni file into it.
For more information on the supershield flag, see Supershield.
Get the file back into Oni
The best way to test your mod is to make an AE package. Vago can help you do this: choose the menu item Tools > AEI Mod Package Wizard.
Fill in all the mandatory fields. Set the Type to "Character". When choosing a package number, follow the suggested numbering range that is auto-filled in Package Number, and click "Check" to see if it has already been used by another package. Hit "Continue" once you have decided on a package number.
Leave the optional fields blank. Hit "Continue".
Drag-and-drop your level0_Final folder into the "Common" section. Hit "Done".
Test your mod
Copy your package folder into AE/AEInstaller/packages/ in your Oni installation.
Open the AEI, locate your mod by looking under the "-Local-" category or by typing its name into the Filter, and install it.
Load Oni's level "TCTF Regional HQ (redux)" (the next-to-last level).
If you raise your health above 150% (301 HP), the supershield will switch on and you will be untouchable. The "chenille" cheat is a handy alternative to finding some hypos, and it will permanently turn on the supershield.
Retrieved from "https://wiki.oni2.net/w/index.php?title=XML:Basic_tutorial&oldid=42710"