CSEngine is a cross-platform 3D game engine.
💡 As it is under development, it is not yet suitable for practical use.
- CMake 3.15 or higher
- C++14 compatible compiler
- GLEW 2.1.0 or higher
- GLFW 3.3 or higher
- OpenGL
- Gradle 4.1.3 or higher
- NDK 21.2.6472646 or higher
CSEngine is built using CMake. In the case of Windows, it is possible to build with Visual Studio because it supports MSVC build through CMake.
Put the GLEW library folder in the External/glew
folder within the project.
Open the project via platforms/Windows/CSEngine.sln
Set the compiler settings to Visual Studio. (For setting method, refer to the help of each IDE such as VS, Clion, etc.)
cmake -DCMAKE_BUILD_TYPE=Debug [Project Path]/CSEngine/platforms/Windows
Create make files.
cmake --build [Directory containing make files]
Build through the created make files.
apt install build-essential cmake
apt install mesa-common-dev libglfw3 libglfw3-dev libglew-dev
Install external libraries required at build.
cd [Project Path]/CSEngine/platforms/Linux
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Debug ../
Create make files.
cmake --build [Directory containing make files]
Build through the created make files.
Currently, only Linux build tests are available. In the future, various stabilization tests such as build tests for various platforms and several unit tests will be added.
Branch | Build status |
---|---|
master | |
build_testing |
Review the following documentation:
wiki
: Documentation that details of the structure and function of CSEngine.to-do list
: Documentation that contains the to-do list of the project and notes during development.
- GLEW : Modified BSD License, the Mesa 3-D License (MIT), Khronos License (MIT)
- GLAD : The MIT License (MIT)
- GLFW : zlib License
- IMGUI : The MIT License (MIT)
- lodepng : zlib License
- Squirrel Script : The MIT License (MIT)
- kuba--/zip : The Unlicense