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
* GitHub CI/CD workflows to publish your library packages when creating a release (`.github/workflows/builds.yml`)
9
-
* preconfigured source files for C++ development of the GDExtension (`src/`)
10
-
* setup to automatically generate `.xml` files in a `doc_classes/` directory to be parsed by Godot as [GDExtension built-in documentation](https://docs.godotengine.org/en/stable/tutorials/scripting/gdextension/gdextension_docs_system.html)
3
+
This repository contains a GDExtension that boosts the performance of [netfox](https://github.com/foxssake/netfox) by running
4
+
repetitive tasks in cpp.
5
+
6
+
## Installation
7
+
8
+
Download the latest files from the releases page.
11
9
12
10
## Usage - Template
13
11
@@ -23,6 +21,10 @@ For getting started after cloning your own copy to your local machine, you shoul
23
21
* 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.
24
22
* 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);`.
25
23
24
+
## Development
25
+
26
+
After cloning your own copy to your local machine, make sure to initialize the godot-cpp git submodule via `git submodule update --init`.
27
+
26
28
### Configuring an IDE
27
29
You can develop your own extension with any text editor and by invoking scons on the command line, but if you want to work with an IDE (Integrated Development Environment), you can use a compilation database file called `compile_commands.json`. Most IDEs should automatically identify this file, and self-configure appropriately.
28
30
To generate the database file, you can run one of the following commands in the project root directory:
@@ -32,9 +34,4 @@ scons compiledb=yes
32
34
33
35
# Generate compile_commands.json without compiling
34
36
scons compiledb=yes compile_commands.json
35
-
```
36
-
37
-
## Usage - Actions
38
-
39
-
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).
40
-
After a workflow run is complete, you can find the file `godot-cpp-template.zip` on the `Actions` tab on GitHub.
0 commit comments