OpenGL

.github/workflows/compilation.yml

@@ -46,7 +46,7 @@ jobs:
         sudo apt-get update
         sudo apt-get -y install cmake cmake-data libargtable2-dev libcunit1-dev \
           libsdl2-mixer-dev libconfuse-dev libenet-dev libsdl2-dev libxmp-dev libpng-dev \
-          clang-tidy ${{ matrix.config.cc }}
+          libepoxy-dev clang-tidy ${{ matrix.config.cc }}
 
     - name: Build tests
       run: |
@@ -77,7 +77,7 @@ jobs:
       run: |
         sudo apt-get update
         sudo apt-get -y install cmake libargtable2-dev libcunit1-dev libsdl2-mixer-dev \
-          libconfuse-dev libenet-dev libsdl2-dev libxmp-dev libpng-dev
+          libconfuse-dev libenet-dev libsdl2-dev libxmp-dev libpng-dev libepoxy-dev
 
     - name: Generate Release
       run: |
@@ -107,7 +107,7 @@ jobs:
         maintainer: ${{ github.repository_owner }}
         version: 0.6.6-${{ steps.slug.outputs.sha8 }}
         arch: 'amd64'
-        depends: 'libargtable2, libsdl2-mixer, libconfuse, libenet, libsdl2, libxmp, libpng'
+        depends: 'libargtable2, libsdl2-mixer, libconfuse, libenet, libsdl2, libxmp, libpng, libepoxy0'
         desc: 'One Must Fall 2097 Remake'
 
     - name: Upload DEB artifact
@@ -130,7 +130,7 @@ jobs:
     - name: Install Mac Dependencies
       run: |
         brew update
-        brew install cmake argtable cunit sdl2_mixer confuse enet sdl2 libxmp libpng
+        brew install cmake argtable cunit sdl2_mixer confuse enet sdl2 libxmp libpng libepoxy
 
     - name: Generate Release
       run: |

CMakeLists.txt

@@ -38,12 +38,14 @@ if(GIT_FOUND)
     )
     message(STATUS "Git SHA1 Hash: ${SHA1_HASH}")
     add_definitions(-DSHA1_HASH="${SHA1_HASH}")
-endif()
+endif ()
 
 # System packages (hard dependencies)
 find_package(SDL2 REQUIRED)
 find_package(SDL2_mixer REQUIRED)
 find_package(xmp)
+find_package(OpenGL REQUIRED)
+find_package(Epoxy REQUIRED)
 find_package(enet)
 find_package(confuse)
 find_package(argtable2)
@@ -81,6 +83,8 @@ set(COREINCS
     ${CMAKE_CURRENT_BINARY_DIR}/src/
     ${SDL2_INCLUDE_DIRS}
     ${SDL2_MIXER_INCLUDE_DIRS}
+    ${OPENGL_INCLUDE_DIR}
+    ${EPOXY_INCLUDE_DIR}
     ${CONFUSE_INCLUDE_DIR}
     ${Intl_INCLUDE_DIR}
     ${XMP_INCLUDE_DIR}
@@ -124,24 +128,30 @@ add_library(openomf_core OBJECT ${OPENOMF_SRC})
 set(CORELIBS openomf_core ${CORELIBS})
 
 # Set icon for windows executable
-if(WIN32)
+if (WIN32)
     SET(ICON_RESOURCE "resources/icons/openomf.rc")
-endif()
+endif ()
 
 # Build the game binary
 add_executable(openomf src/main.c src/engine.c ${ICON_RESOURCE})
 
+# This is used to copy shader files from source directory to the binary output directory during compile.
+add_custom_target(
+    copy_shaders ALL
+    COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/shaders ${CMAKE_BINARY_DIR}/shaders
+)
+add_dependencies(openomf copy_shaders)
+
 # Build tools if requested
 set(TOOL_TARGET_NAMES)
-if(USE_TOOLS)
+if (USE_TOOLS)
     add_executable(bktool tools/bktool/main.c
-                          tools/shared/animation_misc.c
-                          tools/shared/conversions.c)
+            tools/shared/animation_misc.c
+            tools/shared/conversions.c)
     add_executable(aftool tools/aftool/main.c
-                          tools/shared/animation_misc.c
-                          tools/shared/conversions.c)
+            tools/shared/animation_misc.c
+            tools/shared/conversions.c)
     add_executable(soundtool tools/soundtool/main.c)
-    add_executable(fonttool tools/fonttool/main.c)
     add_executable(languagetool tools/languagetool/main.c)
     add_executable(omf_parse tools/stringparser/main.c)
     add_executable(afdiff tools/afdiff/main.c)
@@ -157,7 +167,6 @@ if(USE_TOOLS)
         bktool
         aftool
         soundtool
-        fonttool
         languagetool
         omf_parse
         afdiff
@@ -238,9 +247,10 @@ endif()
 
 # Make sure libraries are linked
 target_link_libraries(openomf ${CORELIBS})
-target_link_libraries(openomf SDL2::Main SDL2::Mixer)
+target_link_libraries(openomf SDL2::Main SDL2::Mixer OpenGL::GL Epoxy::Main)
 foreach(TARGET ${TOOL_TARGET_NAMES})
-    target_link_libraries(${TARGET} ${CORELIBS} SDL2::Main SDL2::Mixer)
+    target_link_libraries(${TARGET} ${CORELIBS})
+    target_link_libraries(${TARGET} SDL2::Main SDL2::Mixer OpenGL::GL Epoxy::Main)
 endforeach()
 
 # Testing stuff
@@ -258,7 +268,7 @@ if(CUNIT_FOUND)
     target_compile_definitions(openomf_test_main PRIVATE
                                TESTS_ROOT_DIR="${CMAKE_SOURCE_DIR}/testing")
 
-    target_link_libraries(openomf_test_main ${CORELIBS} SDL2::Main SDL2::Mixer)
+    target_link_libraries(openomf_test_main ${CORELIBS} SDL2::Main SDL2::Mixer OpenGL::GL Epoxy::Main)
 
     if(MINGW)
         # Always build as a console executable with mingw
@@ -281,12 +291,15 @@ if(WIN32)
     # This way we have an "openomf/" root directory inside the zip file.
     install(TARGETS openomf RUNTIME DESTINATION openomf/ COMPONENT Binaries)
     install(FILES resources/openomf.bk DESTINATION openomf/resources/ COMPONENT Data)
+    install(DIRECTORY shaders/ DESTINATION openomf/shaders COMPONENT Data)
     install(FILES README.md INSTALL.md LICENSE DESTINATION openomf/ COMPONENT Data)
 else()
     # On unixy systems, follow standard.
     install(TARGETS openomf RUNTIME DESTINATION bin COMPONENT Binaries)
-    install(FILES resources/openomf.bk resources/icons/openomf.png
+    install(
+        FILES resources/openomf.bk resources/icons/openomf.png
         DESTINATION share/games/openomf/
         COMPONENT Data
     )
+    install(DIRECTORY shaders/ DESTINATION share/games/openomf/shaders COMPONENT Data)
 endif()

INSTALL.md

@@ -19,10 +19,7 @@ instructions are also available there.
 2. Extract the zip file somewhere on your computer. If possible, use a directory other
    than "C:\Program Files".
 3. Install the game resources. Please see step 3. of this guide for this.
-4. [optional] If you wish, you may install an xBRZ sprite scaler plugin.
-   This can be found from https://github.com/omf2097/openomf-scaler-xbrz/releases .
-   Note that this is not necessary for running the game.
-5. Start the game by running openomf.exe.
+4. Start the game by running openomf.exe.
 
 ### Ubuntu
 
@@ -42,7 +39,8 @@ Compiling from source should be your last option, unless you know what you are d
 Use at least GCC 9 or Clang 10. MSVC is not supported at this time.
 
 Required:
-* SDL2 (>=2.0.16): http://www.libsdl.org/download-2.0.php
+* SDL2 (>=2.0.18): http://www.libsdl.org/download-2.0.php
+* libepoxy: https://github.com/anholt/libepoxy
 * confuse: http://www.nongnu.org/confuse/
 * Gettext (if you have problems with libintl)
 * Enet: http://enet.bespin.org/
@@ -55,12 +53,13 @@ Required:
 
 On debian, it is possible to pull some libraries using apt-get.
 ```
-apt-get install libsdl2-dev libsdl2-mixer-dev libpng-dev libconfuse-dev libenet-dev libargtable2-dev libxmp-dev
+apt-get install libsdl2-dev libsdl2-mixer-dev libpng-dev libconfuse-dev libenet-dev \
+    libargtable2-dev libxmp-dev libepoxy-dev libopengl-dev
 ```
 
 On Mac, you can use brew:
 ```
-brew install argtable sdl2_mixer confuse enet sdl2 libxmp libpng
+brew install argtable sdl2_mixer confuse enet sdl2 libxmp libpng libepoxy
 ```
 
 ### Acquiring the sources

cmake-scripts/FindCUnit.cmake

@@ -16,12 +16,14 @@ FIND_LIBRARY(CUNIT_LIBRARY cunit
     PATHS ${CUNIT_SEARCH_PATHS}
 )
 
-IF(CUNIT_INCLUDE_DIR AND CUNIT_LIBRARY)
-   SET(CUNIT_FOUND TRUE)
-ENDIF(CUNIT_INCLUDE_DIR AND CUNIT_LIBRARY)
+IF (CUNIT_INCLUDE_DIR AND CUNIT_LIBRARY)
+    SET(CUNIT_FOUND TRUE)
+ENDIF (CUNIT_INCLUDE_DIR AND CUNIT_LIBRARY)
 
-IF(CUNIT_FOUND)
+IF (CUNIT_FOUND)
     MESSAGE(STATUS "Found CUnit: ${CUNIT_LIBRARY}")
-ELSE(CUNIT_FOUND)
+ELSE (CUNIT_FOUND)
     MESSAGE(STATUS "Could not find CUnit. Tests will not be available.")
-ENDIF(CUNIT_FOUND)
+ENDIF (CUNIT_FOUND)
+
+mark_as_advanced(CUNIT_INCLUDE_DIR CUNIT_LIBRARY CUNIT_SEARCH_PATHS)

cmake-scripts/FindEpoxy.cmake

@@ -0,0 +1,28 @@
+set(EPOXY_SEARCH_PATHS /usr/local /usr /opt)
+
+find_path(EPOXY_INCLUDE_DIR epoxy/gl.h
+    HINTS
+    PATH_SUFFIXES include
+    PATHS ${EPOXY_SEARCH_PATHS}
+    )
+find_library(EPOXY_LIBRARY epoxy
+    HINTS
+    PATH_SUFFIXES lib64 lib
+    PATHS ${EPOXY_SEARCH_PATHS}
+    )
+
+if (EPOXY_INCLUDE_DIR AND EPOXY_LIBRARY)
+    set(EPOXY_FOUND TRUE)
+endif ()
+
+if (EPOXY_FOUND)
+    add_library(Epoxy::Main UNKNOWN IMPORTED)
+    set_target_properties(Epoxy::Main PROPERTIES
+        IMPORTED_LOCATION "${EPOXY_LIBRARY}"
+        INTERFACE_INCLUDE_DIRECTORIES "${EPOXY_INCLUDE_DIR}")
+    message(STATUS "Found libepoxy: ${EPOXY_LIBRARY}")
+else ()
+    message(WARNING "Could not find libepoxy")
+endif ()
+
+mark_as_advanced(EPOXY_INCLUDE_DIR EPOXY_LIBRARY EPOXY_SEARCH_PATHS)

cmake-scripts/Findconfuse.cmake

@@ -16,13 +16,14 @@ FIND_LIBRARY(CONFUSE_LIBRARY confuse
     PATHS ${CONFUSE_SEARCH_PATHS}
 )
 
-IF(CONFUSE_INCLUDE_DIR AND CONFUSE_LIBRARY)
-   SET(CONFUSE_FOUND TRUE)
+IF (CONFUSE_INCLUDE_DIR AND CONFUSE_LIBRARY)
+    SET(CONFUSE_FOUND TRUE)
 ENDIF (CONFUSE_INCLUDE_DIR AND CONFUSE_LIBRARY)
 
-
-IF(CONFUSE_FOUND)
+IF (CONFUSE_FOUND)
     MESSAGE(STATUS "Found libConfuse: ${CONFUSE_LIBRARY}")
-ELSE(CONFUSE_FOUND)
+ELSE (CONFUSE_FOUND)
     MESSAGE(WARNING "Could not find libConfuse")
-ENDIF(CONFUSE_FOUND)
+ENDIF (CONFUSE_FOUND)
+
+mark_as_advanced(CONFUSE_INCLUDE_DIR CONFUSE_LIBRARY CONFUSE_SEARCH_PATHS)

cmake-scripts/Findenet.cmake

@@ -16,13 +16,14 @@ FIND_LIBRARY(ENET_LIBRARY enet
     PATHS ${ENET_SEARCH_PATHS}
 )
 
-IF(ENET_INCLUDE_DIR AND ENET_LIBRARY)
-   SET(ENET_FOUND TRUE)
+IF (ENET_INCLUDE_DIR AND ENET_LIBRARY)
+    SET(ENET_FOUND TRUE)
 ENDIF (ENET_INCLUDE_DIR AND ENET_LIBRARY)
 
-
-IF(ENET_FOUND)
+IF (ENET_FOUND)
     MESSAGE(STATUS "Found ENet: ${ENET_LIBRARY}")
-ELSE(ENET_FOUND)
+ELSE (ENET_FOUND)
     MESSAGE(WARNING "Could not find ENet")
-ENDIF(ENET_FOUND)
+ENDIF (ENET_FOUND)
+
+mark_as_advanced(ENET_INCLUDE_DIR ENET_LIBRARY ENET_SEARCH_PATHS)

cmake-scripts/Findxmp.cmake

@@ -20,9 +20,10 @@ IF(XMP_INCLUDE_DIR AND XMP_LIBRARY)
    SET(XMP_FOUND TRUE)
 ENDIF()
 
-
 IF(XMP_FOUND)
     MESSAGE(STATUS "Found libxmp: ${XMP_LIBRARY}")
 ELSE()
     MESSAGE(WARNING "Could not find libxmp")
 ENDIF()
+
+mark_as_advanced(XMP_INCLUDE_DIR XMP_LIBRARY XMP_SEARCH_PATHS)

packaging/debian/CMakeLists.txt

@@ -7,7 +7,7 @@ SET(CPACK_PACKAGING_INSTALL_PREFIX "/tmp")
 SET(CPACK_DEBIAN_PACKAGE_PRIORITY "optional")
 SET(CPACK_DEBIAN_PACKAGE_SECTION "extra")
 SET(CPACK_DEBIAN_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR})
-SET(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6, libsdl2-2.0-0 (>= 2.0.3), libsdl2-mixer-2.0-0, libconfuse0, libenet7, libpng16-16, libxmp4")
+SET(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6, libsdl2-2.0-0 (>= 2.0.3), libsdl2-mixer-2.0-0, libconfuse0, libenet7, libpng16-16, libxmp4, libepoxy0")
 SET(CPACK_DEBIAN_PACKAGE_MAINTAINER "Tuomas Virtanen <katajakasa@gmail.com>")
 SET(CPACK_DEB_COMPONENT_INSTALL 1)
 

shaders/palette.frag

@@ -0,0 +1,49 @@
+#version 330 core
+
+layout (location = 0) out vec4 color;
+
+in vec2 tex_coord;
+in vec2 fbo_coord;
+flat in int blend_mode;
+flat in int palette_offset;
+flat in int palette_limit;
+
+uniform sampler2D atlas;
+uniform sampler2D framebuffer;
+layout (std140) uniform remaps {
+    vec4 mappings[19 * 256];
+};
+
+void main() {
+    // Get rid of the branching later! We can split this into two or three shaders pretty easily
+    // TODO: FIX LATER.
+    if (blend_mode == 0) {
+        vec4 texel = texture(atlas, tex_coord);
+        if (texel.g == 0) {
+            discard;
+        }
+        vec4 src = texture(framebuffer, fbo_coord);
+        int pal_index = int(src.r * 256.0);
+        if (pal_index <= palette_limit) {
+            pal_index = clamp(palette_limit, 0, pal_index + palette_offset);
+        }
+        float sprite_index = texel.r * 255.0;
+        int layer = int(clamp(18.9, 0.0, sprite_index + 3.0));
+        int index = clamp(255, 0, pal_index);
+        int offset = layer * 256 + index;
+        float red = mappings[offset].r;
+        color = vec4(red, 0.0, 0.0, 1.0);
+    } else if (blend_mode == 1) {
+        vec4 texel = texture(atlas, tex_coord);
+        if (texel.g == 0) {
+            discard;
+        }
+        int pal_index = int(texel.r * 256.0);
+        if (pal_index <= palette_limit) {
+            pal_index = clamp(palette_limit, 0, pal_index + palette_offset);
+        }
+        color = vec4(pal_index / 255.0, 0.0, 0.0, 1.0);
+    } else {
+        color = texture(framebuffer, tex_coord).rgba;
+    }
+}

shaders/palette.vert

@@ -0,0 +1,26 @@
+#version 330 core
+
+layout (location = 0) in vec2 position;
+layout (location = 1) in vec2 tex_offset;
+layout (location = 2) in int mode;
+layout (location = 3) in int pal_offset;
+layout (location = 4) in int pal_limit;
+uniform mat4 projection;
+
+out vec2 tex_coord;
+out vec2 fbo_coord;
+flat out int blend_mode;
+flat out int palette_offset;
+flat out int palette_limit;
+
+void main() {
+    blend_mode = mode;
+    palette_offset = pal_offset;
+    palette_limit = pal_limit;
+    tex_coord = tex_offset.xy;
+    fbo_coord = vec2(
+        position.x / 320.0,
+        (200.0 - position.y) / 200.0
+    );
+    gl_Position = projection * vec4(position.xy, 0.0, 1.0);
+}

shaders/rgba.frag

@@ -0,0 +1,17 @@
+#version 330 core
+
+// In
+in vec2 tex_coord;
+layout (std140) uniform palette {
+    vec4 colors[256];
+};
+uniform sampler2D framebuffer;
+
+// Out
+layout (location = 0) out vec4 color;
+
+void main() {
+    vec4 texel = texture(framebuffer, tex_coord);
+    int index = int(texel.r * 255);
+    color = colors[index].rgba;
+}