makspll
commented
1 year ago Hi @themaxhero!
I am more than happy to merge new language PR's. When it comes to contributing, your standard etiquette + process (issue -> PR -> CI/CD -> Review) applies. When it comes to adding new languages here are some things to keep in mind (bit of a brain dump):
- Script hosts have a very flexible interface, they are more than capable of completely ignoring the standard lifecycle of scripts as it looks like for Lua and Rhai currently, this of course does not mean they should be doing that. In fact I would advise that the
register_with_appfunction will likely be either identical or very close to the ones in Lua and Rhai script hosts: https://github.com/makspll/bevy_mod_scripting/blob/781754a7e43730885e58fa89b1f911ae800bf985/languages/bevy_mod_scripting_lua/src/lib.rs#L79-L103 Ideally we want things to be consistent between all scripting languages. - This crate prioritizes the developer experience on both the original studio's and modders side of things. What this means in practice is that languages ideally should or be capable of eventually: supporting static typing, documentation generation, writing a script side API which is close to the native Bevy API (of course within reason, Lua's 1 based indexing is a notable pain point here)
- The main branch of this repo is a re-factor away from the current release (more crates), and a lot of work has been done on the add_rhai_api branch https://github.com/makspll/bevy_mod_scripting/compare/main...feature/add_rhai_api. Namely code sharing between the different language API's is being improved, the Rhai API is being formed, and at the same time the wrapper generator macro is moving to become a derive macro. I have recently started a new job at a different city so in a bit of a chaotic period, hence it's taking longer than I'd like.
- All in all you will find that implementing the script host/language support should be fairly straightforward and quick, adding automatic API support will be the second part of the process and you'd likely want to wait for me to merge that branch before you start on that, to avoid duplicating work (but also the two parts do not at all have to come in one release, having support for a new language even without the bevy API is fantastic).
- My original plan was to merge that Rhai branch and then make a big release, but if you add gluon support I will be happy to release immediately
Do not hesitate to ask any questions either here or in private, while I cannot do as much development work at the moment until I have access to my PC, I can still help.
If there are any issues with dependencies/linting on the main branch do let me know.
Your contributions will be greatly appreciated!
themaxhero
I would like to implement a ScriptHost for Gluon. Is there any contributing rules or conventions that I should be aware of?
Some information about Gluon:
Gluon is a small, statically-typed, functional programming language designed for application embedding.