Skip to content

appsinacup/godot_vscode_ide

Repository files navigation

Godot VSCode

example

Website Discord


VSCode running inside the Godot game engine.


Godot VSCode

This repo embeds VSCode editor to the Godot Engine as a module through a webview. In future, it will also have a gdextension variant.

TODO:

  • open file when clicking in editor
  • fix build for linux

Setup

There are 2 ways to use the editor:

  • Tunnel (Recommended): For this, make sure the Project -> Project Settings -> editor/ide/auto_start_tunnel property is on. The tunnel will start automatically in the Terminal Tab. After you get an URL for it (From the terminal tab), simply copy that URL and put it in the: Project -> Project Settings -> editor/ide/vscode_url. Now it will always connect automatically to the tunnel (locally). You may need to authenticate with GitHub.
  • External Folder: For this, simply load an external folder in vscode.

If you want to hide the old Script editor, go to:

  • Editor ->
    • Manage Editor Features... ->
      • (Disable) Script Editor

Note:

This will hide the previous Script editor in favour of the new `VSCode` based one.

How it works?

It creates a Webview node and loads the website https://vscode.dev. Then, it creates a tunnel from your local vscode by running code tunnel (automatically) and connects to that.

IMAGE ALT TEXT HERE

Project Settings

The plugin adds the following project settings under editor/ide/:

  • vscode_url (String, default: "https://vscode.dev"): The URL to load in the VSCode webview
  • bottom_panel_enabled (bool, default: false): Whether to show VSCode in a bottom panel in addition to the main screen
  • auto_start_tunnel (bool, default: true): Whether to automatically start the VSCode tunnel when the editor starts

You can disable the auto-start tunnel and manually start it using "Project → Tools → Start VSCode tunnel" from the menu.

Dependencies

  • appsinacup/godot_wry: Fork of godot_wry (Webview component) that fixes some sizing issue.
  • appsinacup/gdterm: Fork of gdterm (terminal) that adds more tabs and a singleton for running commands and creating tabs.

How to install

Download gonuts and run it.

Or:

Build locally godot as you would after cloning this to the modules folder.

scons

About

Adds vscode to the godot engine

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published