godotengine / godot-vscode-plugin

Godot development tools for VSCode
MIT License
1.52k stars 149 forks source link

Add warning and instructions for using Godot 4 to README #479

Closed lostfictions closed 1 year ago

lostfictions commented 1 year ago

This PR attempts to alleviate some of the confusion caused by https://github.com/godotengine/godot-vscode-plugin/issues/473.

It adds a warning at top of README.md about the manual configuration required to use this extension with Godot 4, as well as instructions in the VS Code configuration section about what port to use. I've also amended the troubleshooting/FAQ section at the end of the readme to add this info as well.

I've lightly reformated that section to better allow for multi-line setting descriptions and anchor linking (so that the warning at the top of the readme can directly link to the relevant section).

Additionally, I removed the checkStatus setting documentation, since as far as I can tell it no longer exists. There seem to be a number of new, undocumented extension settings, but maybe those could be added in a further PR.

DaelonSuzuka commented 1 year ago

Thanks for doing this. The Godot 4 update is taking longer than expected (sorry!), so this is a good intermediate measure.

Also congrats on your first contribution!