tutorials/editor/external_editor

[giscus[bot]]

tutorials/editor/external_editor

This page explains how to code using an external text editor. Godot can be used with an external text editor, such as Sublime Text or Visual Studio Code. Browse to the relevant editor settings: Edi...

https://docs.godotengine.org/en/latest/tutorials/editor/external_editor.html

[bleedweedsuz]

Godot can be used with an external text editor, such as Sublime Text or Visual Studio Code. Browse to the relevant editor settings: Editor > Editor Settings > Text Editor > External

this is change in MAC its in Godot > Editor Settings...

[p10tr3k]

Integrating Godot with VSCode using URI scheme instead of CLI command (no lag)

In Godot, when you use VSCode as an external editor and rely on CLI commands with arguments to open files in VSCode on macOS, there's some lag until the file is opened. In the Dock, a second VSCode icon appears momentarily before the file opens, which takes a second or two. After some research, I found that a better approach to integrate with VSCode is to use the vscode://file/ URI scheme instead of CLI commands. This fixed my issue—there is no more lag when opening scripts from Godot in the VSCode editor, and the additional VSCode icon no longer appears in the Dock.

Here's how you can set it up:

Create a Bash script:

touch ~/open_in_vscode_uri.sh 
chmod +x ~/open_in_vscode_uri.sh 
nano ~/open_in_vscode_uri.sh

Edit the script:

#!/bin/bash

FILE_PATH="$1"
LINE="$2"
COLUMN="$3"

open "vscode://file/${FILE_PATH}:${LINE}:${COLUMN}"

Configure Godot:

• Open Godot.
• Go to Editor > Editor Settings.
• In the Text Editor > External section, set the Exec Path to the path of the script, e.g., ~/open_in_vscode_uri.sh.
• In the Exec Flags field, enter: "{file}" {line} {col}

reference

[zastrowm]

This is so much faster.

Using a relative path to the bash script didn't work for me - godot wouldn't launch scripts in that case. Changing it to an absolute path got it working.

[lypoluz]

In case an emacs server is used, the command emacsclient -f +{line}:{col} {file} should be used. -f will allow emacs to reuse an existing frame instead of opening a new one.

[Qubus0]

if you are bothered by the popup telling you that a file was changed, open your Editor Settings and enable text_editor/behavior/files/auto_reload_scripts_on_external_change

[Calinou]

There's a PR enabling this by default:

• Enable Auto Reload Scripts on External Change by default in the editor settings godot#97148

[flip-rossi]

Unfortunately, as Neovim's remote command line interface is not as complete as Vim's, some workaround is needed to use the same terminal Neovim instance to keep opening files from Godot (and jumping to line and column).

I'm using this script:

#!/bin/sh

TERM_EXEC="alacritty -e"

if [ $# -ne 4 ]; then
    echo "USAGE: $0 <socket> <file> <line> <column>"
    exit 1
fi

SOCKET="$1"
FILE="$2"
LINE="$3"
COL="$4"

[ -S "$SOCKET" ] &&
    # Connect to running nvim server if socket exists
    nvim --server "$SOCKET" --remote-send ":n +call\ cursor($LINE,$COL) $FILE<CR>" || (
    # Create new server if socket doesn't exist
    tty -s && # Test if shell session is interactive, or a terminal should be opened
        nvim --listen "$SOCKET" "+call cursor($LINE,$COL)" "$FILE" || (
        nohup $TERM_EXEC nvim --listen "$SOCKET" "+call cursor($LINE,$COL)" "$FILE" > /dev/null 2>&1 & ) )

then, in Godot, I'm setting "Exec Path" to sh and "Exec Args" to -c "~/Scripts/nvim-or-remote.sh ~/.cache/nvim/godot-$(basename {project}).socket {file} {line} {col}"

[NobleMode]

Sublime Text Exec Flags should be corrected from {project} {file}:{line}:{column} to {project} {file}:{line}:{col} according to the Exec Flag Fields. Using the old Exec Flags would cause Godot to point to Sublime Text incorrectly as project example.gd:0:{column}

[SCAMX28]

With the Kate editor is better to use as exec flags:

-s YourSession {file}:{line}:{col}

If you use the exec flags of this page the editor won´t update your code if you connect a signal through Godot.

[Calinou]

What should -s YourSession be set to? In particular, if you have multiple Godot editor instances open on different projects at once, I'd expect each instance to use its own session with a randomized ID.

This may require adding a new placeholder that Exec Flags can use, such as {session_id}.