/CSEngine

CSEngine is a cross-platform 3D game engine.

Primary LanguageC++BSD 2-Clause "Simplified" LicenseBSD-2-Clause

CSEngine - Cross Platform C++ Game Engine

drawing

Android Build Linux Build MacOS Build Web Build Windows Build last-commit GitHub CodeFactor
CSEngine is a cross-platform 3D game engine.

💡 As it is under development, it is not yet suitable for practical use.

Requirements

intro-image

In all environments

  • CMake 3.15 or higher
  • C++14 compatible compiler
  • GLEW 2.1.0 or higher
  • GLFW 3.3 or higher
  • OpenGL 4.3 or higher

Android

  • Gradle 4.1.3 or higher
  • NDK 21.2.6472646 or higher

Web

  • emsdk 3.0.0 or higher

Building

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.

Windows

Put the GLEW library folder in the External/glew folder within the project.

Visual Studio IDE

Open the project via platforms/Windows/CSEngine.sln

CMake (MSVC)

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.

Linux

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.

macOS

brew install cmake ninja glfw

Install external libraries required at build.

cd [Project Path]/CSEngine/platforms/MacOS
mkdir build
cd build
cmake -G "Ninja" -DCMAKE_BUILD_TYPE=Debug ../

Create make files.

cmake -G "Ninja" -DCMAKE_BUILD_TYPE=Debug ../

Build through the created make files.

Stability

Various stabilization tests such as build tests for various platforms and several unit tests will be added.

Branch Linux Windows MacOS Android Web Architecture
master Linux Build Windows Build MacOS Build Android Build Web Build
build_testing

See more

Review the following documentation:

  • web demo: This site is a simple web demo of the engine ported to WebGL 2.0.
  • documentation: 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.

3rd Party Copyright & Licence

  • 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)
  • stb : The MIT License (MIT)
  • Squirrel Script : The MIT License (MIT)
  • kuba--/zip : The Unlicense