Browse Source

Update version to 1.0.0 !

Geequlim 5 years ago
parent
commit
ecffd631a8
5 changed files with 28 additions and 24 deletions
  1. 5 0
      CHANGELOG.md
  2. 21 22
      README.md
  3. BIN
      img/godot-tools.jpg
  4. BIN
      img/godot-tools.png
  5. 2 2
      package.json

+ 5 - 0
CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+### 1.0.0
+* Refactor the whole plugin with gdscript language server support
+* Add webview renderer to show documentations of native symbols.
+* Only support godot 3.2 and above
+
 ### 0.3.7
 * Add `lint` configuration to control the behaviors of syntax checking
 * Fix error with run godot editor when the editor contains spaces

+ 21 - 22
README.md

@@ -1,28 +1,32 @@
 A complete set of tools to code games with the [Godot game engine](http://www.godotengine.org/) in Visual Studio Code.
 
+**IMPORTANT NOTE**
+This version of plugin only support godot 3.2 and above.
+
 ## Features
 
 The extension comes with a wealth of features to make your Godot programming experience as comfortable as possible:
 
-- Syntax highlighting for the GDscript (`.gd`) language
+- Syntax highlighting for the GDScript (`.gd`) language
 - Syntax highlighting for the `.tscn` and `.tres` scene formats
+- Full Typed GDScript support
+- Optional `Smart Mode` to speed up dynamic typed script coding
 - Function definitions and documentation display on hover (see image below)
 - Rich auto-completion
-- Static code validation
-- Open projects and scenes in Godot from VS Code
+- Display script warnings and errors
 - Ctrl-click on a variable or method call to jump to its definition
 - Full documentation of the Godot engine's API supported
+- Run godot project from VS Code
 
-![Showing the documentation on hover feature](img/godot-tools.jpg)
+![Showing the documentation on hover feature](img/godot-tools.png)
 
 ## Available Commands
 
 The extension adds a few entries to the VS Code Command Palette under "GodotTools":
 
-- Update workspace symbols
-- Run workspace as Godot project
 - Open workspace with Godot editor
-- Run current scene
+- Run workspace as Godot project
+- List native classes of godot
 
 ## Settings
 
@@ -38,27 +42,22 @@ If you like this extension, you can set VS Code as your default script editor fo
 ### VS Code
 
 You can use the following settings to configure Godot Tools:
-- **GodotTools.godotVersion** - The Godot version of your project.
-- **GodotTools.editorPath** - The absolute path to the Godot executable. Required to run the project and test scenes directly from VS Code.
-- **GodotTools.workspaceDocumentWithMarkdown** - Control how the documentation of workspace symbols should be rendered: as plain text or as HTML from Markdown.
-- **GodotTools.ignoreIndentedVars** - Only parse variables defined on lines without an indentation.
-- **GodotTools.parseTextScene** - Parse a file as a Godot scene when the file name ends with `.tscn`.
-- **GodotTools.completeNodePath** - Show node paths within a workspace as part of code completion.
-- **GodotTools.godotProjectRoot** - Your Godot project's directory, which contains `project.godot` or `engine.cfg`.
+- **editor_path** - The absolute path to the Godot editor executable
+- **gdscript_lsp_server_port** - The websocket server port of the GDScript language server
+- **check_status** - Check the GDScript language server connection status
 
 ## Issues and Contributions
 
-The [Godot Tools](https://github.com/GodotExplorer/godot-tools) extension and  [engine modules](https://github.com/GodotExplorer/editor-server) are both hosted on GitHub. Feel free to open issues there and create pull requests anytime.
+The [Godot Tools](https://github.com/godotengine/godot-vscode-plugin) extension is an open source project of godot orgnization. Feel free to open issues and create pull requests anytime.
 
 See the [full changelog](https://github.com/GodotExplorer/godot-tools/blob/master/CHANGELOG.md) for the latest changes.
 
 ## FAQ
-   
-### Why isn't Intellisense showing up for me?
 
-Make sure you save your `.gd` file, then run "GodotTools: Update Workspace Symbols" from the Command Palette.
+### Why failed to connect to language server?
+- You may not open your project with godot editor.
+- Godot 3.2 and above is required.
 
-## TODO:
-* Convert official BBCode documentation into Markdown and render it into HTML with documentation previewer pages
-* Add mermaid support with documentation
-* Undefined variable checking
+### Why isn't intellisense showing up my script members for me?
+- The GDScript is a dynamic typed script language the tool may can infer all the variable types as you want.
+- You can turn on the `Smart Mode` in godot editor `Editor Settings > Language Server` check the `Enable Smart Resolve`.

BIN
img/godot-tools.jpg


BIN
img/godot-tools.png


+ 2 - 2
package.json

@@ -2,7 +2,7 @@
 	"name": "godot-tools",
 	"displayName": "godot-tools",
 	"icon": "icon.png",
-	"version": "0.9.1",
+	"version": "1.0.0",
 	"description": "Tools for game development with godot game engine",
 	"repository": "https://github.com/godotengine/godot-vscode-plugin",
 	"author": "The Godot Engine community",
@@ -57,7 +57,7 @@
 				"godot-tool.check_status": {
 					"type": "string",
 					"default": "",
-					"description": "The absolute path to the Godot editor executable"
+					"description": "Check the gdscript language server connection status"
 				}
 			}
 		},