Jump to content

XML:Basic tutorial: Difference between revisions

XML:Basic tutorial (view source)

Revision as of 18:39, 12 April 2013

41 bytes added ,  12 April 2013
m
trying out level 3 headers for FAQ, it worked well for my polylectiloquy; touching up code folding tips (I kind of like this part, honestly, let's keep it)
(deleting Windows address bar info per Paradox and moving "Supported file types" section to XML:File types to match OBD:File types and because this page is too long as-is)
m (trying out level 3 headers for FAQ, it worked well for my polylectiloquy; touching up code folding tips (I kind of like this part, honestly, let's keep it))
Line 3: Line 3:
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.
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?'''
===What is XML, first of all?===
:[[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.
:[[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?'''
===Okay, so what is XML modding?===
: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 [[#supported_file_types|HERE]].
: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]].


'''So I just export some data to XML and start editing. Got it.'''
===So I just export some data to XML and start editing?===
:Not so fast! A lot of the data is not that self-explanatory; 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.
: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.


'''Okay, what do I need to get started?'''
===Okay, what do I need to get started?===
: [[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.
: [[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.


'''I've got the AE installed. What now?'''
===I've got the AE installed. What now?===
: 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.
: 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.
:: Mac user will want to get '''"[[AE:Anniversary_Edition_Tools|AETools]]"'''
:: Mac user will want to get '''"[[AE:Anniversary_Edition_Tools|AETools]]"'''
Line 22: Line 22:
::: Unpack and put the executables into your "GameDataFolder" inside "edition" folder.
::: Unpack and put the executables into your "GameDataFolder" inside "edition" folder.


'''What kinds of mods can I make?'''
===What kinds of mods can I make?===
: See [[#supported_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.
: 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.
: If you need some ideas look at this page: '''[[Modding_brainstorms|modding brainstorms]]'''.
: 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]].
: If you want to contribute AE: [[AE:Bug-fix_and_feature_requests|bug-fixes and feature requests]].
:: Check also the [[Anniversary_Edition/To-do|AE's current To-Do page]] and maybe there are fields that need a modder.
:: Check also the [[Anniversary_Edition/To-do|AE's current To-Do page]] and maybe there are fields that need a modder.


'''Hmm, I want to modify the files in Chapter ''X''. But what level file is that?"
===Hmm, I want to modify the files in Chapter ''X''. But what level file is that?===
:Check out [[GDF|this overview]] of Oni's game files.
:Check out [[GDF|this overview]] of Oni's game files.


'''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 PC, read right side if you use a Windows PC.
: 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 128: Line 128:
|}
|}


==working with XML files: good to know==
==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.
* '''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.
* '''text position in a line''': most tags have some distance towards line begin. It is not needed but preserve the overview.
Line 141: Line 141:
     <Instance id="4" type="IGSA"><Strings><Link>#7</Link></Strings></Instance>
     <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.
* '''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.
: You can fold whole instances and parent tags.
: 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.
:: Folded code can be previewed in Microsoft Visual Express applications. Xcode provides an extra scroll popup.


{|
{|
Retrieved from "https://wiki.oni2.net/Special:MobileDiff/21849"