RType 1.2
Documentation for the RType project at EPITECH
|
πβ 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! π€©β¨βπβ
[!NOTE] Find the whole documentation on our website.
πΈβ Interface screenshot
π₯ Quick videos of the game engine in action
https://github.com/user-attachments/assets/a91e61c3-b8a9-43d3-83c4-37fd02de2e7c
https://github.com/user-attachments/assets/281bec66-65cc-4467-aeb7-8f546dc3fb22
https://github.com/user-attachments/assets/ea92807b-da51-4fb6-bd1d-d3c9fadf0c13
[!WARNING] This project is still in development and is not yet ready for production use. Some features may change.
To run this project, ensure you have the following:
Cloning and building is a breeze:
CMake presets
(automatic) [Recommended][!NOTE] There are several presets available:
build-debug
,build-release
,build-coverage
,minimal-build
,test-debug
, andtest-coverage
.
CMake Build
(manual)[!NOTE] For detailed instructions, visit our Installation Guide.
First build the project as seen in the step Build the project. Then run the following command:
This will install the NEXO Engine in the directory /path/to/install
with all the necessary files.
[!WARNING] We assume here that you already ran the cmake command to generate the build files in the
build
directory.
To create an installer for Windows, you can use the NSIS installer.
Now you can run the generated installer to install the NEXO Engine on your computer.
[!WARNING] We assume here that you already ran the cmake command to generate the build files in the
build
directory.
To install the generated package (on Ubuntu/Debian...), run the following command:
In this project tests use the gtest library.
First build the tests:
Then run the tests:
If you encounter any issues, please refer to our Troubleshooting Guide.
NEXO Engine is brought to life by a dedicated team of fifth-year students from EPITECH Strasbourg:
Check our web site to keep you up to date about the latest news about NEXO. Join the community to ask your questions or to talk with our developers. Visit our blog to find out more about how NEXO works.
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.
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
For more information about the copyright of the project, please refer to the [COPYRIGHT](COPYRIGHT) file.
You can also find the license of the third-party libraries used in the project in the external/licenses directory.
[!TIP] For any license inquiry, please contact us at nexo.engine@gmail.com
You can use the cmake install command:
This will extract all licenses per third-party library in the /path/to/install/external/licenses
directory.
[!NOTE] These licenses are automatically extracted from vcpkg, there might be missing third-party libraries.
You can use the cmake install command:
This will generate the COPYRIGHT file in the /path/to/install
directory.
[!WARNING] By default the COPYRIGHT file is generated with some
TODO:
, the generator cannot always determine exact licenses for some files. Please check each entry for errors.