XML:XML Modding Lessons - Revision history

Iritscen: added tutorial that I stumbled across and moved to a better location; link fix

2025-05-09T19:13:55Z

added tutorial that I stumbled across and moved to a better location; link fix

← Older revision		Revision as of 19:13, 9 May 2025
Line 44:		Line 44:
	*[[Creating a level]]		*[[Creating a level]]
	*[[Modifying an existing level]]		*[[Modifying an existing level]]
	*[[Adding spawnable characters\|Adding spawnable characters to a level]]		*[[XML:Adding spawnable characters\|Adding spawnable characters to a level]]
			*[[XML:Changing a character's moveset\|Changing a character's moveset]]
	*[[XML:Adding Daodan powers to a character\|Adding Daodan powers to a character]]		*[[XML:Adding Daodan powers to a character\|Adding Daodan powers to a character]]
	*[[XML:TRAM#Color trails\|Adding colored contrails to combat moves]]		*[[XML:TRAM#Color trails\|Adding colored contrails to combat moves]]

	{{XML}}		{{XML}}

Iritscen: link tweaks

2025-03-12T01:48:09Z

link tweaks

Iritscen: link fix

2023-11-09T19:17:07Z

link fix

← Older revision		Revision as of 19:17, 9 November 2023
Line 1:		Line 1:
	[[Image:XML.png\|right]]		[[Image:XML.png\|right]]
	{{Hatnote\|This article builds on ~~the~~ general introduction to modding ~~found at [[Modding Oni~~]].}}		{{Hatnote\|This article builds on [[Introduction to modding\|this general introduction to modding]].}}
	The '''XML''' namespace is devoted to explaining Oni's data types in plainer language than the technical documentation at [[OBD]] and also provides tutorials in XML-based modding.		The '''XML''' namespace is devoted to explaining Oni's data types in plainer language than the technical documentation at [[OBD]] and also provides tutorials in XML-based modding.

Paradox-01 at 10:02, 2 November 2023

2023-11-02T10:02:18Z

← Older revision		Revision as of 10:02, 2 November 2023
Line 42:		Line 42:

	==Additional tutorials==		==Additional tutorials==
			*[[Creating a level]]
			*[[Modifying an existing level]]
	*[[Adding spawnable characters\|Adding spawnable characters to a level]]		*[[Adding spawnable characters\|Adding spawnable characters to a level]]
	*[[XML:Adding Daodan powers to a character\|Adding Daodan powers to a character]]		*[[XML:Adding Daodan powers to a character\|Adding Daodan powers to a character]]
	*[[XML:TRAM#Color_trails\|Adding colored contrails to combat moves]]		*[[XML:TRAM#Color_trails\|Adding colored contrails to combat moves]]
	*[[XML:ONLV\|Creating a level]]

	{{XML}}		{{XML}}

Iritscen: using hatnote template

2022-07-03T01:10:38Z

using hatnote template

← Older revision		Revision as of 01:10, 3 July 2022
Line 1:		Line 1:
	[[Image:XML.png\|right]]		[[Image:XML.png\|right]]
	~~:''~~This article builds on the general introduction to modding found at [[Modding Oni]].''		{{Hatnote\|This article builds on the general introduction to modding found at [[Modding Oni]].}}

	The '''XML''' namespace is devoted to explaining Oni's data types in plainer language than the technical documentation at [[OBD]] and also provides tutorials in XML-based modding.		The '''XML''' namespace is devoted to explaining Oni's data types in plainer language than the technical documentation at [[OBD]] and also provides tutorials in XML-based modding.

Paradox-01 at 20:08, 7 May 2022

2022-05-07T20:08:09Z

← Older revision		Revision as of 20:08, 7 May 2022
Line 13:		Line 13:
	[[Image:Visual Studio collapsed code.png\|thumb\|right\|Code folding in Visual Studio 2019.]]		[[Image:Visual Studio collapsed code.png\|thumb\|right\|Code folding in Visual Studio 2019.]]
	[[Image:Xcode collapsed code.png\|thumb\|right\|Xcode 12. If you don't see the code folding ribbon, see Preferences… > Text Editing > Display > Code folding ribbon.]]		[[Image:Xcode collapsed code.png\|thumb\|right\|Xcode 12. If you don't see the code folding ribbon, see Preferences… > Text Editing > Display > Code folding ribbon.]]
	[[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><nowiki><~~Data~~>Some data here</~~Data~~></nowiki></tt>, and these tags can be arranged in a hierarchy to keep things organized. The only technical difference between a normal text file and an XML file is that the file name ends in ".xml" instead of ".txt" and that it typically begins with the string <tt><?xml version="1.0" encoding="UTF-8" ?></tt>. You can thus edit an XML file in any text editor, such as Notepad in Windows and TextEdit on the Mac.		[[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><nowiki><TagName>Some data here</TagName></nowiki></tt>, and these tags can be arranged in a hierarchy to keep things organized. The only technical difference between a normal text file and an XML file is that the file name ends in ".xml" instead of ".txt" and that it typically begins with the string <tt><?xml version="1.0" encoding="UTF-8" ?></tt>. You can thus edit an XML file in any text editor, such as Notepad in Windows and TextEdit on the Mac.

	* '''See the tutorials''' below to learn how to extract game data as XML, modify it, and get it back into Oni.		* '''[[#Starter_tutorials\|See the tutorials]]''' below to learn how to extract game data as XML, modify it, and get it back into Oni.
	* '''Capitalization matters''': OniSplit is case-sensitive when it processes the XML.		* '''Capitalization matters''': OniSplit is case-sensitive when it processes the XML.
	* '''Text indentation''': Most tags have some indentation (tabs). It is not required by OniSplit but it helps one get an understanding of the hierarchy. Two examples:		* '''Text indentation''': Most tags have some indentation (tabs). It is not required by OniSplit but it helps one get an understanding of the hierarchy. Two examples:

Iritscen: restoring the Divhide around the "Working with XML files" section; moved up XML database to make it quicker to find and click on; wording

2021-10-28T20:09:45Z

restoring the Divhide around the "Working with XML files" section; moved up XML database to make it quicker to find and click on; wording

← Older revision		Revision as of 20:09, 28 October 2021
Line 5:		Line 5:

	==Introduction==		==Introduction==
	Oni's resources could be separated into one of two categories: media (such as models, textures and sounds), and non-media (such as character class data). Most of the non-media data can be exported to XML. This allows much easier modding than the hex-editing of the old days (compare the two methods [[~~Adding_spawnable_characters~~\|here]]). Some media resources can also be edited as "XML", referring to the fact that an XML file will be created alongside the media file when ~~it is~~ exported from the game data, and this XML companion file ~~contains~~ metadata about the media that allows [[OniSplit]] to re-import ~~the resource~~ properly when you are done editing it.		Oni's resources could be separated into one of two categories: media (such as models, textures and sounds), and non-media (such as character class data). Most of the non-media data can be exported to XML. This allows much easier modding than the hex-editing of the old days (compare the two methods [[Adding spawnable characters\|here]]). Some media resources can also be "edited as XML", referring to the fact that an XML file will be created alongside the media file(s) when the resources are exported from the game data, and this XML companion file will contain metadata about the media files that allows [[OniSplit]] to re-import them properly when you are done editing them.

	To learn what all the resource types do, and to see which types can be edited through XML, see the link to the database ~~at the bottom of the page~~. Though XML modding can generally be done with nothing more than OniSplit's command line interface and a text editor, the tutorials linked below are written with the [[Anniversary Edition]] in mind, because the AE provides modding tools (including a GUI for OniSplit)~~, gives you~~ a framework for testing your mod package, and globalizes more of Oni's data so it can be used in any level.		To learn what all the resource types do, and to see which types can be edited through XML, see the link to the database below. Though XML modding can generally be done with nothing more than OniSplit's command line interface and a text editor, the tutorials linked below are written with the [[Anniversary Edition]] in mind because the AE provides modding tools (including a GUI for OniSplit) and a framework for testing your mod package, and globalizes more of Oni's data so that it can be used in any level.

	==Working with XML files==		==Working with XML files==
			{{Divhide\|Beginners will find this useful}}
	[[Image:Visual Studio collapsed code.png\|thumb\|right\|Code folding in Visual Studio 2019.]]		[[Image:Visual Studio collapsed code.png\|thumb\|right\|Code folding in Visual Studio 2019.]]
	[[Image:Xcode collapsed code.png\|thumb\|right\|Xcode 12. If you don't see the code folding ribbon, see Preferences… > Text Editing > Display > Code folding ribbon.]]		[[Image:Xcode collapsed code.png\|thumb\|right\|Xcode 12. If you don't see the code folding ribbon, see Preferences… > Text Editing > Display > Code folding ribbon.]]
Line 31:		Line 32:

	* '''File comparison''': For comparing two versions of an XML file to find the changes, you can use [https://winmerge.org/ WinMerge] (Windows) or FileMerge (Mac, comes with Xcode). Note that if one of the two files has passed through Oni and been re-exported, the data may have been totally reordered and cannot be diff-gazed effectively.		* '''File comparison''': For comparing two versions of an XML file to find the changes, you can use [https://winmerge.org/ WinMerge] (Windows) or FileMerge (Mac, comes with Xcode). Note that if one of the two files has passed through Oni and been re-exported, the data may have been totally reordered and cannot be diff-gazed effectively.
			{{Divhide\|end}}
			==Knowledge database==
			*[[XML:File types\|XML resource type database]]

	==Starter tutorials==		==Starter tutorials==
Line 43:		Line 47:
	*[[XML:TRAM#Color_trails\|Adding colored contrails to combat moves]]		*[[XML:TRAM#Color_trails\|Adding colored contrails to combat moves]]
	*[[XML:ONLV\|Creating a level]]		*[[XML:ONLV\|Creating a level]]

	~~==Knowledge database==~~
	*[[XML:File types\|XML resource type database]]

	{{XML}}		{{XML}}

Iritscen: /* Additional tutorials */ link fix

2021-03-27T14:49:36Z

Additional tutorials: link fix

← Older revision		Revision as of 14:49, 27 March 2021
Line 40:		Line 40:
	==Additional tutorials==		==Additional tutorials==
	*[[Adding spawnable characters\|Adding spawnable characters to a level]]		*[[Adding spawnable characters\|Adding spawnable characters to a level]]
	*[[XML:Daodan\|Adding Daodan ~~particles~~ to a character]]		*[[XML:Adding Daodan powers to a character\|Adding Daodan powers to a character]]
	*[[XML:TRAM#Color_trails\|Adding colored contrails to combat moves]]		*[[XML:TRAM#Color_trails\|Adding colored contrails to combat moves]]
	*[[XML:ONLV\|Creating a level]]		*[[XML:ONLV\|Creating a level]]

Iritscen: wording tweaks, rearranged tutorial links

2021-03-27T14:42:17Z

wording tweaks, rearranged tutorial links

← Older revision		Revision as of 14:42, 27 March 2021
Line 2:		Line 2:
	:''This article builds on the general introduction to modding found at [[Modding Oni]].''		:''This article builds on the general introduction to modding found at [[Modding Oni]].''

	The '''XML''' namespace is devoted to explaining Oni's data types in plainer ~~English~~ than the technical documentation at [[OBD]], and provides tutorials in XML modding.		The '''XML''' namespace is devoted to explaining Oni's data types in plainer language than the technical documentation at [[OBD]] and also provides tutorials in XML-based modding.

	Oni's resources could be separated into one of two categories: media (such as textures and sounds), and non-media (such as character class data). Most of the non-media data can be exported to XML. This allows much easier modding than the hex-editing of the old days (compare the two methods [[Adding_spawnable_characters\|here]]). Some media resources can also be edited as "XML", referring to the fact that an XML file will be created alongside the ~~resource's image/sound~~ file when it is exported from the game data, and this XML companion file contains metadata about the media ~~resource~~ that allows [[OniSplit]] to re-import the resource when you are done editing it.		==Introduction==
			Oni's resources could be separated into one of two categories: media (such as models, textures and sounds), and non-media (such as character class data). Most of the non-media data can be exported to XML. This allows much easier modding than the hex-editing of the old days (compare the two methods [[Adding_spawnable_characters\|here]]). Some media resources can also be edited as "XML", referring to the fact that an XML file will be created alongside the media file when it is exported from the game data, and this XML companion file contains metadata about the media that allows [[OniSplit]] to re-import the resource properly when you are done editing it.

	To learn what the ~~different~~ resource types do, and to see which types can be edited through XML, see the database ~~link below~~. Though XML modding can generally be done with nothing more than OniSplit's command line interface and a text editor, the tutorials linked below are written with the [[Anniversary Edition]] in mind, because the AE provides modding tools (including a GUI for OniSplit), gives you a framework for testing your mod package, and globalizes more of Oni's data so it can be used in any level.		To learn what all the resource types do, and to see which types can be edited through XML, see the link to the database at the bottom of the page. Though XML modding can generally be done with nothing more than OniSplit's command line interface and a text editor, the tutorials linked below are written with the [[Anniversary Edition]] in mind, because the AE provides modding tools (including a GUI for OniSplit), gives you a framework for testing your mod package, and globalizes more of Oni's data so it can be used in any level.

	==Working with XML files==		==Working with XML files==
Line 29:		Line 30:
	* '''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 allows you to collapse tags in order to get a better sense of the overall file structure, and is found in [[wikipedia:IDE\|IDEs]] like [https://visualstudio.microsoft.com Microsoft Visual Studio] (Windows) and [https://developer.apple.com/xcode/ Xcode] (Mac). Both programs are 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 allows you to collapse tags in order to get a better sense of the overall file structure, and is found in [[wikipedia:IDE\|IDEs]] like [https://visualstudio.microsoft.com Microsoft Visual Studio] (Windows) and [https://developer.apple.com/xcode/ Xcode] (Mac). Both programs are free.

	* '''File comparison''': For comparing two versions of an XML file to find the changes, you can use [https://winmerge.org/ WinMerge] (Windows) or FileMerge (Mac, comes with Xcode). Note that if one ~~file~~ has passed through Oni, the data may have been totally reordered and cannot be diff-gazed effectively.		* '''File comparison''': For comparing two versions of an XML file to find the changes, you can use [https://winmerge.org/ WinMerge] (Windows) or FileMerge (Mac, comes with Xcode). Note that if one of the two files has passed through Oni and been re-exported, the data may have been totally reordered and cannot be diff-gazed effectively.

	==~~Hitting the learning curve~~==		==Starter tutorials==
	~~;Which resource types do what in the game?~~
	*[[XML:File types\|Database of Oni's resource types]]
	~~;How do I edit XML?~~
	*[[XML:Basic tutorial\|Basic tutorial]]		*[[XML:Basic tutorial\|Basic tutorial]]
	~~;How do I get my mod into the game?~~
	*[[Making a patch mod]]
	~~;How do I make more complex mods?~~
	*[[XML:Advanced tutorial\|Advanced tutorial]]		*[[XML:Advanced tutorial\|Advanced tutorial]]
			*[[Making a patch mod]] (read before expert tutorial)
	*[[XML:Expert tutorial\|Expert tutorial]]		*[[XML:Expert tutorial\|Expert tutorial]]

	==~~=Popular modding types requiring XML=~~==		==Additional tutorials==
	~~;How do I create levels?~~		*[[Adding spawnable characters\|Adding spawnable characters to a level]]
	* [[~~XML:ONLV]]~~		*[[XML:Daodan\|Adding Daodan particles to a character]]
	~~; How do I add~~ characters to a level?		*[[XML:TRAM#Color_trails\|Adding colored contrails to combat moves]]
	*[[~~Adding_spawnable_characters~~]]		*[[XML:ONLV\|Creating a level]]
	~~; How do I add Daodan~~ to ~~a character?~~
	* [[XML:~~Daodan~~]]		==Knowledge database==
	~~;How do I add contrails to character moves?~~		*[[XML:File types\|XML resource type database]]
	* [[XML:~~TRAM#Adding_colorful_trails~~]]

	{{XML}}		{{XML}}

Iritscen: wording tweaks and formatting tweaks

2021-03-19T23:10:49Z

wording tweaks and formatting tweaks

← Older revision		Revision as of 23:10, 19 March 2021
Line 6:		Line 6:
	Oni's resources could be separated into one of two categories: media (such as textures and sounds), and non-media (such as character class data). Most of the non-media data can be exported to XML. This allows much easier modding than the hex-editing of the old days (compare the two methods [[Adding_spawnable_characters\|here]]). Some media resources can also be edited as "XML", referring to the fact that an XML file will be created alongside the resource's image/sound file when it is exported from the game data, and this XML companion file contains metadata about the media resource that allows [[OniSplit]] to re-import the resource when you are done editing it.		Oni's resources could be separated into one of two categories: media (such as textures and sounds), and non-media (such as character class data). Most of the non-media data can be exported to XML. This allows much easier modding than the hex-editing of the old days (compare the two methods [[Adding_spawnable_characters\|here]]). Some media resources can also be edited as "XML", referring to the fact that an XML file will be created alongside the resource's image/sound file when it is exported from the game data, and this XML companion file contains metadata about the media resource that allows [[OniSplit]] to re-import the resource when you are done editing it.

	To learn what the different resource types do, and to see which types can be edited through XML, see the database link below. Though XML modding can generally be done with nothing more than OniSplit's command line interface and a text editor, the tutorials linked to below are written with the [[Anniversary Edition]] in mind, because the AE provides modding tools (including a GUI for OniSplit), gives you a framework for testing your mod package, and globalizes more of Oni's data so it can be used in any level.		To learn what the different resource types do, and to see which types can be edited through XML, see the database link below. Though XML modding can generally be done with nothing more than OniSplit's command line interface and a text editor, the tutorials linked below are written with the [[Anniversary Edition]] in mind, because the AE provides modding tools (including a GUI for OniSplit), gives you a framework for testing your mod package, and globalizes more of Oni's data so it can be used in any level.

	==Working with XML files==		==Working with XML files==
	[[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 technical 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>. You can thus edit an XML file in any text editor, such as Notepad in Windows and TextEdit on the Mac.		[[Image:Visual Studio collapsed code.png\|thumb\|right\|Code folding in Visual Studio 2019.]]
			[[Image:Xcode collapsed code.png\|thumb\|right\|Xcode 12. If you don't see the code folding ribbon, see Preferences… > Text Editing > Display > Code folding ribbon.]]
			[[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><nowiki><Data>Some data here</Data></nowiki></tt>, and these tags can be arranged in a hierarchy to keep things organized. The only technical difference between a normal text file and an XML file is that the file name ends in ".xml" instead of ".txt" and that it typically begins with the string <tt><?xml version="1.0" encoding="UTF-8" ?></tt>. You can thus edit an XML file in any text editor, such as Notepad in Windows and TextEdit on the Mac.

	* '''See the tutorials''' below to learn how to extract game data as XML, modify it, and get it back into Oni.		* '''See the tutorials''' below to learn how to extract game data as XML, modify it, and get it back into Oni.
	* '''Capitalization matters''': OniSplit is case-sensitive when it processes the XML.		* '''Capitalization matters''': OniSplit is case-sensitive when it processes the XML.
	* '''Text indentation''': ~~most~~ tags have some indentation (tabs). It is not ~~needed~~ by OniSplit but it helps one get an understanding of the hierarchy. ~~Example~~:		* '''Text indentation''': Most tags have some indentation (tabs). It is not required by OniSplit but it helps one get an understanding of the hierarchy. Two examples:
	~~good~~:
			Good:
	<Instance id="4" type="IGSA">		<Instance id="4" type="IGSA">
	<Strings>		<Strings>
Line 20:		Line 23:
	</Strings>		</Strings>
	</Instance>		</Instance>
	~~bad~~:
			Bad:
	<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 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 [https://visualstudio.microsoft.com Microsoft Visual Studio] (Windows) and [https://developer.apple.com/xcode/ Xcode] (Mac). Both are 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 allows you to collapse tags in order to get a better sense of the overall file structure, and is found in [[wikipedia:IDE\|IDEs]] like [https://visualstudio.microsoft.com Microsoft Visual Studio] (Windows) and [https://developer.apple.com/xcode/ Xcode] (Mac). Both programs 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.~~

	~~<gallery>~~
	~~Image:Visual_Studio_collapsed_code.png\|Visual Studio 2008~~
	~~Image:Xcode.png\|Xcode~~
	~~</gallery>~~

	~~Bonus hint: for comparing text files you can use [https://winmerge.org/ WinMerge]~~.

			* '''File comparison''': For comparing two versions of an XML file to find the changes, you can use [https://winmerge.org/ WinMerge] (Windows) or FileMerge (Mac, comes with Xcode). Note that if one file has passed through Oni, the data may have been totally reordered and cannot be diff-gazed effectively.

	==Hitting the learning curve==		==Hitting the learning curve==
	;~~What can I change~~ in the game?		;Which resource types do what in the game?
	*[[XML:File types\|Database of Oni's resource types]]		*[[XML:File types\|Database of Oni's resource types]]
	;How do I edit XML?		;How do I edit XML?
Line 41:		Line 38:
	;How do I get my mod into the game?		;How do I get my mod into the game?
	*[[Making a patch mod]]		*[[Making a patch mod]]
	;How do I do more complex mods?		;How do I make more complex mods?
	*[[XML:Advanced tutorial\|Advanced tutorial]]		*[[XML:Advanced tutorial\|Advanced tutorial]]
	*[[XML:Expert tutorial\|Expert tutorial]]		*[[XML:Expert tutorial\|Expert tutorial]]


	===Popular modding types requiring XML===		===Popular modding types requiring XML===
Line 55:		Line 51:
	;How do I add contrails to character moves?		;How do I add contrails to character moves?
	* [[XML:TRAM#Adding_colorful_trails]]		* [[XML:TRAM#Adding_colorful_trails]]



	{{XML}}		{{XML}}

← Older revision		Revision as of 14:49, 27 March 2021
Line 40:		Line 40:
	==Additional tutorials==		==Additional tutorials==
	*[[Adding spawnable characters\|Adding spawnable characters to a level]]		*[[Adding spawnable characters\|Adding spawnable characters to a level]]
	*[[XML:Daodan\|Adding Daodan ~~particles~~ to a character]]		*[[XML:Adding Daodan powers to a character\|Adding Daodan powers to a character]]
	*[[XML:TRAM#Color_trails\|Adding colored contrails to combat moves]]		*[[XML:TRAM#Color_trails\|Adding colored contrails to combat moves]]
	*[[XML:ONLV\|Creating a level]]		*[[XML:ONLV\|Creating a level]]

← Older revision		Revision as of 01:48, 12 March 2025
Line 6:		Line 6:
	Oni's resources could be separated into one of two categories: media (such as models, textures and sounds), and non-media (such as character class data). Most of the non-media data can be exported to XML. This allows much easier modding than the hex-editing of the old days (compare the two methods [[Adding spawnable characters\|here]]). Some media resources can also be "edited as XML", referring to the fact that an XML file will be created alongside the media file(s) when the resources are exported from the game data, and this XML companion file will contain metadata about the media files that allows [[OniSplit]] to re-import them properly when you are done editing them.		Oni's resources could be separated into one of two categories: media (such as models, textures and sounds), and non-media (such as character class data). Most of the non-media data can be exported to XML. This allows much easier modding than the hex-editing of the old days (compare the two methods [[Adding spawnable characters\|here]]). Some media resources can also be "edited as XML", referring to the fact that an XML file will be created alongside the media file(s) when the resources are exported from the game data, and this XML companion file will contain metadata about the media files that allows [[OniSplit]] to re-import them properly when you are done editing them.

	To learn what all the resource types do, and to see which types can be edited through XML, see the link ~~to the~~ database ~~below~~. Though XML modding can generally be done with nothing more than OniSplit's command line interface and a text editor, the tutorials linked below are written with the [[Anniversary Edition]] in mind because the AE provides modding tools (including a GUI for OniSplit) and a framework for testing your mod package, and globalizes more of Oni's data so that it can be used in any level.		To learn what all the resource types do, and to see which types can be edited through XML, see the link under {{SectionLink\|\|Knowledge database}}. Though XML modding can generally be done with nothing more than OniSplit's command line interface and a text editor, the tutorials linked below are written with the [[Anniversary Edition]] in mind because the AE provides modding tools (including a GUI for OniSplit) and a framework for testing your mod package, and globalizes more of Oni's data so that it can be used in any level.

	==Working with XML files==		==Working with XML files==
Line 12:		Line 12:
	[[Image:Visual Studio collapsed code.png\|thumb\|right\|Code folding in Visual Studio 2019.]]		[[Image:Visual Studio collapsed code.png\|thumb\|right\|Code folding in Visual Studio 2019.]]
	[[Image:Xcode collapsed code.png\|thumb\|right\|Xcode 12. If you don't see the code folding ribbon, see Preferences… > Text Editing > Display > Code folding ribbon.]]		[[Image:Xcode collapsed code.png\|thumb\|right\|Xcode 12. If you don't see the code folding ribbon, see Preferences… > Text Editing > Display > Code folding ribbon.]]
	[[~~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><nowiki><TagName>Some data here</TagName></nowiki></tt>, and these tags can be arranged in a hierarchy to keep things organized. The only technical difference between a normal text file and an XML file is that the file name ends in ".xml" instead of ".txt" and that it typically begins with the string <tt><?xml version="1.0" encoding="UTF-8" ?></tt>. You can thus edit an XML file in any text editor, such as Notepad in Windows and TextEdit on the Mac.		[[wp: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><nowiki><TagName>Some data here</TagName></nowiki></tt>, and these tags can be arranged in a hierarchy to keep things organized. The only technical difference between a normal text file and an XML file is that the file name ends in ".xml" instead of ".txt" and that it typically begins with the string <tt><?xml version="1.0" encoding="UTF-8" ?></tt>. You can thus edit an XML file in any text editor, such as Notepad in Windows and TextEdit on the Mac.

	* '''[[#~~Starter_tutorials~~\|See the tutorials]]''' below to learn how to extract game data as XML, modify it, and get it back into Oni.		* '''[[#Starter tutorials\|See the tutorials]]''' below to learn how to extract game data as XML, modify it, and get it back into Oni.
	* '''Capitalization matters''': OniSplit is case-sensitive when it processes the XML.		* '''Capitalization matters''': OniSplit is case-sensitive when it processes the XML.
	* '''Text indentation''': Most tags have some indentation (tabs). It is not required by OniSplit but it helps one get an understanding of the hierarchy. Two examples:		* '''Text indentation''': Most tags have some indentation (tabs). It is not required by OniSplit but it helps one get an understanding of the hierarchy. Two examples:
Line 28:		Line 28:
	<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 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 allows you to collapse tags in order to get a better sense of the overall file structure, and is found in [[~~wikipedia~~:IDE\|IDEs]] like [https://visualstudio.microsoft.com Microsoft Visual Studio] (Windows) and [https://developer.apple.com/xcode/ Xcode] (Mac). Both programs are 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 allows you to collapse tags in order to get a better sense of the overall file structure, and is found in [[wp:IDE\|IDEs]] like [https://visualstudio.microsoft.com Microsoft Visual Studio] (Windows) and [https://developer.apple.com/xcode/ Xcode] (Mac). Both programs are free.

	* '''File comparison''': For comparing two versions of an XML file to find the changes, you can use [https://winmerge.org/ WinMerge] (Windows) or FileMerge (Mac, comes with Xcode). Note that if one of the two files has passed through Oni and been re-exported, the data may have been totally reordered and cannot be diff-gazed effectively.		* '''File comparison''': For comparing two versions of an XML file to find the changes, you can use [https://winmerge.org/ WinMerge] (Windows) or FileMerge (Mac, comes with Xcode). Note that if one of the two files has passed through Oni and been re-exported, the data may have been totally reordered and cannot be diff-gazed effectively.
Line 46:		Line 46:
	*[[Adding spawnable characters\|Adding spawnable characters to a level]]		*[[Adding spawnable characters\|Adding spawnable characters to a level]]
	*[[XML:Adding Daodan powers to a character\|Adding Daodan powers to a character]]		*[[XML:Adding Daodan powers to a character\|Adding Daodan powers to a character]]
	*[[XML:TRAM#~~Color_trails~~\|Adding colored contrails to combat moves]]		*[[XML:TRAM#Color trails\|Adding colored contrails to combat moves]]

	{{XML}}		{{XML}}