zacharyselk / trundle Goto Github PK

License: Apache License 2.0

CMake 5.05% C++ 92.92% C 1.59% Dockerfile 0.44%

trundle's Introduction

Trundle

This is a simple game engine built with c++17, created to learn about different aspects of games engines, because what better way to learn than by doing.

Dependancies

This project attempts to keep the dependancies down to a minimum and creating submodules whenever possible to automate dependancy building. Currently the only dependancies are:

CMake 3.17 or higher
A c++17 supported compiler (gcc >= 8.0, clang >= 5.0)
OpenGL
Python 2.7 or higher

Installing Dependancies

Go to cmake to download and install the latest version of CMake.

For the rest of the dependancies.

On Ubuntu:

# apt-get install -y libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libgl1-mesa-dev

Building

This project uses CMake as its build software, so simply need to run the following commands to build the project. Firstly clone the repository

$ git clone --recursive https://github.com/zacharyselk/Trundle.git

Then use CMake to compile the project

$ mkdir build && cd build
$ cmake ../Engine
$ cmake --build .

This will build the sample Driver in build/bin/ by default. To change the build location use $ cmake .. --DCMAKE_INSTALL_PREFIX=<path>

Running

Once built an exacutable named bin/driver (or bin\driver.exe) will be created and simply needs to be executed to run.

Builds

Service	System	Compiler	Status
Travis CI	MacOSX, Linux 64 bits	Clang
AppVeyor	Windows 32 and 64	Visual Studio 2019

trundle's People

Contributors

Stargazers

Watchers

trundle's Issues

CMake files need to be rewritten

Need to completely rewrite:

CMakeLists.txt
Engine/CMakeLists.txt
Driver/CMakeLists.txt

These rewrites should only use modern CMake (CMake 3.0+) and proper flags/options.

Add colors to Log output

Each of the six log levels (Trace, Info, Debug, Warn, Error, and Critical) should print out with a unique color do differentiate what type of message it is.

OpenGL version checking tool needs to be created

A small command-line tool needs to be created in order to determine what version of OpenGL is currently installed and (in the future) to check what graphics APIs are available to the system. This tool needs to be able to be run by CMake during the build process so that the minimum required version can be checked at compile-time as well as so that compile-time flags can be set to enable appropriate function calls.

Orthographic camera rotation is not quite right

While rotating an orthographic camera objects in the scene become slightly distorted meaning there is a bug in the math.

Runtime error on MacOS due to glDebugMessageCallback

On MacOS Trundle is crashing here at runtime:

Trundle/Engine/src/Platform/OpenGL/openGLContext.cpp

Line 74 in ad566d0

glDebugMessageCallback(MessageCallback, 0);

Commit: ad566d0

Create a command line parsing tool

A stop-gap solution is in Engine/include/Trundle/Core/commandLine.h but a real solution is needed.

Create a style guide

Make a style guide and convert the existing code base to it.

Visual Studio 2019 build error

When building with Visual Studio 2019 IDE the following errors are returned:

Error: \(default\)/GLFW/deps: No such file or directory
Error: \(default\)/GLFW/include: No such file or directory

Commit: 0467ce4
Build System: Ninja

CMake does not automatically re-`install` header files in Engine when they are modified

When modifying a header file under Engine Cmake does not register those changes and will use a cached version of the header from previous builds stored under build/include/Trundle.

As a workaround run rm -rf build/include/Trundle after modifying a header file to prevent Cmake from using stale cached header files.

Linking issues on Arch Linux

Issue

When compiling on an Arch Linux install that currently has glew installed on it, the linker runs into problems trying to link several glew functions as seen below

/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewGetUniformLocation'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewDetachShader'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewDeleteProgram'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewGetShaderiv'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewCompileShader'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewCreateProgram'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewBlendEquationSeparate'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewGenBuffers'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewShaderSource'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewCreateShader'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewGetProgramInfoLog'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewBindVertexArray'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewGetShaderInfoLog'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewUniformMatrix4fv'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewBindSampler'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewUniform1i'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewBlendEquation'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewBindBuffer'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewDeleteShader'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewVertexAttribPointer'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewGetAttribLocation'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewActiveTexture'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewBlendFuncSeparate'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewBufferData'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewDeleteBuffers'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewLinkProgram'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewDeleteVertexArrays'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewGenVertexArrays'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewUseProgram'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewDrawElementsBaseVertex'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewGetProgramiv'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewAttachShader'
/usr/bin/ld: /home/zach/sync/code/Trundle/build/lib/libengine.so: undefined reference to `__glewEnableVertexAttribArray'
collect2: error: ld returned 1 exit status

This is either an issue in Dear ImGui or an issue with how Trundle include the default backends backends/imgui_impl_glfw.h and backends/imgui_impl_opengl3.h inside of /Engine/src/Util/imGuiLayer.cpp insead of makeing its own.

Temporary Fix

A hotfix for this issue is to simply remove glew from the system. Assuming that it was installed using the package manager then to remove it simply run # pacman -Rcs glew and that should resolve the linking errors.

Add unit testing

Create a few basic unit tests and link them in to the build system

Create an ImGui ini File

An ini file should be created to set the default gui layout on startup.

Header files not receiving proper include files

When #include <GL/gl3w.h> is added to a header file, it returns fatal error: 'GL/gl3w.h' file not found.
However if the same include is added to a source file there are no compilation errors.

LayerStack Memory Bug

In LayerStack an iterator it is currently maintained by hand, pointing to the separation point between normal layers and overlay layers. This iterator is pointing to a memory location in a std::vector but whenever the vector is dynamically resized the iterator does not get moved, causing it to point to a stale address and resulting in invalid reads and writes to memory.

Add documentation summarizing the system

Add some files under either docs/ or on the wiki describing how Trundle works and what is currently implemented along with directions on how to contribute.

Add formatting to Log

Add formatting options to the logger similar to python or c#

Visual Studio build error

When building in the Visual Studio IDE, GLFW cannot be found. Returning the error: No such file or directory #include <GLFW/glfw3.h>. This makes building in the IDE not possible even though builds using the Visual Studio compiler does build correctly.