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

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

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

coavins
Copy link
Owner

@coavins coavins commented Nov 29, 2023

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

  • Code follows the project's coding standards.
  • Documentation is updated (if applicable).
  • All checks and tests pass locally.
  • The commit messages follow the project's commit message conventions)

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.

@coavins coavins self-assigned this Nov 29, 2023
@coavins coavins added enhancement New feature or request codebase repo-feature Feature concerning the repository as a whole labels Nov 29, 2023
@coavins coavins changed the title Add source generation, move model and part definitions to yaml files Add source generation; move model and part definitions to yaml files Nov 30, 2023
@coavins coavins changed the base branch from develop to master December 1, 2023 04:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codebase enhancement New feature or request repo-feature Feature concerning the repository as a whole
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor how models and parts are created and maintained
1 participant