Sara.Sync
/
godot-cpp
mirror of https://github.com/godotengine/godot-cpp
0
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
godot-cpp/godot-headers/README.md

17 lines
685 B
Markdown
Raw Normal View History

Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
# godot-headers
This repository contains C headers for
Rename GDNative to GDExtension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension -> Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION -> EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 13:11:44 +00:00
[**Godot Engine**](https://github.com/godotengine/godot)'s *GDExtensions* API.
Remove godot-headers submodule, copy files directly With the new GDExtension API, the headers are just two files, one of which is generated and needs to always be kept in sync with the Godot engine version. So there's little practical use for using godot-headers as a submodule anymore, and it only makes godot-cpp updates more cumbersome. Custom headers (i.e. a custom API JSON) can still be used by passing the `headers_dir` SCons option.
2022-03-15 08:58:39 +00:00
## Updating Headers
If the current branch is not up-to-date for your needs, or if you want to sync
the headers with your own modified version of Godot, here is the update
procedure used to sync this repository with upstream releases:
- Compile [Godot Engine](https://github.com/godotengine/godot) at the specific
version/commit which you are using.
- Use the compiled executable to generate the `extension_api.json` file with:
`godot --dump-extension-api extension_api.json`
Rename GDNative to GDExtension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension -> Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION -> EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 13:11:44 +00:00
- Copy the file `core/extension/gdextension_interface.h` to `godot`