Changes between Version 7 and Version 8 of runbooks/setup

Timestamp:

01/31/22 11:24:19 (4 years ago)

Author:

Jonathan Neufeld

Comment:

Building Godot engine and APIs properly.

runbooks/setup

@@ -25 +25 @@
 
 = Code Repository
-The repository that contains the GD Native libraries used by ''Studio'' is called ''Revenant''.  This is a C++17 project and is meant for senior devs experienced in advanced C++.
+The repository that contains the GD Native libraries used by ''Studio'' is called ''Revenant''.  This is a C++17 project and is meant for senior devs experienced in advanced C++, and there are also external dependencies required with manual steps involved.
+
 This can be cloned onto your local machine using the following command:
 
@@ -33 +34 @@
 
 Replace ''your-user-name'' with your SSH user name registered on this server, which is the same user name you used to login to Trac here.  If you have setup Git correctly on your machine for working with our repositories then it should download the repository onto your machine
+
+== Godot Dependencies
+The Godot API dependency is checked-out automatically as a Git submodule from the code repository, but it depends upon the [https://github.com/godotengine/godot Godot Engine] as well as [https://github.com/Zylann/godot_voxel Zylann Voxel Module].  First follow the instructions to clone and build those repositories on your local machine.
+
+== Generate API bindings JSON:
+Generate the API bindings JSON using the following command from within the Godot engine directory:
+{{{#!sh
+godot --gdnative-generate-json-api modules/gdnative/include/api.json
+}}}
+
+== Configure CMake
+The Revenant code repository CMake build requires explicitly setting two CACHE values:
+- '''GODOT_HEADERS_DIR''': Points to the `modules/gdnative/include` sub-folder of your cloned ''Godot Engine'' repository
+- '''GODOT_CUSTOM_API_FILE''': Points to `api.json` generated previously that lives inside the above folder (GODOT_HEADERS_DIR) (i.e. `<godot engine repo>/modules/gdnative/include/api.json`)
+
+Set these values by passing them to `cmake` using the `-D` flag for each.