= Studio Repository
First setup the [https://github.com/godotengine/godot-git-plugin/wiki Git plugin for Godot]

The repository that contains the Godot project files and resources is called ''Revenant Studio'' and can be cloned onto your local machine.  First change directories to the folder where you want to clone the ''Revenant Studio'' project files:

''For example:''
{{{#!sh
cd /c/Users/<your-user-name>/Godot/
}}}

Now clone the repository using the following command:

{{{#!sh
git clone <your-user-name>@gauss.extollit.com:/opt/git/revenant-studio.git
}}}

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

== Sandbox Testing Mode
For collaboration with the rest of the team in Godot and not working on any Revenant production work switch to the ''sandbox'' branch and leave it that way for the duration of your testing and before committing any code.  Once you switch to the branch you do not have to switch back to sandbox unless for some reason you switched to some other branch first.  In other words, branch switch is persistent and it stays even after turning off your computer until you decide to again switch to some other branch.  To switch to the sandbox branch enter the following command from within the ''revenant-studio'' folder:

{{{#!sh
git checkout sandbox
}}}

= Code Repository
The repository that contains the GD Native libraries used by ''Studio'' is called ''Revenant''.  This is a C++11 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:

{{{#!sh
git clone <your-user-name>@gauss.extollit.com:/opt/git/revenant.git
}}}

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.