IN PROGRESS. SO FAR:
XML Writing Guide
=================
XML files are used by Riivolution to load patch files and create the settings screens when first loading Riivolution. The most basic XML files specify a folder where mods are located, but they can be quite extensive too, allowing you to change multiple options and choose from a variety of different mods.
This guide will help you write and edit your own XML files (it’s also a refresher for me while so I can write an XML generator). The will allow you to improve the level of customisation when using mods – which is particularly useful if you want to release a mod pack, like the ones on this site.
The Basics
First, get Notepad++. It highlights syntax (colour codes various parts of the XML) and wil be invaluable in your creation of XML files.
Next, download the XML file. Open it with Notepad++ and you’ll follow this guide quite easily.
XML files follow a heirarchical structure, which means elements are nested within each other:
The ‘options’ element is nested within the ‘wiidisc’ element. Parent elements nest children/child elements. Parents are started like this:
And ended like this:
Some elements don’t nest others, and close themselves:
The overall structure of a Riivolution XML looks like this:
What Does Al That MEan?
This uide will talk you through what each element in the structure does, before moving on to he attiributes (which tell Riivolution what to do).
First, we declare the beginning of the XML with
Each
Each single
The final child here, a child of the parent
Each parent element needs to be closed when it’s done with, so when you’ve finished a section use
, and when you’ve finished setting up the UI for all your options, use
That’s the Riivolution menu handled. So now we want to apply some patches. We start with the opening
TO BE CONTINUED…
Attributes and Values
Each element can have attributes. Attributes give extra information to XML elements, and while elements tell Riivolution about the structure of your XML, attributes tell it what to actually do.
Attributes have values. In HTML, a checkbox has the attribute “checked”, and the value can be “checked” or “unchecked”. Riivolutions XMLs have a number of different values for each attribute. They’ll be explained in more detail below.
Below is an explanation of what each part (element) does.
