Skip to content

XML Mod

Jump to bottom
Dan Gerendasy edited this page Feb 9, 2017 · 1 revision

Contents

What

An XML Mod is an XML file that contains data interpreted and applied by the Ty Mod Manager. If you're not familiar with XML you can find tutorials on the internet.

Installing

Most mods should include install notes with them. However, for more basic ones that isn't necessary.

To install, open your Mods folder by clicking the Folder icon on the bottom right of the Mod Manager. Place all XML files from the mod in the root of that directory. Place any other files in the root as well unless told otherwise.

Creating

Open your favorite text editor (please don't use notepad). I like Atom and Sublime Text. They're both free.

Create a new file in your editor and save it as an XML to your Mods folder. If you're unsure where this is, go ahead and open the Mod Manager and click the folder icon on the bottom right. Save to the directory that pops up.

  • When choosing a name for your XML file, please choose something unique (not mod.xml) so it doesn't replace a different mod.
  • All XML files must be placed within the Mods folder. They will not be read from any sub-directories.

Adding a tymod

After creating your XML file, we need to open it up and add a root element and a tymod element.

  • You may only have one root element in your XML mod, but you can have multiple tymod elements.
<root>
  <tymod>

  </tymod>
</root>

Defining your tymod

Next we must add attributes for a name, authors, a mod version, a ty version dependency, and a description.

<root>
  <tymod name="My Mod" authors="Me, Me, and Me" version="1.0.0" tyversion="[]" description="The bestest ever">

  </tymod>
</root>

Next Steps

That's a basic implementation. It doesn't do anything, and it won't show up in the manager until it does.

Now you can add Edit Elements to make your new mod actually do something.

Clone this wiki locally