coavins / zomboid-coavins-firearms

A Project Zomboid mod that expands the firearm repair system
https://steamcommunity.com/sharedfiles/filedetails/?id=3101379739
MIT License
6 stars 5 forks source link

Add source generation; move model and part definitions to yaml files #94

Open coavins opened 11 months ago

coavins commented 11 months ago

Description

This PR aims to improve the maintainability of models and parts by moving their definition to a single place and using a "build" step to generate certain source files which are currently scattered throughout the repo. This would do away with the need to maintain the Zomboid "item" and "repair" txt files, certain Lua files, and (possibly) the Zomboid translation files.

This PR also ought to introduce a Github Action to run the "build" step and generate a package or artifact which could be used for validation and ci.

Related Issues

Resolves #70

Checklist

Additional Notes

A good followup task to this work would be to add a Github Action to (somehow) generate some nice markdown documentation from the schema files. Surely this must be possible. This would potentially address issue #42.

We could also add a Github Action that validates the model and part yaml files using these schemata.


By submitting this pull request, I confirm that my contributions are made under the terms of the project's license.