Using VSCode With Godot cover image

Using VSCode With Godot

Published on: Nov. 2, 2019 | In: Godot | By Dean

Godot has a built in editor and it’s pretty good. It’s got a lot of the features you would find in any modern text editor. But you can also use an external editor. You can set up pretty much any text editor to work with Godot. My favourite text editor is VSCode so I thought I’d write up a tutorial on how to set this up.

Firstly make sure you have VSCode installed on your computer. If you’re on windows you can download VSCode from here.

If you are running Ubuntu you can install VSCode as a snap package by opening a terminal and typing:

sudo snap install code –classic

If you’re running Fedora you can add the VSCode repo. You can read the official guide on how to do this here

Once you have installed it open it up. Open the “Extensions” tab by pressing Ctrl + Shift + X or by clicking the bottom button on the left hand panel. This will open a panel with a search bar and a couple of recommended extensions. Search for “Godot” by typing it into the search bar and pressing enter.



The first extension that appears should be called “Godot Tools” by Geequlim. This is the one we want. This extension is very useful as it gives us:

    • 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
    • Full documentation supported with API of godot engine

Install this extension by clicking the install button just under the title of the extension. That’s it for the VSCode side. Now we have to set up Godot to use VSCode instead of its internal editor.

Open up the Godot engine and open any project that you are working on. If you do not have a project created yet, create a new one or download a template project. We can delete this project later.

At the top bar go to Editor => Editor Settings. Scroll down left hand pane until you see Text Editor => External. Click on External. This will bring up an options window on the right hand pane. Check the box beside “Use External Editor”. In Exec flags you want to type:

{project} --goto {file}:{line}:{col}

Exec path will be different on each system but you want to put the location that you installed VSCode. For me, using Fedora, the default installation path is:

/usr/bin/code

If you are on windows the default installation path is:

C:/Users/username/AppData/Local/Programs/Microsoft VS Code/bin/code.cmd

And if you are running Ubuntu and installed VSCode via the snap package the default installation is:

/bin/snap/code

If you can’t find it and are running a Linux distribution you can open a terminal and type:

whereis code

and this should output the path that VSCode is installed in.


Now let’s test that it works. In your project either open a script if you have one or right click in your  “res” directory and create a new script. Give it a name. Double click on the script to open it. If you’ve done everything correctly VSCode should open up with your Godot project’s directory as VSCode’s active directory in the project explorer and the script that you clicked on should be open in the editor.


If VSCode does not open check the Exec Path in Editor => Editor Settings => Text Editor => External. Most likely you have set the wrong path for VSCode.

Thanks for reading.



Related Posts

 cover image

Godot 2D Tutorial #3 - Environment Assets

Third video in a series that I'm making detailing how to make a 2D Adventure game with Krita and Godot. In this section…

 cover image

Godot 2D Tutorial #2 - Project Setup

Second video in a series that I'm making detailing how to make a 2D Adventure game with Krita and Godot. In this sectio…

 cover image

Godot 2D Tutorial #1 - Introduction

First video in a series that I'm making detailing how to make a 2D Adventure game with Krita and Godot.There will still…

 cover image

Add Godot Launcher To Linux Application Menu

One of the things that bugged me when I first started using the Godot engine on Linux is that because Godot is a self c…

 cover image

10 Reasons Why I Use Godot

Before I start I just want to say that this is not going to be a post bashing Unity or Unreal. Both of these engines ar…