robertcorponoi / godot-rust-cli Goto Github PK

If the new command is used and passed the name of a Godot project that doesn't exist, it should create the Godot project.

This issue is caused by the library not being built when it was created. A build should automatically be started when a library is created.

We need better documentation than just the readme.

I've come across a few options like mdBook, VuePress, etc but I think I've decided on creating a Gridsome site and host it on Netlify or GitHub pages.

This means that changing documentation will require working in a different repo but it's a better alternative than having an npm library within the cargo package. We could also set up an action to copy the build files of the documentation into a /docs directory in this repo and use it with GitHub pages.

Currently the configuration file is just used internally but it should be able to be edited by the user with confidence. This means that it needs to be heavily documented and probably could use more user configurable properties.

A plugin is essentially a library within a library and we need a way to have multiple modules with a plugin.

The build badge is still set to Travis CI, it needs to be updated for GitHub actions.

Errors are currently all caught with except and they're formatted awfully and on top of all that it's hard to tell which errors are user error and which ones are program error.

Possible solutions:

• Implementing anyhow

While we wait on #29, we should at least make the documentation easier to follow by splitting it into separate files linking to those files from the README.

This was something in godot-rust-helper but I didn't port it over here because I wanted godot-rust-cli to be more simple. However, I don't think this simplicity helps users and targets should be able to be defined.

The property godot_project_dir in the JSON configuration file should be changed to godot_project_dir_name or something similar.

This is more of just a semantic change since that property doesn't hold the path to the Godot project but just the name of the directory of the Godot project.

The link to the Discord server does not work. Perhaps it wasn't a permalink.

Hi, thanks for making this library. Is there any possibility to add Android compatibility

Thanks.

To ensure that things run as smoothly as possible, and in cases where the user might accidentally delete a file, I believe that the cli should always double check the library and Godot project when installing modules.

What this means is that when you create or destroy a module, the library would:

• Remove the module from the config (normal).
• "Re-create" the library and Godot structure from the new config. This has additional time associated with it but checks can be performed to prevent too many unnecessary processes.

This could also be split as a separate command. A use case for this is if a user accidentally deletes a module, they can at least just run a simple command and recreate it without having to worry about the errors and trying to resolve them manually to get the project working again.

More robust documentation should be provided in a mdBook.

The build command can't copy the library dll, if the msvc toolchain is used (Installed via Visual Studio) and not gnu.
This is because the get_platform_toolchain function always assumes gnu and does not consider msvc to be an option.

Title mostly explains it: using godot-rust-cli build --watch will exit if cargo build encounters an error, this might be intentional, however, I save a lot, especially since it is usually required to save to get rust-analyzer to do its thing, at least in my editor, so it would be nice if the error was reported, but the command did not exit, letting you continue editing and building.

Currently only debug is supported but there should be a --release flag that gets passed down to the Cargo build command. This could also be an environment issue in the config.

Toolchains should be able to be optionally passed to the build command. However, this toolchain needs to be matched with the target in the Godot project somehow.

The configuration should be updated to be more like a package config. More details will be provided as they are developed.

It would be neat to be able to create a library based off an existing non-godot-rust-cli library. I think this might be a good command or an extension of the new command.

https://docs.github.com/en/actions/learn-github-actions/migrating-from-travis-ci-to-github-actions

It order to better troubleshoot problems and to help godot-rust-cli-upgrader, the version of the CLI that the user is using should be added to the configuration file.

This shouldn't be too far off, it just needs the correct Dockerfile created.

The issue that we're currently facing is documented here.

Essentially:

• We need to extend the default docker file for 64 bit Linux.
• We need this image to have clang 3.9 or higher.

It would be nice if modules could be moved around in case the user wanted to have some folders and whatnot. Currently that's not possible due to the way the lib file is built but it can be done.

It would help debugging and godot-rust-cli-upgrader to have a cli version in the config.