NEXO Engine

Welcome to the NEXO Engine repository! This project is a collaborative effort to create a revolutionnary game engine. Our goal is to provide a robust, user-friendly, and efficient platform for game development in desktop as well as in virtual reality!

Table of Contents

• NEXO Engine
  • Table of Contents
  • Project Overview
    • Game Engine
  • External Dependencies
  • Build the project
  • Install the project
    • Install via CMake
    • Create an installer for Windows (NSIS)
    • Create an installer for Linux (DEB)
  • Run the tests
  • The Team

Note

Find the whole documentation on our website.

Project Overview

Game Engine

Interface screenshot

Quick video of the game engine in action with Jolt Physics

fall.mp4

Warning

This video is from a prototype version of the engine. The final version does not currently integrate physics.

External Dependencies

To run this project, ensure you have the following:

• CMake: Necessary for building the project from source.
• C++ Compiler: We recommend using GCC or Clang for Linux and MacOS, and MSVC for Windows.
• X11: Required for Linux and macOS.

Build the project

Cloning and building is a breeze:

1. Clone the repository with the submodules.

git clone --recurse-submodules

2. Run cmake to generate the build files.

cmake -B build
cmake --build build

3. Launch the engine!

For Linux and MacOS:

./build/nexoEditor

For Windows:

./build/nexoEditor.exe

Note

For detailed instructions, visit our Installation Guide.

Install the project

Install via CMake

First build the project as seen in the step Build the project. Then run the following command:

cmake --install build --prefix /path/to/install

This will install the NEXO Engine in the directory /path/to/install with all the necessary files.

Create an installer for Windows (NSIS)

To create an installer for Windows, you can use the NSIS installer.

Warning

We assume here that you already ran the cmake command to generate the build files in the build directory.

First install NSIS on your computer, then run the following command:

cd build
cpack -G NSIS -C Debug

Now you can run the generated installer to install the NEXO Engine on your computer.

Create an installer for Linux (DEB)

Warning

We assume here that you already ran the cmake command to generate the build files in the build directory.

cd build
cpack -G DEB

To install the generated package (on Ubuntu/Debian...), run the following command:

sudo dpkg -i NEXO-Engine-*-Linux.deb

Run the tests

In this project tests use the gtest library.

First build the tests:

cmake -B build
cmake --build build

Then run the tests:

cd build
ctest -C Debug

The Team

NEXO Engine is brought to life by a dedicated team of fourth-year students from EPITECH Strasbourg:

• Guillaume HEIN (@Thyodas)
• Jean CARDONNE (@jcardonne)
• Marie GIACOMEL (@Sauterelle57)
• Mehdy MORVAN (@iMeaNz)
• Thomas PARENTEAU (@ThomasParenteau)

Acknowledgements

This project is part of our curriculum and end of studies project, showcasing our collective skills in advanced software development with modern C++.

We thank Epitech for the opportunity to work on such an engaging project and for the support throughout our educational journey.