Jump to content

XML:Basic tutorial: Difference between revisions

m
PC section updated (browsing + package creating)
m (fixing link to particle page, changing ONIE's dot to red: there're a few imgs but no docu)
m (PC section updated (browsing + package creating))
Line 1: Line 1:
==mini-tutorial for 2009-7 AE release==
==XML tutorial for 2009-7 AE release==
'''What is XML modding?'''
'''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]].
: Binary data becomes converted into more human-readable form which allows easier modding. All supported file types can be seen [[#supported_file_types|HERE]].
Line 20: Line 20:


'''Is there an easy exercise to get me started?'''
'''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.
: Just see at the following table. Read left side if you use a Macintosh PC, read right side if you use a Windows PC.




Line 27: Line 27:
!colspan=4|converting an ONI file into an XML file
!colspan=4|converting an ONI file into an XML file
|-
|-
|valign="top"|Update comes soon.Open AETools. Click on "Export" tab, select checkbox "Export as .xml file", then click on "Export .oni file" and chose "ONCCk4_L.oni". See "XMLfiles" in "AETools_Data". There you should find "ONCCk4_L.xml".
|valign="top"|Update comes soon enough. Open AETools. Click on "Export" tab, select checkbox "Export as .xml file", then click on "Export .oni file" and chose "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_1B.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_1B_TN.png]
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_1B.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_1B_TN.png]
|valign="top"|Open the GUI.<br>Chose "ONI - XML" tab.<br>Write "level0_Characters/ONCCk4_L.oni" into the first line.<br>"XML" into the other.<br>After clicking on "Convert" you should see a new folder named "ONI".
|valign="top"|Open Edition's GameDataFolder and create two new folders named "XML" and "ONI".
|[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_1B.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_1B_TN.png]
 
 
Run the GUI, chose "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 chose the XML folder as target.<br>Now click on Convert button.
|[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
!colspan=4|modifing the XML file
Line 47: Line 50:
|
|
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_3B.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_3B_TN.png]
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_3B.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_3B_TN.png]
|valign="top"|Goto GUI's "XML -> ONI" section and write "XML/ONCCk4_L.xml" into its first line and "ONI" into its second line. After clicking "Convert" you should see a new folder named "ONI".
|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 chose 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>
<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>
|
|
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_3B.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_3B_TN.png]
[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]


|-
|-
Line 94: Line 97:
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_6B.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_6B_TN.png]
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_6B.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_mac_6B_TN.png]
|valign="top"|
|valign="top"|
Download this [http://paradox.oni2.net/mods/package_barebone.zip package barebone.]
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 chose the ONI folder as source folder.
Browse Edition's install folder and chose the package folder as target.


Unzip the archive, follow the path "90000Test\oni\level0_Final\level0_Characters" and insert there your ONCC from "extracted" folder.


 
Open AEInstaller and select your test package. Hit "Install!" button.
Now put "90000Test" with all its content into AE's package folder. "Oni\Edition\install\packages"
|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]




'''Important note:''' you can see "Upgraded ONCCs" and "[Test]" being selected in the screen shot.
[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]
: Upgraded ONCCs' package folder is "21000UpgradedONCCs".
: Test's package folder is "90000Test".
: Both contain ONCCk4_L.oni but only the one in "90000Test" will be installed.
: The highest number rules.
 
 
Goto "Oni\Edition\install\packages\90000Test" and open "Mod_Info.cfg" with a simple text editor if you want to change your own mod's readme, displayed name and creator note. Look at the screen shot and you will understand where what goes.
 
 
See '''[http://oni.bungie.org/community/forum/viewtopic.php?id=1030 HERE]''' for detail information about package creation.
 
 
Open AEInstaller and select your test package. Hit "Install!" button.
|
[http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_4B.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_4B_TN.png]<br>http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_5B.png<br>[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
!colspan=4|testing the modification
Line 128: Line 124:
|}
|}


==mini-tutorial for pre-2009-7 AE release==
<!--
==XML tutorial for pre-2009-7 AE release==
'''What is XML modding?'''
'''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]].
: Binary data becomes converted into more human-readable form which allows easier modding. All supported file types can be seen [[#supported_file_types|HERE]].
Line 208: Line 205:
|[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]
|[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]
|}
|}
 
-->




Line 372: Line 369:
: Weapon page. That's the place where you can write descriptions page about a specific weapon.
: Weapon page. That's the place where you can write descriptions page about a specific weapon.
|}
|}


==working with XML files: good to know==
==working with XML files: good to know==
8,452

edits