Merge pull request #109 from StarbotArc/cmake-4-lujix

Linux build support.

Author: StarbotArc

.github/workflows/windows.yml

@@ -1,8 +1,12 @@
-name: Windows Build
-
 on:
   push:
-    branches: ["main"]
+  pull_request:
+    branches:
+      - beta
+    paths-ignore:
+      - '**.md'
+
+name: Latest Beta
 
 jobs:
   windows:
@@ -13,7 +17,7 @@ jobs:
         working-directory: ${{github.workspace}}/main
     steps:
       - name: Get AV
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           path: main
       - name: Get MSBuild
@@ -22,23 +26,18 @@ jobs:
         run: >
           curl https://www.rarewares.org/files/ogg/oggenc2.88-1.3.7-x64.zip --output oggenc.zip &&
           unzip oggenc.zip -d .
+      - name: Configure CMake
+        run: cmake -Bbuild -DCMAKE_BUILD_TYPE=Release
       - name: Build AV
-        run: msbuild build\VisualStudio\ArrowVortex.vcxproj /p:Configuration=Release /p:Platform=x64         
-      - name: Collect into a zip
+        run: cmake --build build --config Release
+      - name: Collect into a directory
         run: |
           mkdir AV
-          cd AV
-          cp -r ../bin/assets .
-          cp -r ../bin/noteskins .
-          cp -r ../bin/settings .
-          cp ../bin/ArrowVortex.exe .
-          cp ../oggenc2.exe .
-          cd ..
-          7z.exe a -tzip av.zip AV
-      - name: Upload to Delta VPS
-        run: |
-          mkdir -p ~/.ssh
-          echo "${{ secrets.DROPLET_SSH }}" > ~/.ssh/arrow_vortex
-          chmod 400 ~/.ssh/arrow_vortex
-          echo "arrowvortex@167.71.33.176:~/av/ArrowVortex-$(date +'%Y-%m-%d %H-%M-%S').zip" > DROPLET_PATH
-          scp -o StrictHostKeyChecking=no -o PasswordAuthentication=no -i ~/.ssh/arrow_vortex av.zip $(cat DROPLET_PATH)
+          cmake --install build --config Release --prefix ./AV
+          mv oggenc2.exe AV/bin
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: AV
+          path: main/AV/bin
+          if-no-files-found: error

.gitignore

@@ -396,11 +396,12 @@ FodyWeavers.xsd
 
 # JetBrains Rider
 *.sln.iml
-/bin/ArrowVortex_d.exe
-bin/settings/recent files.txt
-bin/settings/settings.txt
-bin/ArrowVortex.exe
-build/VisualStudio/ArrowVortex.vcxproj
-/bin/ArrowVortex.exe
-/bin/settings/recent files.txt
-/bin/settings/settings.txt
+
+.envrc
+.direnv
+shell.nix
+
+# vcpkg and building-related
+vcpkg_installed
+build
+out

CMakeLists.txt

@@ -0,0 +1,56 @@
+cmake_minimum_required(VERSION 3.30)
+
+if (LINUX)
+	set(CMAKE_SYSTEM_NAME Windows)
+
+	set(CMAKE_C_COMPILER x86_64-w64-mingw32-gcc)
+	set(CMAKE_CXX_COMPILER x86_64-w64-mingw32-g++)
+
+	set(CMAKE_FIND_ROOT_PATH /usr/x86_64-w64-mingw32)
+
+	option(VCPKG "Use vcpkg for dependencies" ON)
+endif()
+
+if(WIN32)
+	option(VCPKG "Use vcpkg for dependencies" ON)
+else()
+	option(VCPKG "Use vcpkg for dependencies" OFF)
+endif()
+
+if(VCPKG)
+	set(VCPKG_LIBRARY_LINKAGE "static")
+	if(DEFINED ENV{VCPKG_INSTALLATION_ROOT})
+		set(CMAKE_TOOLCHAIN_FILE "$ENV{VCPKG_INSTALLATION_ROOT}/scripts/buildsystems/vcpkg.cmake" CACHE STRING "")
+	elseif(DEFINED ENV{VCPKG_ROOT})
+		set(CMAKE_TOOLCHAIN_FILE "$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake" CACHE STRING "")
+	endif()
+endif()
+
+set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
+
+set(CMAKE_CXX_STANDARD 14)
+set(CMAKE_CXX_STANDARD_REQUIRED True)
+
+project(ArrowVortex)
+
+set(CMAKE_CONFIGURATION_TYPES Debug Release)
+
+include_directories("${PROJECT_SOURCE_DIR}/src")
+
+find_package(Freetype REQUIRED)
+find_package(MAD REQUIRED)
+find_package(Ogg CONFIG REQUIRED)
+find_package(Vorbis REQUIRED)
+find_package(OpenGL REQUIRED)
+
+add_subdirectory(src/Core)
+add_subdirectory(src/Dialogs)
+add_subdirectory(src/Editor)
+add_subdirectory(src/Managers)
+add_subdirectory(src/Simfile)
+add_subdirectory(src/System)
+
+install(TARGETS ArrowVortex RUNTIME)
+install(DIRECTORY bin/assets DESTINATION bin)
+install(DIRECTORY bin/noteskins DESTINATION bin)
+install(DIRECTORY bin/settings DESTINATION bin)

CMakeSettings.json

@@ -0,0 +1,26 @@
+{
+  "configurations": [
+    {
+      "name": "Debug",
+      "generator": "Ninja",
+      "configurationType": "Debug",
+      "inheritEnvironments": [ "msvc_x64_x64" ],
+      "buildRoot": "${projectDir}\\out\\build\\${name}",
+      "installRoot": "${projectDir}\\out\\install\\${name}",
+      "cmakeCommandArgs": "",
+      "buildCommandArgs": "",
+      "ctestCommandArgs": ""
+    },
+    {
+      "name": "Release",
+      "generator": "Ninja",
+      "configurationType": "RelWithDebInfo",
+      "buildRoot": "${projectDir}\\out\\build\\${name}",
+      "installRoot": "${projectDir}\\out\\install\\${name}",
+      "cmakeCommandArgs": "",
+      "buildCommandArgs": "",
+      "ctestCommandArgs": "",
+      "inheritEnvironments": [ "msvc_x64_x64" ]
+    }
+  ]
+}

CREDITS

@@ -27,24 +27,27 @@ status of the original code as provided to them.
 
 Code from the following projects is included in this repository:
 
- 1. freetype, using the FreeType License, which is compatible with GPLv3
-    See lib/freetype/ for more info.
+ 1. freetype , using the FreeType License, which is compatible with GPLv3
+    See lib/freetype/ or https://freetype.org/license.html for more info.
 
  2. libogg & libvorbis, using its BSD-style license, which is compatible with
-    GPLv3. See lib/libvorbis/license for more info.
+    GPLv3. See lib/libvorbis/license or https://gitlab.xiph.org/xiph for more info.
 
  3. libmad, using the GPL license (libmad allows for GPLv2 or any later version)
-    See lib/freetype/ for more info.
+    See lib/freetype/ or https://www.underbit.com/products/mad/ for more info.
 
  4. lua, using its GPLv3-compatible permissive license
-    See lib/lua/ for more info.
+    See lib/lua/ or https://www.lua.org/license.html for more info.
 
  5. Code from liir.c by Exstrom Labratories, which is GPL, is present in
     src/Editor/Butterworth.cpp
+    https://www.exstrom.com/journal/sigproc/dsigproc.html
 
  6. Code from Takuya OOURA's General Purpose FFT Package, which is released
     freely, is present in src/Editor/FFT.cpp
+    https://www.kurims.kyoto-u.ac.jp/~ooura/fft.html
 
  7. Code from the aubio library, which is also GPLv3, is present in
     src/Editor/Aubio.h and src/Editor/FindOnsets.cpp
+    https://github.com/aubio/aubio
 

README.md

@@ -69,10 +69,30 @@ Some new features were introduced as well when preparing this release, and some
 
 ## Building ArrowVortex
 
+### Windows
+
 In order to compile ArrowVortex on your own PC, Visual Studio is required. It is recommended to use Visual Studio 2022 with the "Desktop development for C++" components installed.
 
 Simply open `build/VisualStudio/ArrowVortex.sln` in Visual Studio, and build the project.
 
+### Linux
+
+Compiling for Linux requires that you have `vcpkg`, `powershell`, and `cmake`.
+
+Once you have those set up, run `export VCPKG_ROOT={where your vcpkg contents is}`.
+
+This command is needed as to find and define vcpkg's root and use it when building with cmake.
+
+Now you may run this: `cmake -B build -DVCPKG_TARGET_TRIPLET=x64-mingw-static -DCMAKE_TOOLCHAIN_FILE=${VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake`
+
+This command specifies that you are using a MinGW environment that is statically linked and targets 64-bit, and for cmake to account for vcpkg.
+
+This command also requires powershell as it is used for vcpkg's copy tools, and will fail to compile if it isn't installed.
+
+Now enter your build directory with `cd build`.
+
+Finally, build ArrowVortex with `cmake --build .`.
+
 ## License
 
 ArrowVortex is provided under the GPLv3 license, or at your option, any later version.