godot-vscode-plugin/README.md

A complete set of tools to code games with the Godot game engine in Visual Studio Code.

Features

The plug-in comes with a wealth of features to make your programming experience as comfortable as possible

• Syntax highlighting for the GDscript language
• Syntax highlighting for the tscn and tres scene formats
• Function definitions and documentation on hover
• Rich auto completion
• Static code validation
• Open projects and scenes in Godot from VScode
• Ctrl click on a variable or method call to jump to its definition
• Run/debug the godot game with VSCode with F5(coming soon)

Available commands

The plug-ins adds a few entries to the command palette

• Update Workspace Symbols
• Run workspace as godot project
• Open workspace with godot editor
• Run current scene

Settings

You can use the following settings to setup the Godot Tools:

• GodotTools.editorServerPort: The http server port used by the EditorServer Godot module (see Extra Functionality below)
• GodotTools.maxNumberOfProblems: Sets the limit for the issues reported by the static code validator
• GodotTools.editorPath: An absolute path pointing at the Godot Editor executable file. Required to run the project and test scenes from VScode
• GodotTools.workspaceDocumentWithMarkdown: Control the documentations of workspace symbols should be rendered as plain text or html from markdown
• GodotTools.ignoreIndentedVars: Parse variables defined after indent of not

Extra functionality

If you want to get an even better experience with this plug-in, you can extend its functionality using the following modules and VScode extensions:

Godot modules

These are modules for the goats editor itself, programmed in C++. In order to use them, you have to create a custom build of the engine. Only do that if you know what you're doing.

• EditorServer: Using HTTP requests, this module gets extra information from Godot to improve autocompletion.
• VSCode: The VS code module generates a setting file that Visual Studio code can use to generate Tasks automatically.

VScode extensions

• TOML language: Godot uses this minimal language to store settings. For example in your project config file. If you want to get syntax highlighting for these files, you will have to install the TOML language extension.

Issues and contributions

The Godot Tools and the go to engine modules are all hosted on GitHub. Feel free to open issues there and create pull requests anytime.

Release Notes

0.2.7

• Fix some error with syntax checking
• Add symbol support for enumerations
• Remove key bindings for F5~F8 as it might be confict with other functionalities of VSCode
  • You can bind the key bindings back by add following configurations

  {
      "command": "godot.runWorkspace",
      "key": "F5"
  },
  {
      "command": "godot.runCurrentScene",
      "key": "F6"
  },
  {
      "command": "godot.openWithEditor",
      "key": "F7"
  },
  {
      "command": "godot.updateWorkspaceSymbols",
      "key": "F8"
  }
  

  For more references please ready keybindings

0.2.6

• Add shorthand if else expression support
• Add enum and match expression support
• Fix bugs with syntax checking
• Updated documentation data with godot 2.1.3
• Add syntax checking for end of expression
• The pulugin is compiled with latest VSCode thanks @arrkiin
• Add key bindings for open workspace with godot editor with F7 and update workspace symbols with F8

0.2.5

• Run games within VSCode terminals
• Add key bindings for F5 to run the workspace and F6 to run the edting scene
• Fix a lot of bugs with unused vaiable cheching
• Move workspace symbols state notice to status bar

TODOS:

• Convert official BBCode documentation into Markdown and render it to HTML with documentation previewer pages
• Add mermaid support with documentation
• Undefine variable checking