Book Structure

Introduction

In L5RCM a book is a collection of XML files shipped along a JSON file called manifest.

The Manifest

The manifest file contains the information about the book itself and it looks like this:

{
  "id": "great_clan_pack",
  "display_name": "Great Clans",
  "authors": ["Daniele Simonetti", "Dziel Djenn"],
  "version": "1.5",
  "update-uri": "",
  "download-uri": "",
  "min-cm-version": "3.9"
}

At the time of writing the fields update-uri and download-uri are deprecated and only present for backward compatibility purposes.

id	A word, unique and lowercase identifier for the book; typically underscore _ is used instead of space.
display_name	The book title, can contain any letter and/or symbol
authors	A list of names
version	This book’s version, should be incremented every time the contents change
min-cm-version	The minimum L5RCM version needed to run this book; if unsure write the version you tested this book with

The Book content

The content can be organized on how many files as needed, however they must respect the L5RCM format as below

<?xml version="1.0" encoding="utf-8"?>
<L5RCM>
  <!-- book contents goes here -->
</L5RCM>

The file names are not important for the program but it’s good practice to name the file after its content ( e.g. clans.xml, schools.xml, etc…​ )

For further information on how to write the content, consult the XML tags sidebar