isaac-xml-validator 1.2.0

A script to validate XML files for the game 'The Binding of Isaac: Repentance'

isaac-xml-validator

This repo contains:

• A collection of XSD files used to validate XML files for mods of the game The Binding of Isaac: Repentance. (They were generated with the online-xml-to-xsd-converter tool.) )
• A website that allows end-users to copy paste arbitrary XML data to validate it.
• A Python script which allows you to lint all the XML files in the repository for your mod.

Using the Website

You can view the website here.

Using the Python Script

The tool is published to PyPI, so you can install it via:

pip install isaac-xml-validator

Then, you can run it via:

isaac-xml-validator

By default, it will recursively scan for all XML files in the current working directory.

Usage in GitHub Actions

For most users, you will probably want to manually integrate the Python script into your existing lint routine. Alternatively, you can use a GitHub action that automatically invokes the script.

Add XSD as a validation Header

If you want to use the XSD files for external validation tools, for example as a live evaluation in VS Code with the "XML" extension by Red Hat, you can add the following line of code at the top of your .xml file:

<?xml-model href="https://wofsauge.github.io/isaac-xml-validator/xsd/[NAME OF THE FILE].xsd" ?>

Example for the "babies.xml" file:

<?xml-model href="https://wofsauge.github.io/isaac-xml-validator/xsd/babies.xsd" ?>
<babies root="gfx/Characters/Player2/">
	<baby id="0" name="Spider Baby" skin="000_Baby_Spider.png" />
	<baby id="1" name="Love Baby" skin="001_Baby_Love.pngz" />	<!-- evaluates as an error, because the "skin" attribute doesn't contain a .png file, but a .pngz-->
	<baby id="2" name="Bloat Baby" skin="002_Baby_Bloat.png" />
</babies>

Creating New XSD Files

If you need to create new XSD files, you can import our common XML schema like this:

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsisaac="https://wofsauge.github.io/isaac-xml-validator">
  <xs:import schemaLocation="https://wofsauge.github.io/isaac-xml-validator/isaacTypes.xsd" namespace="https://wofsauge.github.io/isaac-xml-validator" />
  <xs:element name="Test">
    <xs:complexType>
      <xs:attribute name="root" type="xsisaac:pngFile" />
    </xs:complexType>
  </xs:element>
</xs:schema>