Merge pull request #14 from avans-night-byte/release/v0.1

avans-night-byte · Oct 11, 2020 · 7bae0e9 · 7bae0e9
2 parents 143250e + cd7d4d7
commit 7bae0e9
Show file tree

Hide file tree

Showing 16 changed files with 80 additions and 15 deletions.
diff --git a/.gitignore b/.gitignore
@@ -21,7 +21,7 @@
 # Compiled Dynamic libraries
 *.so
 *.dylib
-*.dll
+#*.dll
 
 # Fortran module files
 *.mod
@@ -33,10 +33,10 @@
 *.a
 *.lib
 
-# Executables
-*.exe
-*.out
-*.app
+# # Executables
+# *.exe
+# *.out
+# *.app
 
 ### CLion+all ###
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider

diff --git a/.gitmodules b/.gitmodules
@@ -11,3 +11,7 @@
 	url = https://github.com/avans-night-byte/game.git
 	ignore = all
 	branch = develop
+
+[submodule "SDL_image"]
+	path = Libraries/SDL_image
+	url = https://github.com/SDL-mirror/SDL_image
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,5 +1,7 @@
 cmake_minimum_required(VERSION 3.17)
 
+set(CMAKE_EXE_LINKER_FLAGS "-static-libgcc -static-libstdc++ -static")
+
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CURRENT_BINARY_DIR ./build)
 set(CMAKE_CURRENT_SOURCE_DIR .)
@@ -17,4 +19,4 @@ add_executable(NightByte ./Main.cpp
                          ./API/Input/EngineInputAPI.cpp)
 
 target_include_directories(NightByte PUBLIC ${SDL2_SOURCE_DIR}/include)
-target_link_libraries(NightByte SDL2)
+target_link_libraries(NightByte SDL2 winpthread)
diff --git a/Engine/Input/Adapter/SDLInputEngineAdapter.cpp b/Engine/Input/Adapter/SDLInputEngineAdapter.cpp
@@ -98,7 +98,13 @@ Input SDLInputEngineAdapter::getControllerInput(SDL_Event controllerEvent) const
     return Input{.device = Input::CONTROLLER, .x = -1, .y = -1, .keyMap = keyMap};
 }
 
-// Note from drunk Marco to sober Marco: Don't forget to fix this.
+/**
+ * Handles Axis motion events for the controller. 
+ * Note: At this time this only logs which axis was moved.
+ * 
+ * @param SDL_Event controllerEvent - SDL Event that was received.
+ * @returns Input{device, x, y, keyMap}
+ */
 Input SDLInputEngineAdapter::getControllerMotionInput(SDL_Event controllerEvent) const
 {
 

diff --git a/Game b/Game
diff --git a/Libraries/Box2D b/Libraries/Box2D
diff --git a/Libraries/SDL b/Libraries/SDL
diff --git a/Libraries/SDL_image b/Libraries/SDL_image
diff --git a/Main.cpp b/Main.cpp
@@ -8,7 +8,6 @@
 const int width = 640;
 const int height = 480;
 
-// TODO: This should be moved to the engine
 int main(int argc, char *args[])
 {
     std::cout << "Hello, Night Byte" << std::endl;

diff --git a/NightByte.png b/NightByte.png
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
-# avans-engine
-Contains the engine for Avans minor Software Architecture
+# Night Byte Engine
+
+<p align="center">
+  <img src="NightByte.png" height="400px;" />
+</p>
+
+## Run the executable
+
+Run the latest executable provided in the `builds` folder or download the executable from the [latest release](https://github.com/avans-night-byte/engine/releases).
+
+At this moment in time the application only returns given input to the console. Please start the executable from your terminal to see the Input functionality.
+
+## Build and run the project
+
+There are two ways to build and run the project: Use a provided script file or build manually. The scripts require dependencies to be installed already and are mostly used after setting up your environment. Read the script files for any dependencies you might have to install or use the wiki.
+
+### Linux
+
+Run `run.sh` from the root of the project or follow the [instructions on our wiki](https://github.com/avans-night-byte/engine/wiki/Project-Setup-%5BLinux%5D) to build manually.
+
+### Windows
+
+Run `run.bat` from the root of the project or follow the [instructions on our wiki](https://github.com/avans-night-byte/engine/wiki/Project-Setup-%5BWindows%5D)
diff --git a/builds/NightByte b/builds/NightByte
diff --git a/builds/NightByte.exe b/builds/NightByte.exe
diff --git a/builds/SDL2.dll b/builds/SDL2.dll
diff --git a/run.bat b/run.bat
@@ -0,0 +1,21 @@
+@echo off
+
+rem This script attempts to build and run the project for Windows.
+rem See https://github.com/avans-night-byte/engine/wiki/Project-Setup-%5BWindows%5D for manual setup.
+rem Dependencies: make, cmake, gcc/g++, git
+
+rem 1. Pull/Update gitmodules
+git submodule update --init --recursive  --remote
+
+rem 2. Generate a makefile and buildfolder
+cmake -S . -B ./build -G "MinGW Makefiles"
+cd build
+
+rem 3. Create a binary
+make
+cd bin
+
+rem 4. Run the executable
+NightByte.exe
+
+pause
diff --git a/run.sh b/run.sh
@@ -1,7 +1,18 @@
 #!/bin/bash
+# This script attempts to build and run the project for Linux.
+# See https://github.com/avans-night-byte/engine/wiki/Project-Setup-%5BLinux%5D for manual setup.
+# Dependencies: make, cmake, gcc/g++, git
 
+# 1. Pull/Update gitmodules
+git submodule update --recursive --init --remote
+
+# 2. Generate a makefile and buildfolder
 cmake -S . -B ./build/
 cd build
+
+# 3. Create a binary
 make
-cd ..
-./build/bin/NightByte
+cd bin
+
+# 4. Run the executable
+./NightByte
+1 −1		README.md
+0 −4		include/box2d/b2_common.h
+32 −0		include/box2d/b2_contact.h
+23 −0		include/box2d/b2_fixture.h
+1 −0		include/box2d/b2_gear_joint.h
+3 −1		include/box2d/b2_rope.h
+1 −0		src/dynamics/b2_contact.cpp
+2 −1		src/dynamics/b2_contact_solver.cpp
+1 −0		src/dynamics/b2_contact_solver.h
+1 −1		src/dynamics/b2_distance_joint.cpp
+2 −0		src/dynamics/b2_fixture.cpp
+6 −0		src/dynamics/b2_gear_joint.cpp
+1 −1		src/dynamics/b2_prismatic_joint.cpp
+1 −1		src/dynamics/b2_revolute_joint.cpp
+40 −0		src/rope/b2_rope.cpp
+1 −1		testbed/tests/gear_joint.cpp
+8 −1		testbed/tests/restitution.cpp
+3 −3		testbed/tests/rope.cpp
+2 −1		unit-test/CMakeLists.txt
+1 −2		unit-test/collision_test.cpp
+1 −2		unit-test/hello_world.cpp
+106 −0		unit-test/joint_test.cpp
+1 −2		unit-test/math_test.cpp
+2 −2		unit-test/world_test.cpp
+4 −0		CMakeLists.txt
+3 −0		configure
+3 −0		configure.ac
+1 −0		src/cpuinfo/SDL_cpuinfo.c
+49 −0		src/misc/riscos/SDL_sysurl.c
+1 −1		test/Makefile.os2