Add a help action

[xphere]

I'm trying this tool and it's amazing! It's the piece I missed the most in the Godot ecosystem, so thank you! The problem is that I find myself often going to the docs to remember how to use it.

I took the liberty to add a help action which shows a list with the syntax and exits. This also shows when no action or an unknown one is supplied. Descriptions of actions and options are copied & pasted from the README. I hope it's helpful!

A screenshot:

[imjp94]

Hey @xphere, glad that it helps! So true, I always have to open the README to check the commands XD

But we might have to simplify this PR to make it cross platform, as print_rich doesn't works properly on Windows 10 See https://github.com/godotengine/godot/issues/2308 and https://github.com/godotengine/godot/issues/80031

If you wish to edit this PR, I would suggest printing the instruction with logger like logger.info() for consistency.

[xphere]

If you wish to edit this PR, I would suggest printing the instruction with logger like logger.info() for consistency.

Ouch, you're right! Without the colors it is a lot harder to understand, but it's still helpful. It would be nice if there's a way to keep the colors for other systems that are capable of it, maybe we can detect these capabilities and strip bbcodes for those not supporting. In fact I thought godot was doing thiat under the hood. I'll investigate a bit and fix this.

[xphere]

I've been playing with an old computer with Windows 10, but I can't find an easy way to detect ANSI support. I'm removing bbcodes and using logger.info instead of print_rich for better compatibility.

[imjp94]

Suddenly have an idea to enhance the output with table-like layout(using rows & columns)

And adding help-config command to show configs documentation

Let me know if you are okay with the changes or is there anything to add. Otherwise, I think we are ready to merge this PR =)

[xphere]

Suddenly have an idea to enhance the output with table-like layout(using rows & columns)

I've tried this before adding colors and descriptions wrapped easily (especially with keep-import-resource-file displacing everything to the right) but I can give it a try again now that ANSI colors are dismissed.

And adding help-config command to show configs documentation

That's a neat idea, will look into it too. 👌🏻

[imjp94]

Oh no, I mean I already implemented those 2 features in the last 2 commits.

If you are fine with the changes I made, we can then merge this PR

[xphere]

Oh, nice, didn't saw your commits! Great, fine by me! :shipit: 💪🏻

Have you seen last news for Godot 4.3? https://twitter.com/HugoLocurcio/status/1757843848154206653 I'm curious if someone fixed print_rich or not 😅

[imjp94]

Have you seen last news for Godot 4.3? https://twitter.com/HugoLocurcio/status/1757843848154206653 I'm curious if someone fixed print_rich or not 😅

Nope, it doesn't works on Windows 10...

[imjp94]

Thank you!

[xphere]

Nice, I'm glad to contribute! 🎉

FYI, I discovered a workaround if you're using git-bash or a similar terminal in Windows: you can pipe the command to cat or any other text command (head or less -R) and it re-colorizes the output.