Welcome to the Nord Engine source code!
With the code in this repository, you can build the Nord Engine for your platform. Modify the code in any way you can imagine, and share your changes with others!
- Windows
- Linux (In progress)
- Python3
- CMake 3.10+
- Doxygen
We publish source for the engine in several branches:
Numbered branches
identify past and upcoming official releases.- The
main branch
is the hub of changes from all our engine development teams. It’s not subject to as much testing as release branches. - Branches whose names contain
dev
,staging
, andtest
are typically for internal processes, and are rarely useful for end users.
Other short-lived branches may pop-up from time to time as we stabilize new releases or hotfixes.
There are several places to learn Nord Engine:
- The
official tutorials
- The
online API documentation
- The
offline documentation
in folderDocs
- You can get the latest official release on NordEngine website.
- You can also get the source code of the current version from the repository.
Follow the instructions of the tutorials or offline documentation
in folder Docs
.
We welcome contributions to Nord Engine development through pull requests
.
We prefer to take pull requests in our active development branches, particularly for new features. Please make sure that all new code adheres to the coding standards
.
For more information on the process and expectations, see the documentation
.
All contributions are governed by the terms of your EULA.
Here are some useful community links:
Your access to and use of Nord Engine on GitHub is governed by an End User License Agreement (EULA).
For a comparison and links to FAQs, see the NordEngine page.
If you don't agree to the terms in your chosen EULA, as amended from time to time, you are not permitted to access or use Nord Engine.