PBR rendering and various improvements

.gitignore

@@ -2,3 +2,7 @@
 .DS_Store
 build
 src/resources.c*
+MarbleMarcher.app
+winBuild
+MarbleMarcher.exe
+MarbleMarcher

CMakeLists.txt

@@ -1,19 +1,129 @@
 cmake_minimum_required(VERSION 3.0)
 project(MarbleMarcher)
-set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD 17)
+
+#
+# Try to find AntTweakBar library and include path.
+# Once done this will define
+#
+# ANT_TWEAK_BAR_FOUND
+# ANT_TWEAK_BAR_INCLUDE_DIR
+# ANT_TWEAK_BAR_LIBRARY
+#
+
+IF (WIN32)
+	IF( CMAKE_SIZEOF_VOID_P EQUAL 8 )
+	  SET( BITS "64" )
+    ELSE( CMAKE_SIZEOF_VOID_P EQUAL 8 )
+      SET( BITS "" )
+    ENDIF( CMAKE_SIZEOF_VOID_P EQUAL 8 )
+
+	FIND_PATH( ANT_TWEAK_BAR_INCLUDE_DIR AntTweakBar.h
+      PATHS
+		${PROJECT_SOURCE_DIR}/../../external/AntTweakBar/include
+		${PROJECT_SOURCE_DIR}/../external/AntTweakBar/include
+		${PROJECT_SOURCE_DIR}/external/AntTweakBar/include
+		$ENV{ANT_TWEAK_BAR_ROOT}/include
+		DOC "The directory where AntTweakBar.h resides")
+
+    FIND_LIBRARY( ANT_TWEAK_BAR_LIBRARY AntTweakBar${BITS}
+        PATHS
+		${PROJECT_SOURCE_DIR}/../../external/AntTweakBar/lib
+		${PROJECT_SOURCE_DIR}/../external/AntTweakBar/lib
+		${PROJECT_SOURCE_DIR}/external/AntTweakBar/lib
+                $ENV{ANT_TWEAK_BAR_ROOT}/lib
+                DOC "The AntTweakBar library")
+ELSE (WIN32)
+
+FIND_PATH(ANT_TWEAK_BAR_INCLUDE_DIR AntTweakBar.h
+  PATHS
+  ${LIBIGL_INCLUDE_DIR}/../external/AntTweakBar/include/
+  ${PROJECT_SOURCE_DIR}/../../external/AntTweakBar/include/
+  ${PROJECT_SOURCE_DIR}/../external/AntTweakBar/include/
+  ${PROJECT_SOURCE_DIR}/external/AntTweakBar/include/
+  /usr/local/include
+  /usr/X11/include
+  /usr/include
+  NO_DEFAULT_PATH)
+
+FIND_LIBRARY( ANT_TWEAK_BAR_LIBRARY AntTweakBar
+  PATHS
+		${LIBIGL_INCLUDE_DIR}/../external/AntTweakBar/lib
+    ${PROJECT_SOURCE_DIR}/../../external/AntTweakBar/lib
+    ${PROJECT_SOURCE_DIR}/../external/AntTweakBar/lib
+		${PROJECT_SOURCE_DIR}/external/AntTweakBar/lib
+    /usr/local
+    /usr/X11
+    /usr
+  PATH_SUFFIXES
+    a
+    lib64
+    lib
+    dylib
+    NO_DEFAULT_PATH
+)
+
+ENDIF (WIN32)
+
+
+SET(ANTTWEAKBAR_FOUND "NO")
+IF (ANT_TWEAK_BAR_INCLUDE_DIR AND ANT_TWEAK_BAR_LIBRARY)
+	SET(ANTTWEAKBAR_FOUND "YES")
+ENDIF (ANT_TWEAK_BAR_INCLUDE_DIR AND ANT_TWEAK_BAR_LIBRARY)
+
+set(ANT_TWEAK_BAR_INCLUDE_DIR ${ANT_TWEAK_BAR_INCLUDE_DIR} ${ANT_TWEAK_BAR_INCLUDE_DIR}/../src/)
+
+# message(FATAL_ERROR ${ANT_TWEAK_BAR_LIBRARY})
+
+if(ANT_TWEAK_BAR_INCLUDE_DIR AND ANT_TWEAK_BAR_LIBRARY)
+	message(STATUS "Found ANTTWEAKBAR: ${ANT_TWEAK_BAR_INCLUDE_DIR}")
+else(ANT_TWEAK_BAR_INCLUDE_DIR AND ANT_TWEAK_BAR_LIBRARY)
+	if (NOT ANTTWEAKBAR_FIND_QUIETLY)
+		message(FATAL_ERROR "could NOT find ANTTWEAKBAR")
+	endif (NOT ANTTWEAKBAR_FIND_QUIETLY)
+
+
+endif(ANT_TWEAK_BAR_INCLUDE_DIR AND ANT_TWEAK_BAR_LIBRARY)
+
+FILE(GLOB
+  ANT_TWEAK_BAR_SOURCES
+  ${ANT_TWEAK_BAR_INCLUDE_DIR}/../src/*.c
+  ${ANT_TWEAK_BAR_INCLUDE_DIR}/../src/*.cpp)
 
 ## DEPENDENCIES
 
-find_package(Eigen3 3.3 REQUIRED)
+IF (WIN32)
+set(SFML_DIR C:/Libraries/SFML-2.5.1_64/lib/cmake/SFML)
+set(SFML_INCLUDE_DIR C:/Libraries/SFML-2.5.1_64/include)
+set(SDK_DIRECTORY "C:/Program Files (x86)/Microsoft SDKs")
+set(EIGEN3_INCLUDE_DIR C:/Libraries/eigen3/)
+set(GLEW_INCLUDE_DIR C:/Libraries/GLEW)
+set(GLM_INCLUDE_DIR C:/Libraries/glm)
+set(SFML_STATIC_LIBRARIES TRUE)
+ELSE (WIN32)
+set(SFML_INCLUDE_DIR /usr/local/include)
+set(EIGEN3_INCLUDE_DIR /usr/local/include/eigen3)
+ENDIF (WIN32)
+
 find_package(SFML 2.5 COMPONENTS system window graphics audio REQUIRED)
 
 ## TARGETS
 
 add_subdirectory(src)
 target_include_directories(MarbleMarcherSources PUBLIC
+  src
   ${EIGEN3_INCLUDE_DIR}
   ${SFML_INCLUDE_DIR}
+  ${GLEW_INCLUDE_DIR}/include
+  ${GLM_INCLUDE_DIR}
+  ${ANT_TWEAK_BAR_INCLUDE_DIR}
 )
+
+include_directories(${ANT_TWEAK_BAR_LIBRARY})
+IF (WIN32)
+include_directories(${SDK_DIRECTORY}/Windows/v7.1/Include)
+ENDIF (WIN32)
+
 target_compile_definitions(MarbleMarcherSources PRIVATE SFML_STATIC)
 
 if(WIN32)
@@ -22,9 +132,17 @@ if(WIN32)
 else()
   add_executable(MarbleMarcher src/Main.cpp)
 endif()
+
+add_custom_command(TARGET MarbleMarcher PRE_BUILD
+                   COMMAND ${CMAKE_COMMAND} -E copy_directory
+                       ${CMAKE_SOURCE_DIR}/game_folder $<TARGET_FILE_DIR:MarbleMarcher>)
+
+
 target_compile_definitions(MarbleMarcher PRIVATE SFML_STATIC)
 target_link_libraries(MarbleMarcher
   MarbleMarcherSources
+  ${ANT_TWEAK_BAR_LIBRARY}
+  ${GLEW_INCLUDE_DIR}/lib/Release/x64/glew32.lib
   sfml-system
   sfml-window
   sfml-graphics

README.md

@@ -1,65 +1,167 @@
-# Marble Marcher
-
-[![Build Status](https://travis-ci.org/jgoldfar/MarbleMarcher.svg?branch=master)](https://travis-ci.org/jgoldfar/MarbleMarcher)
-
-Marble Marcher is a video game demo that uses a fractal physics engine and fully procedural rendering to produce beautiful and unique gameplay unlike anything you've seen before.
-
-The goal of the game is to reach the flag as quickly as possible.  But be careful not to
-fall off the level or get crushed by the fractal!  There are 24 levels to unlock.
-
-Download Link: https://codeparade.itch.io/marblemarcher
-
-Video Explanation: https://youtu.be/9U0XVdvQwAI
+# Marble Marcher: Community Edition
+
+### Version 1.4.0 beta
+
+![Logo](https://github.com/MichaelMoroz/MarbleMarcher/blob/master/doc/LOGO.PNG)
+
+This is the community edition of Marble Marcher, a procedurally rendered fractal physics marble game in which you must get to the flag in each level as fast as you can. With 24 levels to unlock and an active [speedrunning community](https://www.speedrun.com/marblemarcher), along with a rudimentary level editor, there's always new features being developed. If you complete all levels, you can use cheats to create and enhance a more exploratory experience.
+
+Because version 1.1.0 was the last feature update of Marble Marcher, we (the Marble Marcher Speedrunning Community) opted to create a community edition to keep the community around the game alive and continuously improve the experience.
+Currently this is maintained mainly by members of the [Marble Marcher Speedrunning Community on Discord](https://discord.gg/r3XrJxH), in addition to the members of the [subreddit](https://www.reddit.com/r/marblemarcher) and anyone else who has contributed.
+
+All credit goes to [HackerPoet](https://github.com/HackerPoet) (aka [CodeParade](https://www.youtube.com/channel/UCrv269YwJzuZL3dH5PCgxUw)) for the [original game](https://github.com/HackerPoet/MarbleMarcher).
+
+## Original Summary
+*Marble Marcher is a video game demo that uses a fractal physics engine and fully procedural rendering to produce beautiful and unique gameplay unlike anything you've seen before.*
+
+*The goal of the game is to reach the flag as quickly as possible.  But be careful not to*
+*fall off the level or get crushed by the fractal!  There are 24 levels to unlock.*
+
+*Download Link: https://codeparade.itch.io/marblemarcher*
+
+*Video Explanation: https://youtu.be/9U0XVdvQwAI*
+
+## Table of Contents
+- [Changes](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#changes)
+- [Proposed changes](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#proposed-changes)
+- [System Dependencies](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#system-dependencies)
+  - [macOS](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#macos)
+  - [Arch Linux](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#arch-linux)
+- [Building](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#building)
+  - [macOS](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#macos-1)
+  - [Arch Linux](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#arch-linux-1)
+  - [Compiling on Windows](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#compiling-on-windows)
+  - [Cross-Compile for Windows (macOS)](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#cross-compile-for-windows-on-macos)
+- [Launching](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#launching)
+  - [macOS](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#macos-2)
+  - [Other OSes](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#windowslinuxanything-else)
+- [Other](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#other)
+  - [Shortcuts](https://github.com/WAUthethird/Marble-Marcher-Community-Edition/blob/master/README.md#shortcuts)
+
+## Changes
+- numerous miscellaneous fixes have been applied
+- easier compilation for macOS
+- feasible Windows compilation
+- README.md overhaul
+- new rendering engine
+- ingame statistics added (marble speed, ground/air state, ...). Press `o` to toggle.
+- AntTweakBar editor added. Press `F4` to toggle.
+- Level Editor and custom level support
+![Editor](https://github.com/MichaelMoroz/MarbleMarcher/blob/master/doc/EDITOR.PNG)
+![Levels](https://github.com/MichaelMoroz/MarbleMarcher/blob/master/doc/LEVELS.PNG)
+
+
+## Proposed Changes
+Though Marble Marcher CE is a largely finished game, there are still several improvements we'd like to implement. Here are our proposed changes:
+
+- ### Fixes
+  - make sure game runs at the same speed everywhere
+  - mouse/camera speed is too fast while skipping cutscenes
+  - figure out why so many people get `Failed to compile vertex shader`
+- ### User Experience Improvements
+  - pre-built versions for the common operating systems and make them available as GitHub releases (in progress)
+  - make the fractal recoloring from cheats persistent
+  - more efficient anti-aliasing modes
+  - toggle to always activate fast cutscenes
+  - better autosplitter integration
+  - #### UI Redesign
+    - confirmation, exit buttons in end screens
+    - change "controls" menu to "settings" and have audio, controls, sensitivity and fullscreen options there, also allow custom input bindings
+    - improve text rendering
+    - better layout
+- ### New Features
+  - cheat: no drag
+  - anaglyph/stereoscopic mode
+  - screenshot mode (temporarily higher resolution and AA)
+  - native controller support (+deadzone)
+  - custom marble designs
+  - add a script to build for all platforms at once
+  - have MarbleMarcher added to package managers
+- ### Currently WIP
+  - in-game level editor
+  - metal marble skin
+  - custom map support
+  - recording/replay functionality
+  - debug info screen
+  - cheat: unlock all levels
+  - add creation of macOS `.dmg` for easy distribution.
 
 ## System Dependencies
 * [Eigen](http://eigen.tuxfamily.org/index.php?title=Main_Page)
 * [SFML 2.5.0](https://www.sfml-dev.org)
+* [AntTweakBar](http://anttweakbar.sourceforge.net/)
+* [CMake](https://cmake.org/)
+* [OpenAL](https://www.openal.org/) (in case you get an "OpenAL DLL not found" error while trying to run the software, seems to be Windows-specific)
 ### MacOS
-On macOS these can be conveniently installed using [Homebrew](https://brew.sh):
+On macOS these can be conveniently installed using [HomeBrew](https://brew.sh):
 
-`brew install eigen sfml`
+`brew install cmake eigen sfml anttweakbar`
 
-(Note that SFML might require a newer version than the one from Homebrew, in which case a manual installation is required)
+The version of SFML required is 2.5.1 or newer. It has come to my attention that HomeBrew does now have this version (unlike when these instructions where first written) so installing via HomeBrew should work but you can still [download manually](https://www.sfml-dev.org/download/sfml/2.5.1/) if you wish and install using [these instructions](https://www.sfml-dev.org/tutorials/2.5/start-osx.php). You must install the Frameworks option not the dylib option or the build script may fail.
+**Note that if HomeBrew installed a version of SFML older than 2.5.1 for some reason or you wish to install manually, you must remove the version of SFML that Brew installed using `brew remove sfml`.**
 
-Alternatively, [vcpkg](https://github.com/Microsoft/vcpkg) can be used:
+Alternatively, [vcpkg](https://github.com/Microsoft/vcpkg) can be used though it is unsupported:
 
-`vcpkg install eigen3 sfml`
+`vcpkg install cmake eigen3 sfml anttweakbar`
+r
+It may also be possible to use MacPorts which is also unsupported and untested.
 ### Arch Linux
-`sudo pacman -S eigen sfml git cmake make`
-
+`sudo pacman -S eigen sfml anttweakbar git cmake make`
 
 
 ## Building
 ### MacOS
+#### Build Script
+**Note for the current version: the macOS build is not yet entirely working properly so revert to the previous prerelease as required. SFML is properly included but as of yet, AntTweakBar is not so this executable will not work on machines without it installed.**
+Simply run `./macOSBuild.sh`. This will generate the full Application bundle that can be used like any other application. It can even be used on systems without SFML as SFML is included in the bundle and the binary is relinked to these versions. Currently the script will only do the relinking part properly if you use SFML 2.5.1 specifically however it is planned to allow for any version. If you have another version, the script will still work, the app just won't work on a machine without SFML.
+#### Manual
 * `mkdir build && cd build`
 * `cmake ..`
+* `cmake -DCMAKE_CXX_FLAGS="-I/usr/local/include" ..`
     * If you use `vcpkg`, add the flag `-DCMAKE_TOOLCHAIN_FILE=[path/to/vcpkg]/scripts/buildsystems/vcpkg.cmake`
 * `cd ..`
 * `cmake --build build`
 
+Note that this just builds a binary and not an Application bundle like you might be used to seeing. To run properly, you must move the binary (which, after building, is `build/MarbleMarcher`) to the same folder as the assets folder. It is not recommended to build the Application bundle manually so no instructions for that are provided however you may peek in `macOSBuild.sh` to see how it is done.
+
 Alternatively, one can use the platform-dependent build system, for example `Make`:
 
 * `make -C build`
+
 ### Arch Linux
 * `cd ~`
-* `git clone https://github.com/HackerPoet/MarbleMarcher.git`
-* `cd MarbleMarcher`
+* `git clone https://github.com/WAUthethird/Marble-Marcher-Community-Edition.git`
+* `cd Marble-Marcher-Community-Edition`
 * `mkdir build && cd build`
 * `cmake ..`
 * `cd ..`
 * `cmake --build build`
 * `cp build/MarbleMarcher ./`
 
+### Compiling on Windows
+Windows compilation should work just fine now. It's relatively easy to do without help, but in case you'd like them, [here are some configuring and compiling instructions](https://www.reddit.com/r/Marblemarcher/comments/bamqyh/how_to_configure_and_compile_source_for_windows/). A [copy of the instructions](build_on_windows.md) is also in the root.
+
+### Cross-Compile for Windows on macOS
+This requires you to install wget, mingw-w64, and git (which you probably already have) either with HomeBrew (recommended) or otherwise. Theoretically, you should be able to just run `winMacOSBuild.sh`. There are no manual instructions because due to issues I had to just compile the thing manually which is annoying and has too many steps.
 
 ## Launching
+### macOS
+If the macOS build script was used, simply launch the app as normal, otherwise:
 * Make sure that the current working directory contains the `assets` folder
 * Run the executable generated by CMake, located in `build` (or a subdirectory)
 * If running MarbleMarcher from a tarball and you see a message like
 
 > ./MarbleMarcher: error while loading shared libraries: libsfml-graphics.so.2.5: cannot open shared object file: No such file or directory
-
 You'll just need to run MarbleMarcher with the correct `LD_LIBRARY_PATH`:
 
 ```shell
 LD_LIBRARY_PATH=`pwd`/usr/lib ./MarbleMarcher
 ```
+### Windows/Linux/Anything Else
+Launching should be self-explanatory for these systems, just run the excecutable file relevant to your system that is generated by the build process.
+
+## Special Controls
+* Press `o` to toggle the debug screen.
+* Press `F5` to take a screenshot.
+* Press `F4` to open AntTweakBar.
+

build_on_windows.md

@@ -0,0 +1,13 @@
+This is a short and easy tutorial for building Marble Marcher: Community Edition on Windows. The online version of the tutorial can be found [here](https://www.reddit.com/r/Marblemarcher/comments/bamqyh/how_to_configure_and_compile_source_for_windows/). (both this and the one on Reddit are kept up-to-date with each other) This tutorial (the command line parts) can also be followed with Git Bash, though you'll need a developer CMD in administrator mode for at least one process.
+
+1. Make sure you have [CMake](https://cmake.org/), [OpenAL](https://www.openal.org/), and [Visual Studio 2019](https://visualstudio.microsoft.com/vs/) (in addition to the 2015 and/or 2017 VS build tools, if one does not work, try installing the other) installed.
+2. Download the CE edition to a folder of your choice and unzip it: [https://github.com/WAUthethird/Marble-Marcher-Community-Edition](https://github.com/WAUthethird/Marble-Marcher-Community-Edition)
+3. Create a folder in your `C:` drive root called `Libraries`. Alternatively, feel free to configure the paths in `CMakeLists.txt`, in the MMCE root.
+4. Download and unzip Eigen to the `Libraries` folder. I used the .zip version of the 3.3.7 release: [http://eigen.tuxfamily.org/](http://eigen.tuxfamily.org/) Rename the unzipped folder to `eigen3`.
+5. Download and unzip SFML to the `Libraries` folder. I used the 2.5.1 Visual C++ 15 (2017) - 32-bit version: [https://www.sfml-dev.org/download.php](https://www.sfml-dev.org/download.php) Inside the resulting unzipped folder should be just a folder called `SFML-2.5.1`. Move this folder outside its parent folder, into `Libraries`. Delete the now empty parent folder.
+6. Download and unzip AntTweakBar to the `Libraries` folder: [http://anttweakbar.sourceforge.net](http://anttweakbar.sourceforge.net) Inside the resulting unzipped folder should be just a folder called `AntTweakBar`. Move this folder outside its parent folder, into `Libraries`. Delete the now empty parent folder.
+7. Now that you have all libraries in the proper places, open a developer command prompt with administrator privileges and CD into the MMCE root. Run `cmake .`
+8. Open the resulting .sln file in Visual Studio and build the solution.
+
+You're done!
+If this did not work for you, please open an issue in the repository, or comment on the online Reddit post linked above.

game_folder/assets/config.txt

@@ -0,0 +1,6 @@
+#Screenshot width
+2560
+#Screenshot height
+1440
+#Language(write name in English)
+English