DOCSEARCHbyAlgolia
Submit Docs

Fight Club 5e XML

repository·master·Indexed 41 days ago

https://github.com/vidalvanbergen/fightclub5exml

A repository of raw XML source data for D&D 5e and 5.5e content, designed to be compiled into compendiums for apps like Fight Club 5e, Game Master 5e, and Character Craft 5.5e. Includes core rulebooks, SRD 5.0, official WotC content, and homebrew. Provides tools for compilation via xsltproc, validation using collection.xsd and compendium.xsd, and standardized character note templates for import.

Tokens
10.7K
Snippets
33
Records
47
Agent score
53%

What's inside Fight Club 5e XML

  2. Select a Complete Compendium collection

    master

    The repository provides several pre-merged collections depending on the version of D&D rules you are using:

    • Complete_Compendium_5e: Includes all 5e-compatible rulebooks, third-party supplements, adventures, partnered content, Unearthed Arcana, Indie, and homebrew material.
    • Complete_Compendium_5.5e: Includes all 5.5e-compatible rulebooks, Unearthed Arcana, legacy content updated from 5e sourcebooks, and homebrew material.
    • Complete_Compendium_5e+5.5e: A merged collection of both 5e and 5.5e. New material is tagged with [5e].
      • Note: This merged version does not include 5e converted legacy content. For legacy content, it is recommended to import the 5e and 5.5e compendiums separately.

  3. Select Core Content or SRD collections

    master

    If you do not need a full compendium, you can select smaller, focused collections:

    Core Content

    • Core_Rulebooks_5e: 5e editions of Player's Handbook, Dungeon Master's Guide, and Monster Manual.
    • Core_Rulebooks_5.5e: 5.5e editions of Player's Handbook, Dungeon Master's Guide, and Monster Manual.
    • Core_Supplements_5e: Includes 5e Core Rulebooks, Xanathar's Guide to Everything, and Tasha's Cauldron of Everything.

    System Reference Document (SRD)

    Provides the base game rules for third-party use:

    • System_Reference_Document_5e
    • System_Reference_Document_5.5e

    Official Wizards of the Coast (WotC) Only

    Includes only core books and official supplements:

    • WotC_5e_Only
    • WotC_5.5e_Only

    Adventurers League

    Approved source books for DALL:

    • Special_Adventurers_League_Forgotten_Realms_5e
    • Special_Adventurers_League_Forgotten_Realms_5.5e

  4. Use Conjure Creature lists for summoning spells

    master
    Because Fight Club 5e lacks advanced filtering (like searching the bestiary by CR or Type), the Conjure Creatures folder provides pre-made lists. These files list all valid creatures for various summoning spells, making it easier to identify which creatures meet specific CR requirements (e.g., finding all beasts that are CR 2 or less for a Conjure Animals spell).

  5. XML Syntax and Content Rules for Fight Club 5e

    master

    When creating XML files for the FightClub5e app, follow these syntax and content rules:

    XML Elements

    • Standard Element: <name>Value</name>
    • Self-closing Element: <spells/> (useful for empty placeholders or line breaks).
    • Line Breaks: Use <text /> to insert a new paragraph or leave a line out in descriptions.

    Content Types

    • ABC (Text): Any text. CRITICAL: You must escape special characters:
      • & becomes &amp;
      • < becomes &lt;
      • > becomes &gt;
    • ### (Numbers): Use unformatted numbers. Remove commas. Use dots (.) for decimals.
    • D20 (Dice Rolls): Use the format xdx+y (e.g., 1d10+5). Use d for dice. Do not include whitespace. Operators + and - are allowed.
    • | (Selection): Denotes a choice from a specific list of values.
    • Comma (Multiple Values): Used when an element accepts multiple strings (e.g., <classes>Fighter, Wizard</classes>).

  6. Understand Skill Remapping in Star Wars 5e

    master

    Because Fight Club 5 does not allow renaming standard 5e skills, the Star Wars 5e system uses remapped skills to maintain mechanical accuracy. When reading documentation or features, look for the converted skill in parentheses.

    Skill Mapping Table:

    SW5e SkillFight Club 5 Skill (Mapped To)
    HistoryLore
    ArcanaTechnology
    ReligionPiloting

    Example notation in the XML/docs: Lore* (History).

  7. Use Force and Tech Powers in Fight Club 5

    master

    Force and Tech powers are implemented as powers within the XML.

    Key behaviors:

    • Naming Convention: To avoid conflicts with standard 5e powers (e.g., Acid Splash), names are appended with either (alignment force) or (tech).
    • Scaling: For powers that 'level up', die rolls for all levels are included in the XML.
    • Gunslinger/Special Tricks: These are implemented as Features rather than spells.

  8. Understand the difference between Collections and Compendiums

    master

    To use this repository, you must understand the two types of XML files involved:

    1. Collection files: These are raw source data files located in the Collections folder. They are not directly compatible with apps like Fight Club 5e. They contain entries that point to individual source data files found in the Sources folder.
    2. Compendium files: This is the final, compiled XML file that you import into Fight Club 5e, Game Master 5e, or Character Craft 5.5e.

    You must compile a Collection into a Compendium using xsltproc or the provided helper scripts.

  9. Install xsltproc for compilation

    master

    The xsltproc program is required to compile collection files into compendiums. Installation steps vary by operating system:

    Windows

    1. Install chocolatey (see official instructions).
    2. Open PowerShell with administrative privileges and run: choco install xsltproc

    macOS

    1. Install homebrew (see brew.sh).
    2. Open Terminal and run: brew install libxslt

    Linux

    Use your distribution's package manager to install xsltproc or libxslt.

  11. Compile a collection using xsltproc

    master

    To manually compile a specific collection, navigate to the repository root in your terminal and use the xsltproc command.

    Example: Compiling WotC_5e_only.xml

    xsltproc --xinclude -o Compendiums/WotC_only.xml Utilities/merge.xslt Collections/WotC_5e_only.xml

    After execution, the resulting compendium will be located in the Compendiums/ folder.

  12. Create Backgrounds in XML

    master

    A background is defined using the <background> element. It is used to represent character backgrounds in the Fight Club 5e system.

    Supported Elements:

    • <name>: The name of the background.
    • <proficiency>: Saving throw and skill proficiencies. List names separated by commas (e.g., Insight, Religion).
    • <trait>: Background traits. You can include multiple <trait> elements. Each trait contains:
      • <name>: The name of the trait.
      • <text>: The description. Use multiple <text> elements to represent different paragraphs. If the auto_indent attribute is enabled in the parent compendium element, subsequent paragraphs will automatically indent.
      • <modifier>: Numerical modifiers. Requires a category attribute (see Modifier Categories).
    <background>
  <name>Acolyte</name>
  <proficiency>Insight, Religion</proficiency>
  <trait>
    <name>Description</name>
    <text>You have spent your life in the service of a temple...</text>
    <text/>
    <text>Choose a god, a pantheon of gods...</text>
  </trait>
</background>