Skip to content

Commit d5f625e

Browse files
committed
Update readme
Fixes #18
1 parent 2998510 commit d5f625e

1 file changed

Lines changed: 10 additions & 13 deletions

File tree

README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,29 @@ A GDExtension which allows embedding an external code editor such as Visual Stud
88

99
# Features
1010

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.
1312
- 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.
1613

1714
# Quick Start
1815

1916
- 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.
2219
- 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).
2421
- you follow [the setup instructions](#per-editor-setup) for the editor of your choice.
2522
- [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.
2623
- 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)).
2824
- 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.
3026
- Switch to the Script tab and enjoy!
3127

3228
## Per-Editor Setup
3329

30+
Currently, following external editors are supported:
31+
32+
- [Visual Studio Code](#visual-studio-code)
33+
3434
### Visual Studio Code
3535

3636
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
5151

5252
## General
5353

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".
5654
- Can not view documentation in editor without detaching editor.
5755
- **Workaround:** You can use VSCode's "List native classes" option as an alternative.
5856
- 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
6765

6866
## Visual Studio Code
6967

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.
7168
- Rarely, a black strip appears at the top of VSCode which offsets all input events
7269
- **Workaround:** Restart VSCode to fix this (sadly not even the "Reload Window" command solves this).
7370

@@ -81,4 +78,4 @@ I don't plan on working on this project for more than my personal use-cases, so
8178

8279
Create issues for ideas, feedback or bugs. Open pull requests if you implemented something. All help is appreciated! :)
8380

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

Comments
 (0)