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

Roll20 Compendium for Open Legend #479

Open
frankieali opened this issue May 21, 2018 · 12 comments
Open

Roll20 Compendium for Open Legend #479

frankieali opened this issue May 21, 2018 · 12 comments

Comments

@frankieali
Copy link

Hey Brian,
I'd like to create a compendium for roll20. I'm a seasoned developer with plenty of knowledge in JSON data structures. I've already started some data transforms on the yaml data to see how well things would convert. Would you be willing to collaborate with me on this effort? I think getting a compendium into roll20 would really help to promote the platform overall.

@brianfeister
Copy link
Member

I'm not sure what a "compendium" is, can you explain? @BuildAndDie is the master of all things roll20 so he's probably the one you want to talk to you

@frankieali
Copy link
Author

frankieali commented May 21, 2018

A compendium in roll20 is a collection of all the game rules made available by an Open Game License (OGL). Roll20 currently has compendiums available for AD&D 5e, Pathfinder and Dungeon World.

The compendium adds features to the roll20 application, including Character Sheet integration and drag and drop functionality. There is a guide for building new compendiums. There's also been an open call for contributors. I think Open Legend would be a perfect addition.

Once a compendium has been added, all the Open Legend rules become available for search within the roll20 game itself. I think this would really help lower the barrier for entry into a new system for a lot of players.

New compendiums can be added in the future. For instance, Wizards of the Coast have the core rules available for free, but the Monster Manual is a purchasable addon from the Marketplace.

The only catch is

one Editor per game system Compendium

Really, I view that as one Compendium Admin, and the assets themselves could live on Github for collaboration and feedback.
I'll reach out to @BuildAndDie as well concerning this idea. I'd really like to see it happen.

@BuildAndDie
Copy link
Contributor

Yes, I've always been planning on working on the compendium eventually. I need to make the actually Roll20 Charactersheet compendium compatiable for it to work completely.

Part of it is having the Developer SRD finished though as well, b/c the SRD will be what is allowed to be included in the compendium. Currently the SRD is waiting on the kickstarter goals to be finished first I believe. I think the only real difference between what is on the Website/Github and what will be in the SRD are mainly some (or all) of the "description" text @brianfeister ?

But, I would be happy to help some with it. I travel a lot, so I usually work on the sheet in bursts. I just got the sheet up to the point now were I'm ready to do a complete overhaul on the coding (clean up and make more efficient, especially on the CSS and Workerscripts). When I do that, I was planning on including things for both the way Roll20 does for translations and for Compendium.

Of course the compendium can be used regardless without it being tied to a charactersheet, but having the addition of being able to drag and drop a boon or bane onto the sheet would be super nice.

@BuildAndDie
Copy link
Contributor

Also, whereas it is one editor, I believe you can have others that help, that was part of the call out they did awhile back, to get people to help with data entry? It's been.... many many months since I looked at all that though, so it could have changed slightly, or my memory is just a little fuzzy on the details.

@frankieali
Copy link
Author

I've already started transforming some of the data just to see what the level of effort would be. The yaml in the SRD was a great starting point, but I've had to reformat the objects a bit to better comply with roll20's requirements. There are also some places where the data gets mixed in a bit too much, such as power level tiers within the effect description. The data becomes more useful when the power levels are broken out into their own category. I'll throw up a repo into Github later this week once I've done some clean up. The way the JSON is formatted, it wouldn't be hard to throw it all into a Mongo DB to test drive some view templates.
I'll also take a closer look at your character sheet to see what kind of field names you're using. We'll want those to map to the key values in the compendium data.
I've reached out to the roll20 team as well concerning where it's possible to use markdown and where it's possible to use HTML. It's not clear from scraping the D&D compendium pages what is used where. It is obvious that they're doing some view level JavaScript processing and not just printing out the raw JSON values.

Is there an SRD planned for Amaurea's Dawn?

@frankieali
Copy link
Author

I just got a message back from Miles P. at Roll20 concerning compendium development.

Hi Frankie Ali,
Thank you for your interest in helping with our Compendium - We are not currently onboarding editors at this time.

However, we have added your name to our list and we will reach out when we are ready to start working on additional compendiums!

Regards,
Miles

So it looks like the compendium will mostly be developed offline for now. It seems like Roll20 won't be able to provide support concerning their JSON structure and parsing capabilities. I'll continue to build out my JSON api's and see if I can get some mock views set up as well.
Character sheet integration will have to wait until we get the green light to upload the compendium.

@BuildAndDie
Copy link
Contributor

BuildAndDie commented May 23, 2018

Sounds like a plan. They might be slow to accept compendiums unfortunately, right now I think they only have 5e and pathfinder?

But I'll still end up updating all my fields and stuff to be more compendium friendly on the sheet for when that time comes.


EDIT:

I'm guessing you did, but did you mention you were specifically interested in it for the Open Legend RPG compendium?

@frankieali
Copy link
Author

I've uploaded my initial go at the Compendium. It's available here: https://github.com/frankieali/open-legend-compendium. Please shoot me over any feedback you have. I'm going to work on getting through the content pages next.

@BuildAndDie
Copy link
Contributor

Looked at it briefly, looks well put together, but I'm not entirely sure what I would be looking out without referencing other compendiums and seeing what is what, etc. I'll probably look more into it when I get back from traveling.

@frankieali
Copy link
Author

I did a big refactor today. I think I'm in a good spot to start building out some mock files and view templates.

@BuildAndDie
Copy link
Contributor

sounds good. Hopefully Roll20 will open up compendiums soon to more games so we can put it into play, though it would be nice to get a dice rolling type specific to Open Legend's way of rolling explosions with advantage.

@frankieali
Copy link
Author

I've added a site for displaying the compendium data https://open-legend-grimoire.herokuapp.com/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants