Update root-level README and reorganize sources

In an effort to mitigate questions from new, inexperienced users on how
to import data into Fight Club 5e, I rewrote and reorganized the
root-level README file to include detailed instructions on how to
compile their own compendiums using the sources found within this
repository. Some existing data, such as how to create your own
collection file, was moved into other READMEs under the Collections and
Sources directories.

I also took some liberty in reorganizing the directory structure of this
repository and renamed some of the top-level directories. In my view,
having sources under the "FightClub5eXML" folder didn't make a lot of
sense, so I moved those sources into the top-level "Sources" folder. I
made sure to update all of the collection files, along with the
"travis.yml" config file, to properly point to the correct folders.

Finally, while updating the "travis.yml" config file, I changed the
output folder of those build compendiums to be under a top-level
"Compendiums" folder. This folder is ignored by git.
This commit is contained in:
Z. Charles Dziura
2021-11-03 10:55:25 -04:00
parent 94441f22ff
commit cd2e289641
399 changed files with 1648 additions and 1636 deletions

View File

@@ -0,0 +1,96 @@
<?xml version='1.0' encoding='utf-8'?>
<compendium version="5" auto_indent="NO">
<race>
<name>Gith (Githyanki)</name>
<size>M</size>
<speed>30</speed>
<ability>Int 1, Str 2</ability>
<proficiency></proficiency>
<spellAbility>Intelligence</spellAbility>
<trait>
<name>Description</name>
<text>Source: Mordenkainen's Tome of Foes p. 96</text>
</trait>
<trait>
<name>Alignment</name>
<text>Githyanki tend toward lawful evil. They are aggressive and arrogant, and they remain the faithful servants of their lich-queen, Vlaakith. Renegade githyanki tend toward chaos.
</text>
</trait>
<trait>
<name>Decadent Mastery</name>
<text>You learn one language of your choice, and you are proficient with one skill or tool of your choice. In the timeless city of Tu'narath, githyanki have bountiful time to master odd bits of knowledge.
</text>
</trait>
<trait>
<name>Martial Prodigy</name>
<text>You are proficient with light and medium armor and with shortswords, longswords, and greatswords.
</text>
</trait>
<trait>
<name>Githyanki Psionics</name>
<text>You know the mage hand cantrip, and the hand is invisible when you cast the cantrip with this trait.
When you reach 3rd level, you can cast jump once with this trait, and you regain the ability to do so when you finish a long rest. When you reach 5th level, you can cast the misty step spell once with this trait, and you regain the ability to do so when you finish a long rest.
Intelligence is your spellcasting ability for these spells. When you cast them with this trait, they don't require components.
</text>
</trait>
<trait>
<name>Age</name>
<text>Gith reach adulthood in their late teens and live for about a century.
</text>
</trait>
<trait>
<name>Size</name>
<text>Gith are taller and leaner than humans, with most a slender 6 feet in height.
</text>
</trait>
<trait>
<name>Languages</name>
<text>You can speak, read, and write Common and Gith.
</text>
</trait>
</race>
<race>
<name>Gith (Githzerai)</name>
<size>M</size>
<speed>30</speed>
<ability>Int 1, Wis 2</ability>
<proficiency></proficiency>
<spellAbility>Wisdom</spellAbility>
<trait>
<name>Description</name>
<text>Source: Mordenkainen's Tome of Foes p. 96</text>
</trait>
<trait>
<name>Alignment</name>
<text>Githzerai tend toward lawful neutral. Their rigorous training in psychic abilities requires an implacable mental discipline.
</text>
</trait>
<trait>
<name>Mental Discipline</name>
<text>You have advantage on saving throws against the charmed and frightened conditions. Under the tutelage of monastic masters, githzerai learn to govern their own minds.
</text>
</trait>
<trait>
<name>Githzerai Psionics</name>
<text>You know the mage hand cantrip, and the hand is invisible when you cast the cantrip with this trait.
When you reach 3rd level, you can cast shield once with this trait, and you regain the ability to do so when you finish a long rest. When you reach 5th level, you can cast the detect thoughts spell once with this trait, and you regain the ability to do so when you finish a long rest.
Wisdom is your spellcasting ability for these spells. When you cast them with this trait, they don't require components.
</text>
</trait>
<trait>
<name>Age</name>
<text>Gith reach adulthood in their late teens and live for about a century.
</text>
</trait>
<trait>
<name>Size</name>
<text>Gith are taller and leaner than humans, with most a slender 6 feet in height.
</text>
</trait>
<trait>
<name>Languages</name>
<text>You can speak, read, and write Common and Gith.
</text>
</trait>
</race>
</compendium>