Update GDScript documentation (#41142)
Some information in the GDScript documentation page was outdated (like it still treats Zed if it was a macOS exclusive app) or some details were missing. - The `zed-gdscript` URL has been updated with the new owner. - Pre-requisites added (with netcat included). - Godot installation steps removed, it's now listed in the pre-requisites. - Setup steps simplified and reworded. The note at the bottom was removed as I didn't see the issue in my end. Release Notes: - N/A
This commit is contained in:
@@ -1,29 +1,26 @@
|
||||
# GDScript
|
||||
|
||||
Godot [GDScript](https://gdscript.com/) language support in Zed is provided by the community-maintained [GDScript extension](https://github.com/grndctrl/zed-gdscript).
|
||||
Report issues to: [https://github.com/grndctrl/zed-gdscript/issues](https://github.com/grndctrl/zed-gdscript/issues)
|
||||
Godot [GDScript](https://gdscript.com/) language support in Zed is provided by the community-maintained [GDScript extension](https://github.com/GDQuest/zed-gdscript).
|
||||
Report issues to: [https://github.com/GDQuest/zed-gdscript/issues](https://github.com/GDQuest/zed-gdscript/issues)
|
||||
|
||||
- Tree-sitter: [PrestonKnopp/tree-sitter-gdscript](https://github.com/PrestonKnopp/tree-sitter-gdscript) and [PrestonKnopp/tree-sitter-godot-resource](https://github.com/PrestonKnopp/tree-sitter-godot-resource)
|
||||
- Language Server: [gdscript-language-server](https://github.com/godotengine/godot)
|
||||
|
||||
## Pre-requisites
|
||||
|
||||
You will need:
|
||||
|
||||
- [Godot](https://godotengine.org/download/).
|
||||
- netcat (`nc` or `ncat`) on your system PATH.
|
||||
|
||||
## Setup
|
||||
|
||||
1. Download and install [Godot for macOS](https://godotengine.org/download/macos/).
|
||||
2. Unzip the Godot.app and drag it into your /Applications folder.
|
||||
3. Open Godot.app and open your project (an example project is fine)
|
||||
4. In Godot, Editor Menu -> Editor Settings; scroll down the left sidebar to `Text Editor -> External`
|
||||
1. Use External Editor: "✅ On"
|
||||
2. Exec path: `/Applications/Zed.app/Contents/MacOS/zed`
|
||||
3. Exec flags: `{project} {file}:{line}:{col}`
|
||||
4. Close settings to save.
|
||||
5. In Godot double click on a \*.gd script and Zed will launch
|
||||
|
||||
<!--
|
||||
TBD: GDScript Linux setup
|
||||
-->
|
||||
1. Inside your Godot editor, open Editor Settings, look for `Text Editor -> External` and set the following options:
|
||||
- Exec Path: `/path/to/zed`
|
||||
- Exec Flags: `{project} {file}:{line}:{col}`
|
||||
- Use External Editor: "✅ On"
|
||||
2. Open any \*.gd file through Godot and Zed will launch.
|
||||
|
||||
## Usage
|
||||
|
||||
When Godot is running, the GDScript extension will connect to the language server provided by the Godot runtime and will provide `jump to definition`, hover states when you hold cmd and other language server features.
|
||||
|
||||
> Note: If Zed is already running with an existing workspace, spawning from Godot will fail. Quit Zed and it should work again.
|
||||
When Godot is running, the GDScript extension will connect to the language server provided by the Godot runtime and will provide `jump to definition`, hover states when you hold Ctrl/cmd and other language server features.
|
||||
|
||||
Reference in New Issue
Block a user