summaryrefslogtreecommitdiffstats
path: root/godot-headers/README.md
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2022-03-15 09:58:39 +0100
committerRémi Verschelde <rverschelde@gmail.com>2022-03-15 10:19:07 +0100
commitc4f12ccc3cd19b8fd535d179efd0471386c7f8e9 (patch)
treef7e9edf22da71b57ef7e08af59c5415fff592148 /godot-headers/README.md
parent82bc10258191d4efe64be6239ae86eed70b49e5a (diff)
downloadredot-cpp-c4f12ccc3cd19b8fd535d179efd0471386c7f8e9.tar.gz
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.
Diffstat (limited to 'godot-headers/README.md')
m---------godot-headers0
-rw-r--r--godot-headers/README.md16
2 files changed, 16 insertions, 0 deletions
diff --git a/godot-headers b/godot-headers
deleted file mode 160000
-Subproject 6c1b4a4b3208065bc900497b1264b53d341b3aa
diff --git a/godot-headers/README.md b/godot-headers/README.md
new file mode 100644
index 0000000..1241562
--- /dev/null
+++ b/godot-headers/README.md
@@ -0,0 +1,16 @@
+# godot-headers
+
+This repository contains C headers for
+[**Godot Engine**](https://github.com/godotengine/godot)'s *GDNative Extensions* API.
+
+## 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`
+- Copy the file `core/extension/gdnative_interface.h` to `godot`