diff --git a/README.md b/README.md new file mode 100644 index 0000000..d4c3050 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +Tools for Visual Studio Code to make game development better with the [Godot Game Engine](http://www.godotengine.org/). + +## Features + +The plugin make it is possible to code GDScript with Visual Studio Code feel like in Godot Editor. + +* GDScript syntax highlight +* Static code validating +* Code completion + +## Requirements + +Optional modules for godot editor should improve the functionality of the tools + +* [EditorServer](https://github.com/GodotExplorer/editor-server/tree/master/editor_server) provide a informations from godot editor by HTTP requirests +* [VSCode](https://github.com/GodotExplorer/editor-server/tree/master/vscode_tools) to generate settings for your projects into `.vscode` which could be used by this plugin +* [TOML](https://marketplace.visualstudio.com/items?itemName=be5invis.toml) language for syntax highlight with text resources + +## Extension Settings + +This extension contributes the following settings: + +* `GodotTools.editorServerPort`: The http server port of the EditorServer module plugin + + +* `GodotTools.maxNumberOfProblems`: The maxmum number of problems in your workspace + +## Known Issues + +Please feel free to open issues and pull requirests on github about the [Godot-Tools](https://github.com/GodotExplorer/godot-tools) plugin and [the modules](https://github.com/GodotExplorer/editor-server). + +## Release Notes + +### 0.1.0 Initialize publish \ No newline at end of file