- add VGM music support

Author: dgcor

.github/workflows/deploy_linux.yml

@@ -35,7 +35,7 @@ jobs:
 
     - name: Install dependencies
       run: |
-        vcpkg install physfs sfml --triplet=x64-linux
+        vcpkg install libgme[core,vgm] physfs sfml --triplet=x64-linux
 
     - name: Setup Ninja Build
       uses: turtlesec-no/get-ninja@main

.github/workflows/deploy_windows.yml

@@ -22,7 +22,7 @@ jobs:
           core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
 
     - name: Install dependencies
-      run: vcpkg install physfs sfml --triplet=x86-windows-static
+      run: vcpkg install libgme[core,vgm] physfs sfml --triplet=x86-windows-static
 
     - name: Install UPX
       uses: crazy-max/ghaction-upx@v3
@@ -69,7 +69,7 @@ jobs:
           core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
 
     - name: Install dependencies
-      run: vcpkg install physfs sfml --triplet=x64-windows-static
+      run: vcpkg install libgme[core,vgm] physfs sfml --triplet=x64-windows-static
 
     - name: Install UPX
       uses: crazy-max/ghaction-upx@v3

BUILD.txt

@@ -4,15 +4,18 @@ To compile in Windows, you can use CMake or open the folder with Visual Studio 2
 
 The easiest way to get the required dependencies is to use vcpkg.
 
-vcpkg install physfs sfml ffmpeg --triplet=x86-windows
-vcpkg install physfs sfml ffmpeg --triplet=x86-windows-static
-vcpkg install physfs sfml ffmpeg --triplet=x64-windows
-vcpkg install physfs sfml ffmpeg --triplet=x64-windows-static
+vcpkg install libgme[core,vgm] physfs sfml ffmpeg --triplet=x86-windows
+vcpkg install libgme[core,vgm] physfs sfml ffmpeg --triplet=x86-windows-static
+vcpkg install libgme[core,vgm] physfs sfml ffmpeg --triplet=x64-windows
+vcpkg install libgme[core,vgm] physfs sfml ffmpeg --triplet=x64-windows-static
 
 There is a custom vcpkg triplet that links ffmpeg dynamically.
 
-vcpkg install physfs sfml ffmpeg --triplet=x86-windows-static --overlay-triplets=vcpkg/triplets
-vcpkg install physfs sfml ffmpeg --triplet=x64-windows-static --overlay-triplets=vcpkg/triplets
+vcpkg install libgme[core,vgm] physfs sfml ffmpeg --triplet=x86-windows-static --overlay-triplets=vcpkg/triplets
+vcpkg install libgme[core,vgm] physfs sfml ffmpeg --triplet=x64-windows-static --overlay-triplets=vcpkg/triplets
+
+Game_Music_Emu - https://github.com/libgme/game-music-emu
+                 optional for VGM music playback support
 
 PhysicsFS - https://icculus.org/physfs
             version >= 2.1
@@ -65,3 +68,4 @@ DGENGINE_FALLBACK_TO_LOWERCASE (TRUE)  Enable falling back to all lowercase name
 DGENGINE_STATIC_CRT            (FALSE) Use static CRT library (Windows)
 DGENGINE_COMPRESS_BINARY       (FALSE) Compress binary with UPX
 DGENGINE_OPTIMISE              (FALSE) Optimize build with compiler flags
+DGENGINE_VGM_MUSIC             (TRUE)  Add support for VGM sound files

CMakeLists.txt

@@ -7,7 +7,9 @@ if(CCACHE_PROGRAM)
     set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE "${CCACHE_PROGRAM}")
 endif()
 
-project(Columns VERSION 1.2.0)
+project(Columns VERSION 1.2.1)
+
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${PROJECT_SOURCE_DIR}/cmake_modules")
 
 if(IS_DIRECTORY "${PROJECT_SOURCE_DIR}/../DGEngine.core")
     add_subdirectory(${PROJECT_SOURCE_DIR}/../DGEngine.core DGEngine.core)
@@ -17,10 +19,20 @@ endif()
 
 option(DGENGINE_COMPRESS_BINARY "Compress binary" FALSE)
 option(DGENGINE_OPTIMISE "Optimize build" FALSE)
+option(DGENGINE_VGM_MUSIC "Add support for VGM sound files" TRUE)
+
+find_package(gme QUIET)
+find_package(ZLIB QUIET)
+
+if(NOT ${gme_FOUND} OR NOT ${ZLIB_FOUND})
+    SET(DGENGINE_VGM_MUSIC FALSE)
+endif()
 
 set(SOURCE_FILES
     src/RegisterHooks.cpp
     src/RegisterHooks.h
+    src/Game/Game2.cpp
+    src/Game/Game2.h
     src/Game/Actions/ActLevel.h
     src/Game/Jewel/Jewel.cpp
     src/Game/Jewel/Jewel.h
@@ -75,6 +87,13 @@ set(SOURCE_FILES
     src/Parser/Level/ParseLevelScores.h
 )
 
+if(DGENGINE_VGM_MUSIC)
+    SET(SOURCE_FILES ${SOURCE_FILES}
+        src/SFML/VGM.cpp
+        src/SFML/VGM.h
+    )
+endif()
+
 if(DGENGINE_STATIC_CRT AND WIN32)
     if(CMAKE_CXX_COMPILER_ID MATCHES "GNU")
         set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -static")
@@ -100,6 +119,11 @@ endif()
 target_include_directories(${PROJECT_NAME}Lib PUBLIC src)
 target_link_libraries(${PROJECT_NAME}Lib PUBLIC DGEngine.core)
 
+if(DGENGINE_VGM_MUSIC)
+    target_compile_definitions(${PROJECT_NAME}Lib PUBLIC DGENGINE_VGM_MUSIC=1)
+    target_link_libraries(${PROJECT_NAME}Lib PRIVATE gme::gme ZLIB::ZLIB)
+endif()
+
 add_executable(${PROJECT_NAME} src/Main.cpp)
 
 target_link_libraries(${PROJECT_NAME} PRIVATE ${PROJECT_NAME}Lib)

LICENSE.txt

@@ -13,6 +13,10 @@ endian uses the BSD license.
 
 https://github.com/steinwurf/endian
 
+Game_Music_Emu uses the LGPL v2.1 license.
+
+https://github.com/libgme/game-music-emu
+
 PhysFS uses the zlib license.
 
 https://icculus.org/physfs/

README.md

@@ -10,7 +10,7 @@ Sprites for the original are included in the gamefilesc/gfx*x folders.
 Included upscaled graphics created using [xbrz](https://sourceforge.net/projects/xbrz/).  
 
 To have music, convert the VGM songs to ogg and place them in gamefilesc/bgm  
-To get the original music, see gamefilesc/bgm/readme.txt  
+Alternatively, install the Game_Music_Emu dependency.  
 
 [Getting original assets](#Getting-original-assets)
 
@@ -53,6 +53,8 @@ See how to build in [BUILD.txt](BUILD.txt).
 
 ### Getting original assets
 
+(no longer needed)
+
 Fork this repository, go to `Actions` and manually run the `Package_gamefiles` workflow.  
 An artifact (`gamefilesc.zip`) will be created with the original assets.  
 Extract that archive over the `gamefilesc` folder or delete the `gamefilesc` folder (Columns will use the zip instead).

cmake_modules/Findgme.cmake

@@ -0,0 +1,23 @@
+find_path(gme_INCLUDE_DIR NAMES gme.h gme/gme.h)
+mark_as_advanced(gme_INCLUDE_DIR)
+
+find_library(gme_LIBRARY NAMES gme)
+mark_as_advanced(gme_LIBRARY)
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(gme REQUIRED_VARS
+    gme_INCLUDE_DIR
+    gme_LIBRARY
+)
+
+if(gme_FOUND)
+    set(gme_INCLUDE_DIRS ${gme_INCLUDE_DIR})
+    set(gme_LIBRARIES ${gme_LIBRARY})
+    if(NOT TARGET gme::gme)
+        add_library(gme::gme UNKNOWN IMPORTED)
+        set_target_properties(gme::gme PROPERTIES
+            IMPORTED_LINK_INTERFACE_LANGUAGES "C"
+            IMPORTED_LOCATION "${gme_LIBRARY}"
+            INTERFACE_INCLUDE_DIRECTORIES "${gme_INCLUDE_DIR}")
+    endif()
+endif()