|
|
| (18 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| {{update}} | | {{XML Home}} |
| ==XML tutorial for Anniversary Edition==
| |
| This tutorial is written with the [[Anniversary Edition]] in mind, because it installs the modding tools you need, gives you the framework for making a mod package, and globalizes more data. Global data can be used in any level.
| |
|
| |
|
| ===What is XML, first of all?===
| | 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! |
| :[[wikipedia:XML|E'''X'''tensible '''M'''arkup '''L'''anguage]] is a plain-text file format designed to be both human-readable and machine-readable. It stores data in between tags, e.g. <tt><Data>Some data here.</Data></tt>, and these tags can be arranged in a hierarchy to keep things organized. The only difference between a normal text file and an XML file is that the file ends in .xml instead of .txt and that it typically begins with the string <tt><?xml version="1.0" encoding="UTF-8" ?></tt>. While you thus could easily make an XML file by hand in any text editor, there are programs listed below which are better suited for easy XML editing.
| |
|
| |
|
| ===Okay, so what is XML modding?===
| | : '''Open AEInstaller, then Vago''' |
| :In the old days, most of Oni's resources had to be edited by [[wikipedia:Hex editor|hex editor]]. Then [[User:Neo|Neo]], a fan and hacker, introduced XML exporting. This turns "binary data" -- raw Oni resource data -- into human-readable XML which allows much easier modding. You can then import your edited XML back into Oni's resource format with a simple command. The list of file types with XML support can be seen [[XML:File_types|HERE]]. | | :: 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. |
|
| |
|
| ===So I just export some data to XML and start editing?===
| | : '''Get Konoko's character file (ONCC) by splitting level0_Final.dat''' |
| :Not so fast! A lot of the data is not that self-explanatory even as XML; it simply can't be, when the game engine is so complex. That's what the XML namespace on this wiki is for: documenting the game data tag by tag according to what you'll be seeing in the XML files, but just as importantly, explaining ''what all that data does''. That's important, because the wiki's original game data documentation in the [[OBD]] namespace was written for hackers and is lacking in plain-English explanation. | | :: 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/. |
|
| |
|
| ===Okay, what do I need to get started?===
| | : '''Convert the .oni to XML''' |
| : [[OniSplit]] will be your main tool. [[xmlTools]] is also needed for making XML patch mods. Installing the [[AE]] is the recommended way to get these tools and a helpful framework installed. | | :: 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". |
|
| |
|
| ===I've got the AE installed. What now?===
| | : '''Edit the XML''' |
| : OniSplit cannot be opened by simply double-clicking it; it's a command-line tool. But you are lucky -- we now have a [[wikipedia:GUI|GUI]] for it. | | :: Click the blue folder icon again and go into "XML/ONI - XML". There should be a file called ONCCk4_L.xml now. |
| :: Mac user will want to get '''"[[AE:Anniversary_Edition_Tools|AETools]]"''' | | :: Open that file with a plain-text editor (in Windows, you should use Notepad, and TextEdit will work on the Mac). |
| ::: Install instructions are on same page.
| | :: Search for the <HasSupershield> tag and change its value from 0 to '''1'''. |
| :: 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]''' | | :: Save the file and close it. |
| ::: Unpack and put the executables into your "GameDataFolder" inside "edition" folder. | |
|
| |
|
| ===What kinds of mods can I make?===
| | : '''Convert the XML back to a .oni''' |
| : See [[XML:File_types|HERE]] again. It's an overview of the kinds of resources that allow XML editing. But note that some types can be more difficult to mod than other. | | :: 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. |
| : If you need some ideas look at this page: '''[[Modding_brainstorms|modding brainstorms]]'''. | | :: Drag-and-drop your XML file into the "Sources" section. Click "Convert". |
| : If you want to contribute AE: [[AE:Bug-fix_and_feature_requests|bug-fixes and feature requests]]. | | :: Click the blue folder icon again and go into "XML/XML - ONI". |
| :: Check also the [[Anniversary_Edition/To-do|AE's current To-Do page]] and maybe there are fields that need a modder. | | :: 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. |
|
| |
|
| ===Hmm, I want to modify the files in Chapter ''X''. But what level file is that?===
| | [[Image:HasSupershield_1.png|thumb|200px|right|For more information on the supershield flag, see [[Supershield]].]] |
| :Check out [[GDF|this overview]] of Oni's game files. | | : '''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". |
|
| |
|
| ===Is there an easy exercise to get me started?===
| | : '''Test your mod''' |
| : Just see at the following table. Read left side if you use a Macintosh PC, read right side if you use a Windows PC. | | :: 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. |
| {| class="wikitable" width="100%"
| | :: Load Oni's level "TCTF Regional HQ (redux)" (the next-to-last level). |
| !colspan=2|Mac:
| | :: 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. |
| !colspan=2|PC:
| |
| |-
| |
| !colspan=4|converting an ONI file into an XML file
| |
| |-
| |
| | |
| | |
| |valign="top"|Open Edition's AETools_Data folder and create a new folder named "ONIfiles".
| |
| | |
| | |
| 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".
| |
| |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]
| |
| |valign="top"|Open Edition's GameDataFolder and create two new folders named "XML" and "ONI".
| |
| | |
| | |
| 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]
| |
| |}
| |
| | |
| ==Important tips for working with XML files==
| |
| * '''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 good use of the search function) is actually enough to work with Oni's XML. But big files might be easier to handle with what programmers call "code folding". Code folding is found in [[wikipedia:IDE|IDEs]] like [http://www.microsoft.com/express/download/ Microsoft Visual Studio] (Windows) and [http://developer.apple.com/technology/Xcode.html Xcode] (Mac). Both are free.
| |
| : This allows you to fold whole instances and parent tags. Folded code can be previewed in Microsoft Visual Studio 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 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]] |
