test

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "cmake/entt"]
+	path = cmake/entt
+	url = https://github.com/skypjack/entt
+[submodule "cmake/imgui"]
+	path = cmake/imgui
+	url = https://github.com/dante1130/imgui
+[submodule "cmake/catch2"]
+	path = cmake/catch2
+	url = https://github.com/catchorg/Catch2

CMakeLists.txt

@@ -1,8 +1,8 @@
 # Minimum CMake version
-cmake_minimum_required (VERSION 3.17)
+cmake_minimum_required(VERSION 3.17)
 
 # Project declaration.
-project (ReflexEngine LANGUAGES CXX)
+project(ReflexEngine LANGUAGES CXX)
 
 set(CMAKE_CXX_STANDARD 17)
 
@@ -12,62 +12,108 @@ set(CMAKE_DISABLE_SOURCE_CHANGES ON)
 # CMake path for libraries.
 set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH} "${CMAKE_SOURCE_DIR}/cmake/")
 
-add_executable (ReflexEngine)
+enable_testing()
+
+add_executable(ReflexEngine src/main.cpp)
+add_executable(ReflexEngineTest)
 
 add_subdirectory(cmake)
 
 add_subdirectory(src)
+add_subdirectory(test)
 
-if (MSVC) 
-  set(MSVC_DISABLED_WARNINGS_LIST
-  "C4100" # 'identifier' : unreferenced formal parameter
-  )
-endif()
-
+target_compile_options(ReflexEngineSrc PRIVATE
 
-target_compile_options(${PROJECT_NAME} PRIVATE
     # Clang
     $<$<OR:$<CXX_COMPILER_ID:Clang>,$<CXX_COMPILER_ID:AppleClang>>:
-        -Wall -Wextra -Wpedantic -fcolor-diagnostics
-        # Turn off useless warnings
-        -Wno-c++98-compat -Wno-c++98-compat-pedantic -Wno-padded
-        -Wno-deprecated-declarations -Wno-exit-time-destructors
-        -Wno-switch-enum -Wno-weak-vtables -Wno-global-constructors>
+    -Wall -Wextra -Wpedantic -fcolor-diagnostics
+
+    # Turn off useless warnings
+    -Wno-c++98-compat -Wno-c++98-compat-pedantic -Wno-padded
+    -Wno-deprecated-declarations -Wno-exit-time-destructors
+    -Wno-switch-enum -Wno-weak-vtables -Wno-global-constructors>
+
     # GCC
-    $<$<CXX_COMPILER_ID:GNU>:-Wall -Wextra -Wpedantic -fdiagnostics-color=always>
+    $<$<CXX_COMPILER_ID:GNU>:-Wall -Wextra -Wpedantic -fdiagnostics-color=always -mbig-obj>
+
     # Visual Studio
-    $<$<CXX_COMPILER_ID:MSVC>:/W4>
+    $<$<CXX_COMPILER_ID:MSVC>:/W4 /bigobj>
+
+    $<$<CONFIG:RELEASE>:-O3>
+    $<$<CONFIG:DEBUG>:-O0>
 )
 
 add_custom_command(TARGET ReflexEngine POST_BUILD
-                   COMMAND ${CMAKE_COMMAND} -E copy_directory
-                    ${PROJECT_SOURCE_DIR}/dlls 
-                    ${CMAKE_CURRENT_BINARY_DIR})
+    COMMAND ${CMAKE_COMMAND} -E copy_directory
+    ${PROJECT_SOURCE_DIR}/dlls
+    ${CMAKE_CURRENT_BINARY_DIR})
 
 add_custom_command(TARGET ReflexEngine POST_BUILD
-                   COMMAND ${CMAKE_COMMAND} -E copy_directory
-                    ${PROJECT_SOURCE_DIR}/resources 
-                    ${CMAKE_CURRENT_BINARY_DIR})
-
-# Include dependencies.
-include_directories (ReflexEngine SYSTEM ${CMAKE_PREFIX_PATH}/glad/include)
-include_directories (ReflexEngine SYSTEM ${CMAKE_PREFIX_PATH}/glfw/include)
-include_directories (ReflexEngine SYSTEM ${CMAKE_PREFIX_PATH}/glm)
-include_directories (ReflexEngine SYSTEM ${CMAKE_PREFIX_PATH}/stb_image)
-include_directories (ReflexEngine SYSTEM ${CMAKE_PREFIX_PATH}/assimp/include)
-include_directories (ReflexEngine SYSTEM ${CMAKE_PREFIX_PATH}/imgui)
-include_directories (ReflexEngine SYSTEM ${CMAKE_PREFIX_PATH}/reactphysics3d)
-include_directories (ReflexEngine SYSTEM ${CMAKE_PREFIX_PATH}/raknet/include)
-include_directories (ReflexEngine SYSTEM ${CMAKE_PREFIX_PATH}/irrklang)
-
-# Link libraries.
-target_link_libraries (ReflexEngine PRIVATE glfw)
-target_link_libraries (ReflexEngine PRIVATE glm)
-target_link_libraries (ReflexEngine PRIVATE glad)
-target_link_libraries (ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/assimp/lib/assimp-vc143-mt.lib)
-target_link_libraries (ReflexEngine PRIVATE imgui)
-target_link_libraries (ReflexEngine PRIVATE lua)
-target_link_libraries (ReflexEngine PRIVATE reactphysics3d)
-target_link_libraries (ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/raknet/Lib/DLL_vc9_DLL_Release_x64.lib)
-target_link_libraries (ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/raknet/Lib/LibStatic_vc9_LibStatic_Release_x64.lib)
-target_link_libraries (ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/irrklang/lib/irrKlang.lib)
+    COMMAND ${CMAKE_COMMAND} -E copy_directory
+    ${PROJECT_SOURCE_DIR}/resources
+    ${CMAKE_CURRENT_BINARY_DIR})
+
+target_include_directories(ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH})
+target_include_directories(ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/glad/include)
+target_include_directories(ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/glfw/include)
+target_include_directories(ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/glm)
+target_include_directories(ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/stb_image)
+target_include_directories(ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/assimp/include)
+target_include_directories(ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/imgui)
+target_include_directories(ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/reactphysics3d/include)
+target_include_directories(ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/irrklang)
+target_include_directories(ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/slikenet/Source)
+target_include_directories(ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/entt/single_include)
+target_include_directories(ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/catch2/src)
+target_include_directories(ReflexEngine PRIVATE ${CMAKE_PREFIX_PATH}/lua/src)
+
+target_include_directories(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH})
+target_include_directories(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH}/glad/include)
+target_include_directories(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH}/glfw/include)
+target_include_directories(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH}/glm)
+target_include_directories(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH}/stb_image)
+target_include_directories(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH}/assimp/include)
+target_include_directories(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH}/imgui)
+target_include_directories(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH}/reactphysics3d/include)
+target_include_directories(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH}/irrklang)
+target_include_directories(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH}/slikenet/Source)
+target_include_directories(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH}/entt/single_include)
+target_include_directories(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH}/catch2/src)
+target_include_directories(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH}/lua/src)
+
+target_include_directories(ReflexEngineTest PRIVATE ${CMAKE_PREFIX_PATH})
+target_include_directories(ReflexEngineTest PRIVATE ${CMAKE_PREFIX_PATH}/glad/include)
+target_include_directories(ReflexEngineTest PRIVATE ${CMAKE_PREFIX_PATH}/glfw/include)
+target_include_directories(ReflexEngineTest PRIVATE ${CMAKE_PREFIX_PATH}/glm)
+target_include_directories(ReflexEngineTest PRIVATE ${CMAKE_PREFIX_PATH}/stb_image)
+target_include_directories(ReflexEngineTest PRIVATE ${CMAKE_PREFIX_PATH}/assimp/include)
+target_include_directories(ReflexEngineTest PRIVATE ${CMAKE_PREFIX_PATH}/imgui)
+target_include_directories(ReflexEngineTest PRIVATE ${CMAKE_PREFIX_PATH}/reactphysics3d/include)
+target_include_directories(ReflexEngineTest PRIVATE ${CMAKE_PREFIX_PATH}/irrklang)
+target_include_directories(ReflexEngineTest PRIVATE ${CMAKE_PREFIX_PATH}/slikenet/Source)
+target_include_directories(ReflexEngineTest PRIVATE ${CMAKE_PREFIX_PATH}/entt/single_include)
+target_include_directories(ReflexEngineTest PRIVATE ${CMAKE_PREFIX_PATH}/catch2/src)
+target_include_directories(ReflexEngineTest PRIVATE ${CMAKE_PREFIX_PATH}/lua/src)
+target_include_directories(ReflexEngineTest PRIVATE ${PROJECT_SOURCE_DIR}/src)
+
+target_link_libraries(ReflexEngineSrc PRIVATE glfw)
+target_link_libraries(ReflexEngineSrc PRIVATE glm)
+target_link_libraries(ReflexEngineSrc PRIVATE glad)
+target_link_libraries(ReflexEngineSrc PRIVATE imgui)
+target_link_libraries(ReflexEngineSrc PRIVATE lua)
+target_link_libraries(ReflexEngineSrc PRIVATE reactphysics3d)
+target_link_libraries(ReflexEngineSrc PRIVATE EnTT)
+target_link_libraries(ReflexEngineSrc PRIVATE ${PROJECT_SOURCE_DIR}/lib/assimp-vc143-mt.lib)
+target_link_libraries(ReflexEngineSrc PRIVATE ${PROJECT_SOURCE_DIR}/lib/RakNet_DLL_Release_x64.lib)
+target_link_libraries(ReflexEngineSrc PRIVATE ${CMAKE_PREFIX_PATH}/irrklang/lib/irrKlang.lib)
+
+target_link_libraries(ReflexEngine PRIVATE ReflexEngineSrc)
+
+target_link_libraries(ReflexEngineTest PRIVATE Catch2::Catch2WithMain)
+target_link_libraries(ReflexEngineTest PRIVATE ReflexEngineSrc)
+
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_PREFIX_PATH}/catch2/extras)
+
+include(CTest)
+include(Catch)
+catch_discover_tests(ReflexEngineTest)

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contribution
+
+## Contribution guidelines
+
+* Follow these [`Git` best practices](https://programmerfriend.com/git-best-practices/).
+* Follow this [`Git` branching model](https://nvie.com/posts/a-successful-git-branching-model/).
+* Follow the [`C++` Core Guidelines](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines).
+* Use `CppCheck` and `clang-tidy` to analyze your code.
+* Use `clang-format` to format your code.
+
+## Setting up `clang-format`
+
+### Visual Studio
+
+1. Open `Visual Studio`.
+2. On the navigation bar, click `Extensions -> Manage Extensions...`.
+3. Install the extension `Clang Power Tools`.
+4. Restart `Visual Studio` after installation.
+5. Click on `Tools` from the `Clang Power Tools` menu.
+   ![clang-format settings](https://clangpowertools.com/assets/blog/get-started-with-clang-power-tools/SettingsToolbar.png)
+6. If you do not have `LLVM` installed, go to the `LLVM` tab and install any version.
+7. After installation, navigate to `Format` tab and turn on `Format on save`.
+8. Your code will now be formatted on save.
+
+## Steps for GitFlow workflow
+
+* To merge changes to branch:
+  * Create a separate branch, give it a relevant name.
+  * Push your changes to the branch.
+  * Ensure that it can successfully build and run.
+  * Major code additions must include some unit tests unless determined otherwise by the team
+  * Create a pull request to the `develop` branch, **not `master`**.
+  * Include information regarding the changes.
+  * Request a review from a reviewer.
+* To review a pull request:
+  * Checkout the pull request branch locally.
+  * Ensure that it can successfully build and run.
+  * Ensure that the unit tests all successfully complete.
+  * Go through each file and mark it viewed after finish reviewing.
+  * Comment any issues you find.
+  * Finish review and submit as "`Approved`" if there are no issues.
+  * Merge the pull request and delete the branch.
+* To create an issue:
+  * Create an issue giving detailed information about the issue.
+  * Give an example of a minimal reproduction of the issue.
+  * Mention any fixes or workarounds you have used.
+  * Refer to a pull request if possible, whether it is a fix or the commit with the issue.
+  * Close the issue once it is resolved.
+
+## Steps for unit testing
+
+* Create your `.cpp` in the `test` directory.
+* Add your `.cpp` source file to `test/CMakeLists.txt`.
+* Implement your unit test. (You can use `ShaderTest.cpp` as an example, or look at the reference guide for `Catch2`).
+* Build and run on target `ReflexEngineTest`.

cmake/imgui/LICENSE.txt → LICENSE.md

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2014-2020 Omar Cornut
+Copyright (c) 2022 Reflex Bullet Entertainment
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1 +1,66 @@
-# ReflexEngine
+# ReflexEngine
+
+![reflex-logo](https://i.imgur.com/TXfAfwS.png)
+
+## Table of Contents
+
+* [Cloning the repository](#cloning)
+* [Building](#building)
+  * [Visual Studio](#vs)
+  * [VSCode](#vscode)
+* [Contributing](#contributing)
+* [License](#license)
+
+## Cloning the repository
+
+```bash
+git clone https://github.com/dante1130/ReflexEngine
+git submodule update --init --recursive
+```
+
+## Building
+
+### Visual Studio
+
+#### Install build tools
+
+* [Visual Studio](https://visualstudio.microsoft.com/downloads/)
+* Install the component "`C++ CMake tools for Windows`".
+
+#### Building ReflexEngine in Visual Studio
+
+1. Open `Visual Studio` as Administrator.
+2. Choose the option “`Continue without code`”.
+3. Navigate to the top left and select `File -> Open -> CMake`.
+4. Navigate to the root directory of `ReflexEngine`.
+5. Open `CMakeLists.txt`.
+6. Navigate to `Project` on the navigation bar and click “`Generate cache for ReflexEngine`”.
+7. Once the output window says “`CMake generation finished`”, ensure you are targeting `ReflexEngine.exe` and you are on the `Release` build as shown in the image below.
+8. Press on `ReflexEngine.exe` play button to run the project. If it is your first time running the engine, you will need to build it, but it will do it automatically once you press `ReflexEngine.exe`. It can be done manually by going build-> then on rebuild ReflexEngine.
+
+### VSCode
+
+#### Install extensions
+
+* [VSCode](https://code.visualstudio.com/download)
+* Install the extension [CMake tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools).
+
+#### Building ReflexEngine in VSCode
+
+* Open `VSCode`.
+* Navigate to the top left and select `File -> Open folder...`.
+* Select to open to the root directory of `ReflexEngine`.
+* Open command palette. (Ctrl+Shift+P)
+  * `CMake: Select a kit` -> Your compiler of choice (`Clang` or `MSVC`)
+  * `CMake: Select variant` -> `Release` or `RelWithDebInfo`
+  * `CMake: Set build target` -> `ReflexEngine`
+  * `CMake: Build`
+  * `CMake: Run without debugging`
+
+## Contributing
+
+Please refer to the [contributing guide](CONTRIBUTING.md).
+
+## License
+
+This project is licensed under the [MIT license](LICENSE.md).

cmake/CMakeLists.txt

@@ -1,12 +1,12 @@
-cmake_minimum_required (VERSION 3.17)
+cmake_minimum_required(VERSION 3.17)
 
-function (target_ignore_warnings target scope)
-	get_target_property(lib_include_dirs ${target} INTERFACE_INCLUDE_DIRECTORIES)
-	target_include_directories(${target} SYSTEM ${scope} ${lib_include_dirs})
+function(target_ignore_warnings target scope)
+    get_target_property(lib_include_dirs ${target} INTERFACE_INCLUDE_DIRECTORIES)
+    target_include_directories(${target} SYSTEM ${scope} ${lib_include_dirs})
 endfunction()
 
 # Set to not build docs, tests and examples
-option(ASSIMP_BUILD_TESTS OFF) 
+option(ASSIMP_BUILD_TESTS OFF)
 option(ASSIMP_BUILD_ASSIMP_TOOLS OFF)
 option(GLFW_BUILD_DOCS OFF)
 option(GLFW_BUILD_TESTS OFF)
@@ -19,10 +19,13 @@ option(RP3D_DOUBLE_PRECISION_ENABLED OFF)
 
 # Disable compiler warnings.
 add_compile_options(
+
     # Clang
     $<$<OR:$<CXX_COMPILER_ID:Clang>,$<CXX_COMPILER_ID:AppleClang>>:-Wno-everything>
+
     # GCC
     $<$<CXX_COMPILER_ID:GNU>:-w>
+
     # Visual Studio
     $<$<CXX_COMPILER_ID:MSVC>:/W0>
 )
@@ -34,11 +37,13 @@ add_subdirectory(glfw)
 add_subdirectory(imgui)
 add_subdirectory(lua)
 add_subdirectory(reactphysics3d)
-add_subdirectory(raknet)
+add_subdirectory(entt)
+add_subdirectory(catch2)
 
 target_ignore_warnings(glm INTERFACE)
 target_ignore_warnings(glad INTERFACE)
 target_ignore_warnings(glfw INTERFACE)
 target_ignore_warnings(imgui INTERFACE)
 target_ignore_warnings(lua INTERFACE)
 target_ignore_warnings(reactphysics3d INTERFACE)
+target_ignore_warnings(EnTT INTERFACE)