FightClub5eXML/FightClub5eXML/README.md

51 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# README
## About
Being a big fan of Lion Dens Fight Club 5e and Game Master 5e apps for iOS and Android I was happy to see a kind soul (@fightclub5exml on twitter) had picked up the mantle of updating the compendium with content.
Unfortunately he seems to have deleted his twitter account so I am picking up where he left off by expanding on his work by adding Waterdeep Dragon Heist, Waterdeep Dungeon of the Mad Mage and Ghosts of Saltmarsh content to the XML.
Will take some time but will be making my way through each book and adding the items and monsters to bring it up to date.
Any questions hit me up on twitter [@dragonahcas](http://twitter.com/dragonahcas).
## How-To
Import one of the Collection files into the Fight Club app.
**CoreRulebooks**: Player's Handbook, Dungeon Master's Guide, and Monster Manual
**CoreRulebooksAndSupplements**: _CoreRulebooks_ plus Rulebook Supplements (XGtE, MToF, VGtM, SCAG, GGtR, WGtE, ERftLW, AI, MFF, Tortle Package, and One Grung Above)
**CoreOnly**: _CoreRulebooksAndSupplements_ plus Adventures
**CorePlusHomebrew-NoUA**: _CoreOnly_ plus homebrew, which includes the Blood Hunter class and Gunslinger subclass for Fighter
**CorePlusUnreleasedUA**: _CoreOnly_ plus unreleased Unearthed Arcana
**CorePlusUA-NoHomebrew**: _CoreOnly_ plus all Unearthed Arcana
**Complete**: _CorePlusUA-NoHomebrew_ plus homebrew and third party content
## 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/](https://felixmil.shinyapps.io/compendiumbuildr/)
`@rrgeorge` and `zamrod` for their JSON to XML scripts
`@MrFarland` for Artificer Infusions and other XML
## Contribute
Visit the [FightClub5eXML Github](https://github.com/kinkofer/FightClub5eXML) to contribute.
## Issues
Find a mistake in the compendium? Report it on our [Github Issues](https://github.com/kinkofer/FightClub5eXML/issues).