You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-13Lines changed: 10 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,29 +8,29 @@ A GDExtension which allows embedding an external code editor such as Visual Stud
8
8
9
9
# Features
10
10
11
-
- Automatically attach and detach external code editors.
12
-
- Checks if the code editor is relevant for the given project (e.g. the project folder is opened inside of it) whenever possible.
11
+
- Automatically attach and detach external code editors into Godot editor.
13
12
- A toggle button in the scene tab bar to manually attach and detach the external code editor.
14
-
- Supported external editors:
15
-
- Only Visual Studio Code for now.
16
13
17
14
# Quick Start
18
15
19
16
- Ensure that
20
-
- you are using Godot 4.
21
-
- you are on Windows.
17
+
- you are using Godot 4.1 or later.
18
+
- you are using Windows.
22
19
- in Godot's editor settings, "Single-window mode" is **disabled** (otherwise dialogs will not appear in front of the code editor).
23
-
- in Godot's editor settings, external code editor is enabled and correctly set up (double-clicking a script file in Godot's file explorer should open your editor of choice).
20
+
- in Godot's editor settings, external code editor is enabled and [correctly set up](https://docs.godotengine.org/en/stable/tutorials/editor/external_editor.html) (double-clicking a script file in Godot's file explorer should open your editor of choice).
24
21
- you follow [the setup instructions](#per-editor-setup) for the editor of your choice.
25
22
-[Download and extract the latest build artifact](https://nightly.link/RedMser/godot-embed-external-editor/workflows/build/master/godot-embed-external-editor_master.zip) or compile from source.
26
23
- Copy the `addons` folder into your game project folder.
27
-
- If Godot was running, be sure to select "Project -> Reload Current Project" or restart the editor (GDExtensions are not live reloaded, see [this issue](https://github.com/godotengine/godot/issues/66231)).
28
24
- Enable the plug-in in the project settings.
29
-
- Open your code editor by double-clicking a script file in Godot's explorer (unrelated code editors will NOT be embedded by this addon) - it should disappear shortly after launching.
25
+
- Open a script file by double-clicking it in Godot's file browser.
30
26
- Switch to the Script tab and enjoy!
31
27
32
28
## Per-Editor Setup
33
29
30
+
Currently, following external editors are supported:
31
+
32
+
-[Visual Studio Code](#visual-studio-code)
33
+
34
34
### Visual Studio Code
35
35
36
36
Following settings changes can either be done in the user settings (Ctrl+Comma), or for each workspace folder:
@@ -51,8 +51,6 @@ This addon is very experimental and hacky. I'm trying to improve upon it, but th
51
51
52
52
## General
53
53
54
-
- Godot still has problems detecting external script file changes (see [this issue](https://github.com/godotengine/godot/issues/69485)).
55
-
-**Workaround:** Restart the editor with "Project -> Reload Current Project".
56
54
- Can not view documentation in editor without detaching editor.
57
55
-**Workaround:** You can use VSCode's "List native classes" option as an alternative.
58
56
- There has been occasional freezes in the past which I've tried to fix. If they still persist, please [open an issue](https://github.com/redmser/godot-embed-external-editor/issues/new).
@@ -67,7 +65,6 @@ This addon is very experimental and hacky. I'm trying to improve upon it, but th
67
65
68
66
## Visual Studio Code
69
67
70
-
- Until [this PR](https://github.com/godotengine/godot-vscode-plugin/pull/400) is finished and merged, debugging Godot games through VSCode is not possible.
71
68
- Rarely, a black strip appears at the top of VSCode which offsets all input events
72
69
-**Workaround:** Restart VSCode to fix this (sadly not even the "Reload Window" command solves this).
73
70
@@ -81,4 +78,4 @@ I don't plan on working on this project for more than my personal use-cases, so
81
78
82
79
Create issues for ideas, feedback or bugs. Open pull requests if you implemented something. All help is appreciated! :)
83
80
84
-
If you want to say thanks, then you can instead [donate on GitHub sponsors](https://github.com/RedMser/godot-embed-external-editor).
81
+
If you want to show your appreciation in another way, consider [donating on GitHub sponsors](https://github.com/RedMser/godot-embed-external-editor).
0 commit comments