OniGalore

XML:Basic tutorial: Difference between revisions

XML Discussion

XML:Basic tutorial (view source)

Revision as of 18:15, 20 July 2009

7,175 bytes added ,  20 July 2009
m
Mac update follows by tomorrow at the latest
m (..)
m (Mac update follows by tomorrow at the latest)
Line 1: Line 1:
=XML modding: getting started=
==mini-tutorial for 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://drop.io/demos_kratos/asset/0-6-rar OniSplit GUI v0.6]"'''
::: Unpack and put the executables into your "GameDataFolder" inside "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"|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".-->
|<!--[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.<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".
|[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]
|-
!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_2B.png http://i305.photobucket.com/albums/nn207/unknownfuture/Oni_Galore_Images/XML_modding/XML_tutorial_2B_TN.png]
|-
!colspan=4|creating, <font color="#999999">debugging,</font> and transporting the file
|-
|valign="top"|<!--
 
 
<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"|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".
 
 
<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]
 
|-
!colspan=4|creating and installing a mod package
|-
|valign="top"|
 
|
 
|valign="top"|
Download this [http://paradox.oni2.net/mods/package_barebone.zip package barebone.]
 
 
Unzip the archive, follow the path "90000Test\oni\level0_Final\level0_Characters" and insert there your ONCC from "extracted" folder.
 
 
Now put "90000Test" with all its content into AE's package folder. "Oni\Edition\install\packages"
 
 
'''Important note:''' you can see "Upgraded ONCCs" and "[Test]" being selected in the screen shot.
: 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
|-
|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]
|}
 
 
 
 
==mini-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 12: Line 113:
:: Windows user will want to get '''"[http://drop.io/demos_kratos/asset/0-6-rar OniSplit GUI v0.6]"'''
:: Windows user will want to get '''"[http://drop.io/demos_kratos/asset/0-6-rar OniSplit GUI v0.6]"'''
::: Unpack and put the executables into your "edition" folder.
::: 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?'''
'''Is there an easy exercise to get me started?'''
Line 75: Line 182:




'''Okay. 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.




Paradox-01
8,452

edits

Retrieved from "https://wiki.oni2.net/Special:MobileDiff/15060"