FightClub5eXML
FightClub5eXML copied to clipboard
kinkofer
Everything gets overwritten
Not entirely sure how to import the files so they merge together rather than overwrite eachother. I don't understand how to create the custom compendium and merge that way. Do i make the xml, then import it into fight club?
If you're trying to make your own compendium, you create a new xml file with each of the sources you want to merge. You can use the xml files in the Collections directory as a template. Then you need to run the xsltproc command line tool with merge.xslt and your file.
If you're only looking to use a collection that's already been generated, there's a link to the Dropbox where those exist.
How do I create a new xml file? I'm completely new to this.
I really appreciate what you do by the way. I run 4 campaigns and this is a tremendous help. I apologize for being a complete noob
On Fri, Nov 27, 2020 at 21:30 Chris Jennewein [email protected] wrote:
If you're trying to make your own compendium, you create a new xml file with each of the sources you want to merge. You can use the xml files in the Collections directory as a template. Then you need to run the xsltproc command line tool with merge.xslt and your file.
If you're only looking to use a collection that's already been generated, there's a link to the Dropbox where those exist.
— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/kinkofer/FightClub5eXML/issues/112#issuecomment-735029805, or unsubscribe https://github.com/notifications/unsubscribe-auth/AR5KH7I3NCD2PLOI5Y7X3GDSSBOEFANCNFSM4UFMCI6A .
The same way you would any text file: open up your text editor of choice (Visual Studio Code, Nodepad++, regular ol' Notepad, etc), and save it as an XML file (such as "Compendium.xml"). In the README of this project, down at the bottom of the document, you should see some instructions on what exactly to put into said XML file in order to make it importable by Fight Club.
Ahhhh ok my bad! Thank you I appreciate the help. It would be the same for merging classes together right? I think you may have posted about that in the read me file actually
On Fri, Nov 27, 2020 at 22:25 Z. Charles Dziura [email protected] wrote:
The same way you would any text file: open up your text editor of choice (Visual Studio Code, Nodepad++, regular ol' Notepad, etc), and save it as an XML file (such as "Compendium.xml"). In the README of this project, down at the bottom of the document, you should see some instructions on what exactly to put into said XML file in order to make it importable by Fight Club.
— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/kinkofer/FightClub5eXML/issues/112#issuecomment-735034104, or unsubscribe https://github.com/notifications/unsubscribe-auth/AR5KH7P3AH3REEH3GZXMQL3SSBUQZANCNFSM4UFMCI6A .
Ok apologies again, last question and I'll let you be lol the "execute the merge" section.
Where would the top level of the repo be? I looked at the Travis file and it looked like it was line 15? Small confusion, apologies again and thank you
On Fri, Nov 27, 2020 at 22:30 Joey Wormuth [email protected] wrote:
Ahhhh ok my bad! Thank you I appreciate the help. It would be the same for merging classes together right? I think you may have posted about that in the read me file actually
On Fri, Nov 27, 2020 at 22:25 Z. Charles Dziura [email protected] wrote:
The same way you would any text file: open up your text editor of choice (Visual Studio Code, Nodepad++, regular ol' Notepad, etc), and save it as an XML file (such as "Compendium.xml"). In the README of this project, down at the bottom of the document, you should see some instructions on what exactly to put into said XML file in order to make it importable by Fight Club.
— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/kinkofer/FightClub5eXML/issues/112#issuecomment-735034104, or unsubscribe https://github.com/notifications/unsubscribe-auth/AR5KH7P3AH3REEH3GZXMQL3SSBUQZANCNFSM4UFMCI6A .
Right at the bottom of this file: README.md. Under the section that says "Build Your Own Compendium".
The top level of the repo refers to the folder on your computer. You want your command line's current directory to be just inside the repo folder.
As someone with no experience whatsoever with coding, please explain the exact steps for doing this. What is a shell? Is there a program we need? Its obvious you know what you're doing, but I do not. I would use the website http://dnd.kinkofer.com/compendium but it doesn't seem to be properly working.
That website hasn't been updated with the newest data yet, but I'll get to it once the new XML and Tasha's data is more finalized.
What are you trying to accomplish? Do any of the collections in the Dropbox have the sources you're looking for? The first step is really to identify the sources you want in your compendium.
@Catkingman I'm going to assume that you're using a computer running Windows. If not, you'll just have to adapt these instructions to your OS of choice.
A "shell", in modern contexts, is the command-line terminal program that comes bundled with your computer. In Windows, if you open up the Start Menu and search for "cmd", you'll see an entry for a "Command Prompt" or "Command Line Terminal"; something like that. It's icon is a black box with some white text in the top-left corner. Open that up and you'll see a nifty little window pop open that allows you to enter in commands and do things with your PC. It's through this window where you'll be generating the file with all of the data in it that Fight Club 5 uses.
This project is basically a collection of files that can be combined together into a final "Compendium" (my own term, not sure what the owners of this project use). All of the data is separated by source book and type (separate race data, separate class data, etc). All of that can be found in the FightClub5eXML/Sources folder here in this repository. I'm pretty sure that you can download all of those files individually and import them directly into Fight Club 5, but I haven't done so myself. But who wants to do all of that, that's so tedious! Instead, you will use a command-line program called "xsltproc" to execute an "xslt" script (you can look up what that is separately) to combine all of the files together into a Compendium file, which then can be imported. The xslt script that you'll be executing is the "merge.xslt" file, found within the Utilities folder in this repository.
In the Collections folder within this repository, there are some collection XML files that are basically a list of entries pointing to those source files I mentioned in the above paragraph. You can execute the xsltproc program to read that collection, which will copy in all of the files listed within that collection file and will write out a file with all of the entries copied in their entirety.
With all of that out of the way, here are the steps to actually creating your own Compendium file:
- First, make sure to download the xsltproc program. If you're running Windows, you can find a download link here: https://www.zlatkovic.com/pub/libxml/
- Download a copy of this repository onto your computer and extract the ZIP file's contents to your Documents folder (call it FightClub5eXML or something like that).
- Open up the Command Line Terminal and navigate to that folder. To do so, just type in the command
cd C:\Users\<YOUR USER NAME>\Documents\FightClub5eXML. Again, if you're using a Mac or are running Linux or some other OS, you'll need to adjust the above command to follow the proper folder structure. - Execute the following command:
xsltproc -o Compendium.xml Utilities/merge.xslt <COLLECTION FILE TO USE>. If you wanted to build a compendium from the "CoreRulebooksAndSupplements.xml" collection, you would execute:xsltproc -o Compendium.xml Utilities/merge.xslt Collections/CoreRulebooksAndSupplements.xml. - Copy the Compendium.xml file to your phone and import it into Fight Club 5. Tada! You're done!
@zcdziura, thank you for the detailed steps. I could add this to the documentation later, if you don't mind.
I'll mention that not all the sources can be imported into the app directly because of how the merge works. For example, all the new subclasses in Tasha's are missing the details for the rest of the classes, so you'd also be required to include the PHB. The dnd.kinkofer.com site will ultimately be the best place to create the compendium because I'm enforcing the dependencies.
@zcdziura I cannot tell what I am supposed to do to get and/or use whatever allows the xsltproc command, or where to put it.