search

ebullient / ttrpg-convert-cli

Utility to convert JSON data (for content you own) from 5etools or pf2etools into Obsidian-friendly Markdown.
https://www.ebullient.dev/projects/ttrpg-convert-cli/
Apache License 2.0
176 stars 37 forks source link

✨ Passing through custom .json files #82

Open sigrunixia opened 1 year ago

sigrunixia commented 1 year ago

Scope

Documentation .json Files Handlebar Templates Possible CLI alteration

Description

Per our conversation this morning, here is a Feature Request asking for documentation on how to compile .json files for individual things such as: Custom Adventure Books Custom Spells Custom Monsters Custom Npc And More...

So that the TTRPG community can share home-brew content with each other in a different way besides the .csv/handlebar template method with your lovely tool.

Additionally, because this may include content that is not limited to the dungeons and dragons system, documentation of how to set up matching handlebar templates may be necessary as some systems use many more variables, and some use much less.

revilowaldow commented 1 year ago

Aware that this is larger than just D&D as you say above, however worth nothing that https://github.com/ebullient/ttrpg-convert-cli/issues/111 just added support for the 5etools homebrew repo as a source of data. This is well established with a diverse array of content available, and a community ready to assist with conversion to that format for sharing.

sigrunixia commented 1 year ago

Yup, I am aware :) Thank you though!

ebullient commented 1 year ago

I think.. for 5e / pf2e, the *Tools homebrew is going to be the best option (as it provides best integration/linking with the rest of the corpus for that game system).

What I would want to know is, what should we be building reasonably for other systems than those two...

Also.. it is possible that I could read csv files for some of those systems, if that's the way? I just don't know how best to actually achieve cross-linking. That's the downside of #102, too. The data is not presented in a way that allows for injection of links or callouts or block ids. I'm not sure where the capability line would be for other systems.

sigrunixia commented 1 year ago

Thinking about what would be the "simplest" option in my limited knowledge, its mapping json to objects and then into the desired format (if necessary).

Overall I think making the 5etools/pf2etools format standard is absolutely realistic and likely the most efficient. The solution then is finding what the best method for transforming schemas that either: a) does not require additional code in ttrpg-cli beyond creating a -g other. This would be users doing the work to convert the schema first. or b) additional code implementation is mostly seamless, such as using an existing library. This would be cli getting a file and doing the conversion as a side process.