Pro Handbook

What’s New
Getting Started

Beta & Github

Last Updated: November 1, 20241.7 min read

Downloading Release Builds

Windows

You can find the latest release build of the engine on GitHub.
Simply download the WindowsEditorRelease.7z package, extract it and run bin/Windows/ReleaseDevelopment/Editor.exeto start the precompiled engine. This version of the engine is not connected to any version control.
We recommend working with an engine synced from Git, see below.

Apple (macOS & iOS)

Running via TestFlight
Start the TestFlight app signed in with your @ngi.ne Apple ID. Then install the available Mac or iOS builds of ngine.

Syncing the engine repository from Git

  1. Download a git client such as Github Desktop, and Download and Install Git (command line tools)
  2. Download and Install Git LFS
  3. Sync the https://github.com/nginetechnologies/ngine repository
  4. Obtain the ngine binaries (platform-specific)
    1. Windows: Run SyncLatest.bat
    2. MacOS: Run SyncLatest.sh

Updating the Engine

  1. Download the latest engine Git data via your Git client
  2. Obtain the ngine binaries (platform-specific)
    1. Windows: Run SyncLatest.bat
    2. MacOS: Run SyncLatest.sh

Syncing samples and templates from Git

Steps to sync the Samples repository

  1. Sync the nginetechnologies/ngine-samples-internal (github.com) repository using your Git GUI
  2. Rename the directory from ngine-samples-internal to ngine-samples
  3. Open a git terminal in the new directory
  4. Run the command git remote rename origin internal
  5. Run the command git remote add public https://github.com/nginetechnologies/ngine-samples.git

Steps to sync the Templates repository

  1. Sync the nginetechnologies/ngine-templates-internal (github.com) repository using your Git GUI
  2. Rename the directory from ngine-templates-internal to ngine-templates
  3. Open a git terminal in the new directory
  4. Run the command git remote rename origin internal
  5. Run the command git remote add public https://github.com/nginetechnologies/ngine-templates.git
Then, when developing push changes to branches to the internal remote. For example, if using git terminal:
Copy to Clipboard

Switching Projects outside of the App

To switch projects outside of the app, use the -project command line argument. For example:
Copy to Clipboard

Feedback

Please be sure to submit issues or feature requests through the embedded feedback form. In the event it is a major issue please contact us directly through Discord.

Table of Contents