README.md

Aurora

Free open source C++ game engine

STILL WORK IN PROGRESS!

Supported Platforms

Desktop

Name	Compiler	32-bit	64-bit	Render Context
Windows 10	MSVC	-	YES	OpenGL
Windows 10	MinGW-w64	-	YES	OpenGL
Windows 10	Cygwin	-	-	-
Debian / Ubuntu	GCC	-	YES	OpenGL
Debian / Ubuntu	Clang	-	-	-
macOS	-	-	-	Metal

Used libraries

Name	License	Version
GLFW	zlib/libpng	branch: master
GLM	MIT	branch: master
GLAD (web)	MIT	OpenGL 4.6
ImGui	MIT	branch: [docking]
nlohmann JSON	MIT	branch: master
FMOD	Proprietary	2.01.09 (build 115889)
freetype	BSD-style	local
RmlUI	MIT License	branch: [master]
Assimp	Poly2Tri License	branch: [master]
tracy	3-clause BSD license	branch: [master]

Installation

MSVC

• Install cmake-gui
• Start cmake-gui
• Open root project folder (Aurora)
• Select build folder
• Click configure
• Click generate
• Open VS project

Msys2 - for windows gcc building

• Install msys2
• Update msys2 package list (pacman -Syuu) (two times, first time it will close the window and you need to run it again)
• Install GCC pacman -S mingw-w64-x86_64-gcc
• Install GDB for debugging pacman -S mingw-w64-x86_64-gdb
• Install cmake pacman -S mingw-w64-x86_64-cmake
• Install make pacman -S mingw-w64-x86_64-make
• Add MinGW to your IDE (C:\msys64\mingw64)

CMake options

Name	Value info	Default	Info
FMOD_API_DIR	Path to installed fmod api folder.	C:/Program Files (x86)/FMOD SoundSystem/FMOD Studio API Windows/api	FMod folder for sound support
BUILD_EXAMPLES	ON / OFF	OFF	This will enable / disable examples build

OpenGL problems that I found

On AMD GPU

• Ternary operators on sampler2D maybe others in fragments shaders will throw very weird error while linking vertex and fragment shader INVALID_OPERATION, example: texture(Side == 2 ? TextureTop : TextureSide, TexCoord)