Team-Resourceful / ResourcefulBees

Minecraft Mod for creating highly customized bees
https://www.resourcefulbees.com
GNU Lesser General Public License v3.0
75 stars 31 forks source link

[Feature Request]: Implement JSON schema for config templates #349

Open CombatZAK opened 2 years ago

CombatZAK commented 2 years ago

Is your feature request related to a problem?

Getting JSON right is hard, and I'm lazy as all good software engineers should be. Debugging busted JSON files is also hard, and it's easy to overlook minor mistakes like casing.

Solution(s)

Most editors support following a $schema template when editing/creating JSON. This would make creating and modifying bees, traits, honey and other configurable options for this mod much easier.

Describe alternatives you've considered

Copying the templates from the wiki is another option, however it appears that there are missing features on the wiki that are supported by code, and settings drift between major versions is a real concern - specifically there is 0 documentation on how to implement bee auras in 1.16.5, even though it does seem to be supported (and a three hour walk through the source code confirmed this), but the wiki has no references to it, and it looks like the syntax changed at some point between 1.16.x and upcoming 1.19 (at least according to branch names).

Mod Version

0.10.7

Mod Loader Version

forge 1.16.5 - 36.1.32

Additional context

I'm happy to send a PR for this, if you think it would be a valuable feature but don't have the time or interest in adding it.

Acknowledgement

Epic428 commented 2 years ago

A json schema is definitely something we’re planning to implement. But also I have a little ground work laid for building a web based bee editor and sharing site. I just need to get our finalized api when we release the 1.19 update to finish out the editor