Skip to content

Commit 1942aeb

Browse files
committed
Add section about LSP support by compiledb scons command
Adds a section explaining that a compilation database can be compiled using scons to enable IDE features like autocomplete and more.
1 parent 5513ce6 commit 1942aeb

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ For getting started after cloning your own copy to your local machine, you shoul
2323
* change the `entry_symbol` string inside your `demo/bin/your-extension.gdextension` file to be configured for your GDExtension name. This should be the same as the `GDExtensionBool GDE_EXPORT` external C function. As the name suggests, this sets the entry function for your GDExtension to be loaded by the Godot editors C API.
2424
* register the classes you want Godot to interact with inside the `register_types.cpp` file in the initialization method (here `initialize_gdextension_types`) in the syntax `GDREGISTER_CLASS(CLASS-NAME);`.
2525

26+
### Language Server Protocol (LSP) support
27+
Scons can generate a compilation database file named `compile_commands.json` which has information about every compiled unit in your project. This file enables IDEs to be able to offer features such as autocompletion and syntax highlighting for your GDExtension and godot-cpp classes.
28+
29+
To compile this file you can run this command in the project root directory:
30+
```shell
31+
scons compiledb=yes compile_commands.json
32+
```
33+
2634
## Usage - Actions
2735

2836
This repository comes with a GitHub action that builds the GDExtension for cross-platform use. It triggers automatically for each pushed change. You can find and edit it in [builds.yml](.github/workflows/builds.yml).

0 commit comments

Comments
 (0)