2
2
3
3
> ** Warning**
4
4
>
5
- > This repository's ` master ` branch is only usable with the latest version of
6
- > Godot's ( [ GDExtension] ( https://godotengine.org/article/introducing-gd-extensions ) )
7
- > API ( Godot 4.1 and later) .
5
+ > This repository's ` master ` branch is only usable with
6
+ > [ GDExtension] ( https://godotengine.org/article/introducing-gd-extensions )
7
+ > from Godot's ` master ` branch .
8
8
>
9
- > For users of Godot 4.0.x, switch to the [ ` 4.0 ` ] ( https://github.com/godotengine/godot-cpp/tree/4.0 ) branch.
9
+ > For users of stable branches, switch to the branch matching your target Godot version:
10
+ > - [ ` 4.0 ` ] ( https://github.com/godotengine/godot-cpp/tree/4.0 )
11
+ > - [ ` 4.1 ` ] ( https://github.com/godotengine/godot-cpp/tree/4.1 )
12
+ >
13
+ > Or check out the Git tag matching your Godot version (e.g. ` godot-4.1.1-stable ` ).
10
14
>
11
15
> For GDNative users (Godot 3.x), switch to the [ ` 3.x ` ] ( https://github.com/godotengine/godot-cpp/tree/3.x )
12
16
> or the [ ` 3.5 ` ] ( https://github.com/godotengine/godot-cpp/tree/3.5 ) branch.
@@ -52,9 +56,10 @@ first-party `godot-cpp` extension.
52
56
53
57
Some compatibility breakage is to be expected as GDExtension and ` godot-cpp `
54
58
get more used, documented, and critical issues get resolved. See the
55
- [ issue tracker] ( https://github.com/godotengine/godot/issues ) for a list of known
56
- issues, and be sure to provide feedback on issues and PRs which affect your use
57
- of this extension.
59
+ [ Godot issue tracker] ( https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension )
60
+ and the [ godot-cpp issue tracker] ( https://github.com/godotengine/godot/issues )
61
+ for a list of known issues, and be sure to provide feedback on issues and PRs
62
+ which affect your use of this extension.
58
63
59
64
## Contributing
60
65
@@ -76,7 +81,7 @@ just like before.
76
81
77
82
To use the shared lib in your Godot project you'll need a ` .gdextension `
78
83
file, which replaces what was the ` .gdnlib ` before.
79
- Follow [ the example] ( test/project/example.gdextension ) :
84
+ See [ example.gdextension ] ( test/project/example.gdextension ) used in the test project :
80
85
81
86
``` ini
82
87
[configuration]
@@ -129,6 +134,10 @@ void initialize_example_module(ModuleInitializationLevel p_level) {
129
134
130
135
Any node and resource you register will be available in the corresponding ` Create... ` dialog. Any class will be available to scripting as well.
131
136
132
- ## Included example
137
+ ## Examples and templates
138
+
139
+ See the [ godot-cpp-template] ( https://github.com/godotengine/godot-cpp-template ) project for a
140
+ generic reusable template.
133
141
134
- Check the project in the ` test ` folder for an example on how to use and register different things.
142
+ Or checkout the code for the [ Summator example] ( https://github.com/paddy-exe/GDExtensionSummator )
143
+ as shown in the [ official documentation] ( https://docs.godotengine.org/en/latest/tutorials/scripting/gdextension/gdextension_cpp_example.html ) .
0 commit comments