Skip to content

Latest commit

 

History

History
75 lines (40 loc) · 4.41 KB

README.md

File metadata and controls

75 lines (40 loc) · 4.41 KB
Raw

Fight Club 5e XML

Creating XML files of all official D&D sources compatible with Fight Club 5e and Game Master 5e apps for iOS and Android.

How-to Use This Repository

The files listed in this repository as-is are not compatible with Fight Club 5e. They are instead a collection of individual source files that must be compiled together into a "compendium". That resulting compendium can then be imported into and used by Fight Club 5e.

This document makes a distinction between a compendium file and a collection file. A compendium file is what you ultimately import into Fight Club 5e; it is an XML file that contains all of the source data and is in a format that Fight Club 5e can process. A collection file is the raw source data that exists within this repository, and is not in a format that can be imported into Fight Club 5e. You must first compile a collection file into a compendium file.

This repository contains several collection files which can be found within the Collections folder. It's worth opening some of those files and noting the data found within them along with their basic structure. Each of those collection files contain entries that point to raw source data file found within the Sources folder.

Download and Extract the Repository to Your Computer

Click on the green "Code" button towards the top of the page, and then click on the "Download ZIP" button on the subsequent modal popup. Extract the ZIP archive to your Documents folder. On Windows, this will be C:\Users\YOUR_USER_NAME\Documents; on macOS, this will be /Users/YOUR_USER_NAME/Documents.

The location on your computer that you extract this repository to will be referred to as the repository root folder. The path to the repository root should be something like C:\Users\YOUR_USER_NAME\Documents\FightClub5eXML-main or /Users/YOUR_USER_NAME/Documents/FightClub5eXML-main.

Install xsltproc

You will need to install the xsltproc program in order to compile a collection into a compendium.

Windows

  1. Install chocolatey by following the official instructions.
  2. Open up PowerShell with administrative privileges, and execute the following: choco install xsltproc.

macOS

  1. Install homebrew by following the official instructions.
  2. Open up Terminal and install libxslt: brew install libxslt.

Linux

You should be able to use your distro's official package manager to install either xsltproc or libxslt if xsltproc isn't available as a standalone package.

Compile a Collection Into a Compendium

Open a command-line terminal (such as PowerShell on Windows or Terminal on macOS) and navigate to the repository root. You can do so by executing cd C:\Users\YOUR_USER_NAME\Documents\FightClub5eXML-main on Windows, or cd /Users/YOUR_USER_NAME/Documents/FightClub5eXML-main on macOS.

Next, execute the xsltproc program to compile a collection file into a compendium file. For example, if you wanted to compile the CoreOnly.xml collection, you would execute the following command:

xsltproc -o Compendiums/CoreOnly.xml Utilities/merge.xslt Collections/CoreOnly.xml

After that command has completed, you should see a file called Compendium.xml in the newly created Compendiums folder. You can then download that file onto your smartphone and import it into Fight Club 5e.

Batching

The build-collection files are provided for your convenience to compile all collections within your Collections directory into compendiums.

Custom Content

See the Sources README to learn how to add your own homebrew content or build your own compendium from select source material.

Contributing

If you'd like to contribute, feel free to fork the repository and submit pull requests with your changes. We are no longer accepting manual changes to the XML source files because these files are now generated from an external source.

Additional Contributors

@kinkofer for XML generation systems to allow github collections to be auto generated.

@felix_mil_ for XML creation tools https://felixmil.shinyapps.io/compendiumbuildr/.

@rrgeorge and zamrod for their JSON to XML scripts.

@MrFarland for Artificer Infusions and other XML.

@fightclub5exml and @dragonahcas for carrying the mantle.

@zcdziura for answering user's questions.

@sheppe for the Widows bat file.