Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Passing through custom .json files #82

Open
sigrunixia opened this issue Jan 4, 2023 · 4 comments
Open

✨ Passing through custom .json files #82

sigrunixia opened this issue Jan 4, 2023 · 4 comments
Labels
enhancement New feature or request

Comments

@sigrunixia
Copy link
Contributor

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
Copy link

Aware that this is larger than just D&D as you say above, however worth nothing that #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
Copy link
Contributor Author

Yup, I am aware :) Thank you though!

@ebullient
Copy link
Owner

ebullient commented Jun 28, 2023

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
Copy link
Contributor Author

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.

@ebullient ebullient changed the title [FR] Passing through custom .json files ✨ Passing through custom .json files Oct 6, 2023
@ebullient ebullient added the enhancement New feature or request label Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants