-
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8 from radu-relantin/main
Added windows compatibility
- Loading branch information
Showing
2 changed files
with
40 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,36 @@ | ||
# Zed GDScript | ||
# Zed GDScript Extension | ||
|
||
This extension adds support for the [GDScript](https://docs.godotengine.org/en/stable/classes/index.html) language. | ||
This extension adds support for [GDScript](https://docs.godotengine.org/en/stable/classes/index.html), the scripting language used in the Godot game engine, to the Zed editor. | ||
|
||
## Language Server Protocol | ||
## Requirements | ||
|
||
Support for the Godot Language Server Protocol (LSP) is provided via `nc` which is assumed to be in your `PATH`. | ||
- Zed Editor | ||
- Godot Engine (version 3.x or 4.x) | ||
- `nc` (netcat) or `ncat` available in your system PATH | ||
|
||
The language server is expected to be running on the default ip `127.0.0.1` and port `6005`. | ||
## Installation | ||
|
||
1. Install this extension in Zed (instructions specific to Zed's extension installation process) | ||
2. Ensure Godot is installed on your system | ||
3. Set up the Godot language server (see below) | ||
|
||
## Setting Up the Godot Language Server | ||
|
||
The Godot Language Server should be running separately. Here are the steps to set it up: | ||
|
||
1. Open your Godot project | ||
2. Go to Editor > Editor Settings > Text Editor > External | ||
3. Enable "Use External Editor" | ||
4. Set "Exec Path" to the path of your Zed executable | ||
5. Set "Exec Flags" to `{file}` | ||
|
||
Then, to start the language server: | ||
|
||
1. Go to Editor > Editor Settings > Network > Language Server | ||
3. Set "Remote Host" to `127.0.0.1` | ||
4. Set "Remote Port" to `6005` | ||
5. Restart Godot | ||
|
||
## Configuration | ||
|
||
This extension assumes the Godot Language Server is running on the default IP `127.0.0.1` and port `6005`. If you need to change these settings, you'll need to modify the extension code (for now...) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters