Standalone build (#9)

* Organizes libultraship files into directories.

* Adds StormLib, ZAPDUTILS, and tidies up /lib/

* Moves include up a directory and moves abi.h to include.

* Fixes gitignore to only ignore build folders, and commits forgotten files.

* update CMakeLists and `#include`s to match directory structure

* Windows CMake now builds project files.

* Restructure CMake project

* feat: sdl via vcpkg (#1)

Co-authored-by: briaguya <briaguya@alice>

* Build via VS generator

* Use ccache for faster building

* Error CI workflow on no lib generated

* Remove unused lib (mINI)

* Update embedded lib (nlohmann-json)

* Cleanup main CMakeLists.txt

* Remove unecessary header

* Use Ninja for MSVC

* Update embedded lib (spdlog)

* Update embedded lib (StormLib)

* Improve CMake structure

* define NOMINMAX for certain windows files

* Add and run clang-format

* Add and run clang-tidy

* Add CI workflow for clang-format/tidy

* Split CI workflows

* Use new format validation

* Fixes typos preventing patch OTRs from working on Switch (#8)

* Removes third party BinaryTools and re-implements and reloacates ZAPDUtils Binary Tools. (#7)

* Removes third party BinaryTools and implements ZAPDUtils' into LUS.

* Attempts to make the Linter happy.

* Another run of linter fixing improvements.

* Should be last linting-related change.

* Fixes tidy-format-validation to only check src and include directories in the git diff

Co-authored-by: briaguya <briaguya@alice>
Co-authored-by: David Chavez <david@dcvz.io>
Co-authored-by: briaguya <70942617+briaguya-ai@users.noreply.github.com>
Co-authored-by: Christopher Leggett <chris@leggett.dev>

.clang-format

@@ -0,0 +1,23 @@
+IndentWidth: 4
+Language: Cpp
+UseTab: Never
+ColumnLimit: 120
+PointerAlignment: Left
+BreakBeforeBraces: Attach
+SpaceAfterCStyleCast: false
+Cpp11BracedListStyle: false
+IndentCaseLabels: true
+BinPackArguments: true
+BinPackParameters: true
+AlignAfterOpenBracket: Align
+AlignOperands: true
+BreakBeforeTernaryOperators: true
+BreakBeforeBinaryOperators: None
+AllowShortBlocksOnASingleLine: true
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: false
+AlignEscapedNewlines: Left
+AlignTrailingComments: true
+SortIncludes: false

.clang-tidy

@@ -0,0 +1,9 @@
+Checks: '-*,readability-braces-around-statements,readability-inconsistent-declaration-parameter-name'
+WarningsAsErrors: ''
+HeaderFilterRegex: '(src|include)\/.*\.h$'
+FormatStyle: 'file'
+CheckOptions:
+  # Require argument names to match exactly (instead of allowing a name to be a prefix/suffix of another)
+  # Note: 'true' is expected by clang-tidy 12+ but '1' is used for compatibility with older versions
+  - key: readability-inconsistent-declaration-parameter-name.Strict
+    value: 1

.github/workflows/build-validation.yml

@@ -0,0 +1,90 @@
+name: build-validation
+on:
+  push:
+  pull_request:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  build-macos:
+    runs-on: macos-12
+    steps:
+    - name: Install dependencies
+      run: |
+        brew install sdl2 libpng glew ninja
+    - uses: actions/checkout@v2
+    - name: ccache
+      uses: hendrikmuhs/ccache-action@v1.2
+      with:
+        key: ${{ runner.os }}-ccache
+    - name: Build libultraship
+      run: |
+        export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+        cmake --no-warn-unused-cli -H. -Bbuild-cmake -GNinja -DCMAKE_BUILD_TYPE:STRING=Release
+        cmake --build build-cmake --config Release --parallel 10
+    - name: Upload build
+      uses: actions/upload-artifact@v3
+      with:
+        name: soh-mac
+        path: build-cmake/src/*.a
+        if-no-files-found: error
+  build-linux:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libsdl2-dev libpng-dev libglew-dev ninja-build
+    - uses: actions/checkout@v2
+    - name: ccache
+      uses: hendrikmuhs/ccache-action@v1.2
+      with:
+        key: ${{ runner.os }}-ccache
+    - name: Install latest SDL
+      run: |
+        export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+        wget https://www.libsdl.org/release/SDL2-2.24.1.tar.gz
+        tar -xzf SDL2-2.24.1.tar.gz
+        cd SDL2-2.24.1
+        ./configure
+        make -j 10
+        sudo make install
+    - name: Build libultraship
+      run: |
+        export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+        cmake --no-warn-unused-cli -H. -Bbuild-cmake -GNinja -DCMAKE_BUILD_TYPE:STRING=Release
+        cmake --build build-cmake --config Release --parallel 10
+      env:
+        CC: gcc-10
+        CXX: g++-10
+    - name: Upload build
+      uses: actions/upload-artifact@v3
+      with:
+        name: soh-linux
+        path: build-cmake/src/*.a
+        if-no-files-found: error
+  build-windows:
+    runs-on: windows-latest
+    steps:
+    - name: Install dependencies
+      run: |
+        choco install ninja
+        Remove-Item -Path "C:\ProgramData\Chocolatey\bin\ccache.exe" -Force
+    - uses: actions/checkout@v2
+    - name: ccache
+      uses: dcvz/ccache-action@27b9f33213c0079872f064f6b6ba0233dfa16ba2
+      with:
+        key: ${{ runner.os }}-ccache
+    - name: Setup MSVC
+      uses: ilammy/msvc-dev-cmd@v1
+    - name: Build libultraship
+      run: |
+        set $env:PATH="$env:USERPROFILE/.cargo/bin;$env:PATH"
+        cmake --no-warn-unused-cli -S. -Bbuild-cmake -GNinja -DCMAKE_MAKE_PROGRAM=ninja -DCMAKE_BUILD_TYPE:STRING=Release -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DUSE_AUTO_VCPKG=ON -DCMAKE_VS_PLATFORM_NAME=x64
+        cmake --build build-cmake --config Release --parallel 10
+    - name: Upload build
+      uses: actions/upload-artifact@v3
+      with:
+        name: soh-windows
+        path: build-cmake/**/src/**/*.lib
+        if-no-files-found: error

.github/workflows/tidy-format-validation.yml

@@ -0,0 +1,56 @@
+name: tidy-format-validation
+on: [pull_request]
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  tidy-format:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libsdl2-dev libpng-dev libglew-dev ninja-build clang-tidy clang-format-12
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 2
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1.2
+        with:
+          key: ${{ runner.os }}-ccache
+      - name: Run clang-format
+        run: |
+          clang-format-12 -i -style=file src/**/*.cpp src/**/*.h include/*.h
+          git diff --exit-code
+      - name: Install latest SDL
+        run: |
+          export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+          wget https://www.libsdl.org/release/SDL2-2.24.1.tar.gz
+          tar -xzf SDL2-2.24.1.tar.gz
+          cd SDL2-2.24.1
+          ./configure
+          make -j 10
+          sudo make install
+      - name: Prepare compile_commands.json
+        run: |
+          cmake -B build -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
+      - name: Create results directory
+        run: |
+          mkdir clang-tidy-result
+      - name: Analyze
+        run: |
+          git diff -U0 HEAD^ -- 'src' 'include' | clang-tidy-diff -p1 -path build -export-fixes clang-tidy-result/fixes.yml
+      - name: Run clang-tidy-pr-comments action
+        uses: platisd/clang-tidy-pr-comments@master
+        with:
+          # The GitHub token (or a personal access token)
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # The path to the clang-tidy fixes generated previously
+          clang_tidy_fixes: clang-tidy-result/fixes.yml
+          # Optionally set to true if you want the Action to request
+          # changes in case warnings are found
+          request_changes: true
+          # Optionally set the number of comments per review
+          # to avoid GitHub API timeouts for heavily loaded
+          # pull requests
+          suggestions_per_comment: 10

.gitignore

@@ -16,24 +16,6 @@
 # Mono auto generated files
 mono_crash.*
 
-# Build results
-[Dd]ebug/
-[Dd]ebugPublic/
-[Rr]elease/
-[Rr]eleases/
-x64/
-x86/
-[Aa][Rr][Mm]/
-[Aa][Rr][Mm]64/
-bld/
-[Bb]in/
-[Oo]bj/
-[Ll]og/
-[Ll]ogs/
-
-!otrlib/Lib/SDL/lib/x64
-!otrlib/Lib/SDL/lib/x86
-
 # Visual Studio 2015/2017 cache/options directory
 .vs/
 # Uncomment if you have tasks that create the project's static files in wwwroot
@@ -355,4 +337,5 @@ MigrationBackup/
 !libultraship/Lib/**
 libultraship/DebugObj/*
 build/
-libultraship.a
+libultraship.a
+.DS_Store

.vscode/settings.json

@@ -0,0 +1,77 @@
+{
+    "files.associations": {
+        "unordered_map": "cpp",
+        "string": "cpp",
+        "chrono": "cpp",
+        "iosfwd": "cpp",
+        "thread": "cpp",
+        "__bit_reference": "cpp",
+        "__bits": "cpp",
+        "__config": "cpp",
+        "__debug": "cpp",
+        "__errc": "cpp",
+        "__hash_table": "cpp",
+        "__locale": "cpp",
+        "__mutex_base": "cpp",
+        "__node_handle": "cpp",
+        "__nullptr": "cpp",
+        "__split_buffer": "cpp",
+        "__string": "cpp",
+        "__threading_support": "cpp",
+        "__tree": "cpp",
+        "__tuple": "cpp",
+        "any": "cpp",
+        "array": "cpp",
+        "atomic": "cpp",
+        "bitset": "cpp",
+        "cctype": "cpp",
+        "clocale": "cpp",
+        "cmath": "cpp",
+        "compare": "cpp",
+        "concepts": "cpp",
+        "condition_variable": "cpp",
+        "cstdarg": "cpp",
+        "cstddef": "cpp",
+        "cstdint": "cpp",
+        "cstdio": "cpp",
+        "cstdlib": "cpp",
+        "cstring": "cpp",
+        "ctime": "cpp",
+        "cwchar": "cpp",
+        "cwctype": "cpp",
+        "deque": "cpp",
+        "exception": "cpp",
+        "forward_list": "cpp",
+        "fstream": "cpp",
+        "initializer_list": "cpp",
+        "iomanip": "cpp",
+        "ios": "cpp",
+        "iostream": "cpp",
+        "istream": "cpp",
+        "limits": "cpp",
+        "list": "cpp",
+        "locale": "cpp",
+        "map": "cpp",
+        "memory": "cpp",
+        "mutex": "cpp",
+        "new": "cpp",
+        "numeric": "cpp",
+        "optional": "cpp",
+        "ostream": "cpp",
+        "queue": "cpp",
+        "ratio": "cpp",
+        "set": "cpp",
+        "sstream": "cpp",
+        "stack": "cpp",
+        "stdexcept": "cpp",
+        "streambuf": "cpp",
+        "system_error": "cpp",
+        "tuple": "cpp",
+        "type_traits": "cpp",
+        "typeinfo": "cpp",
+        "unordered_set": "cpp",
+        "valarray": "cpp",
+        "variant": "cpp",
+        "vector": "cpp"
+    }
+}

CMakeLists.txt

@@ -0,0 +1,22 @@
+cmake_minimum_required(VERSION 3.16.0)
+
+project(libultraship LANGUAGES C CXX)
+if (CMAKE_SYSTEM_NAME STREQUAL "Darwin")
+    enable_language(OBJCXX)
+endif()
+
+include(cmake/Utils.cmake)
+
+if (CMAKE_SYSTEM_NAME STREQUAL "Windows" AND USE_AUTO_VCPKG)
+    include(cmake/automate-vcpkg.cmake)
+
+    set(VCPKG_TRIPLET x64-windows-static)
+    set(VCPKG_TARGET_TRIPLET x64-windows-static)
+
+    vcpkg_bootstrap()
+    vcpkg_install_packages(zlib bzip2 SDL2 GLEW)
+endif()
+
+add_subdirectory("extern")
+add_subdirectory("src")
+

README.md

@@ -0,0 +1,15 @@
+# libultraship
+
+## Building
+```
+cmake -H. -Bbuild
+cmake --build build
+```
+
+## Generating a Visual Studio `.sln` on Windows
+```
+# Visual Studio 2022
+& 'C:\Program Files\CMake\bin\cmake' -S . -B "build/x64" -G "Visual Studio 17 2022" -T v142 -A x64
+# Visual Studio 2019
+& 'C:\Program Files\CMake\bin\cmake' -S . -B "build/x64" -G "Visual Studio 16 2019" -T v142 -A x64
+```

cmake/Utils.cmake

@@ -0,0 +1,248 @@
+# utils file for projects came from visual studio solution with cmake-converter.
+
+################################################################################
+# Wrap each token of the command with condition
+################################################################################
+cmake_policy(PUSH)
+cmake_policy(SET CMP0054 NEW)
+macro(prepare_commands)
+    unset(TOKEN_ROLE)
+    unset(COMMANDS)
+    foreach(TOKEN ${ARG_COMMANDS})
+        if("${TOKEN}" STREQUAL "COMMAND")
+            set(TOKEN_ROLE "KEYWORD")
+        elseif("${TOKEN_ROLE}" STREQUAL "KEYWORD")
+            set(TOKEN_ROLE "CONDITION")
+        elseif("${TOKEN_ROLE}" STREQUAL "CONDITION")
+            set(TOKEN_ROLE "COMMAND")
+        elseif("${TOKEN_ROLE}" STREQUAL "COMMAND")
+            set(TOKEN_ROLE "ARG")
+        endif()
+
+        if("${TOKEN_ROLE}" STREQUAL "KEYWORD")
+            list(APPEND COMMANDS "${TOKEN}")
+        elseif("${TOKEN_ROLE}" STREQUAL "CONDITION")
+            set(CONDITION ${TOKEN})
+        elseif("${TOKEN_ROLE}" STREQUAL "COMMAND")
+            list(APPEND COMMANDS "$<$<NOT:${CONDITION}>:${DUMMY}>$<${CONDITION}:${TOKEN}>")
+        elseif("${TOKEN_ROLE}" STREQUAL "ARG")
+            list(APPEND COMMANDS "$<${CONDITION}:${TOKEN}>")
+        endif()
+    endforeach()
+endmacro()
+cmake_policy(POP)
+
+################################################################################
+# Transform all the tokens to absolute paths
+################################################################################
+macro(prepare_output)
+    unset(OUTPUT)
+    foreach(TOKEN ${ARG_OUTPUT})
+        if(IS_ABSOLUTE ${TOKEN})
+            list(APPEND OUTPUT "${TOKEN}")
+        else()
+            list(APPEND OUTPUT "${CMAKE_CURRENT_SOURCE_DIR}/${TOKEN}")
+        endif()
+    endforeach()
+endmacro()
+
+################################################################################
+# Parse add_custom_command_if args.
+#
+# Input:
+#     PRE_BUILD  - Pre build event option
+#     PRE_LINK   - Pre link event option
+#     POST_BUILD - Post build event option
+#     TARGET     - Target
+#     OUTPUT     - List of output files
+#     DEPENDS    - List of files on which the command depends
+#     COMMANDS   - List of commands(COMMAND condition1 commannd1 args1 COMMAND
+#                  condition2 commannd2 args2 ...)
+# Output:
+#     OUTPUT     - Output files
+#     DEPENDS    - Files on which the command depends
+#     COMMENT    - Comment
+#     PRE_BUILD  - TRUE/FALSE
+#     PRE_LINK   - TRUE/FALSE
+#     POST_BUILD - TRUE/FALSE
+#     TARGET     - Target name
+#     COMMANDS   - Prepared commands(every token is wrapped in CONDITION)
+#     NAME       - Unique name for custom target
+#     STEP       - PRE_BUILD/PRE_LINK/POST_BUILD
+################################################################################
+function(add_custom_command_if_parse_arguments)
+    cmake_parse_arguments("ARG" "PRE_BUILD;PRE_LINK;POST_BUILD" "TARGET;COMMENT" "DEPENDS;OUTPUT;COMMANDS" ${ARGN})
+
+    if(WIN32)
+        set(DUMMY "cd.")
+    elseif(UNIX)
+        set(DUMMY "true")
+    endif()
+
+    prepare_commands()
+    prepare_output()
+
+    set(DEPENDS "${ARG_DEPENDS}")
+    set(COMMENT "${ARG_COMMENT}")
+    set(PRE_BUILD "${ARG_PRE_BUILD}")
+    set(PRE_LINK "${ARG_PRE_LINK}")
+    set(POST_BUILD "${ARG_POST_BUILD}")
+    set(TARGET "${ARG_TARGET}")
+    if(PRE_BUILD)
+        set(STEP "PRE_BUILD")
+    elseif(PRE_LINK)
+        set(STEP "PRE_LINK")
+    elseif(POST_BUILD)
+        set(STEP "POST_BUILD")
+    endif()
+    set(NAME "${TARGET}_${STEP}")
+
+    set(OUTPUT "${OUTPUT}" PARENT_SCOPE)
+    set(DEPENDS "${DEPENDS}" PARENT_SCOPE)
+    set(COMMENT "${COMMENT}" PARENT_SCOPE)
+    set(PRE_BUILD "${PRE_BUILD}" PARENT_SCOPE)
+    set(PRE_LINK "${PRE_LINK}" PARENT_SCOPE)
+    set(POST_BUILD "${POST_BUILD}" PARENT_SCOPE)
+    set(TARGET "${TARGET}" PARENT_SCOPE)
+    set(COMMANDS "${COMMANDS}" PARENT_SCOPE)
+    set(STEP "${STEP}" PARENT_SCOPE)
+    set(NAME "${NAME}" PARENT_SCOPE)
+endfunction()
+
+################################################################################
+# Add conditional custom command
+#
+# Generating Files
+# The first signature is for adding a custom command to produce an output:
+#     add_custom_command_if(
+#         <OUTPUT output1 [output2 ...]>
+#         <COMMANDS>
+#         <COMMAND condition command1 [args1...]>
+#         [COMMAND condition command2 [args2...]]
+#         [DEPENDS [depends...]]
+#         [COMMENT comment]
+#
+# Build Events
+#     add_custom_command_if(
+#         <TARGET target>
+#         <PRE_BUILD | PRE_LINK | POST_BUILD>
+#         <COMMAND condition command1 [args1...]>
+#         [COMMAND condition command2 [args2...]]
+#         [COMMENT comment]
+#
+# Input:
+#     output     - Output files the command is expected to produce
+#     condition  - Generator expression for wrapping the command
+#     command    - Command-line(s) to execute at build time.
+#     args       - Command`s args
+#     depends    - Files on which the command depends
+#     comment    - Display the given message before the commands are executed at
+#                  build time.
+#     PRE_BUILD  - Run before any other rules are executed within the target
+#     PRE_LINK   - Run after sources have been compiled but before linking the
+#                  binary
+#     POST_BUILD - Run after all other rules within the target have been
+#                  executed
+################################################################################
+function(add_custom_command_if)
+    add_custom_command_if_parse_arguments(${ARGN})
+
+    if(OUTPUT AND TARGET)
+        message(FATAL_ERROR  "Wrong syntax. A TARGET and OUTPUT can not both be specified.")
+    endif()
+
+    if(OUTPUT)
+        add_custom_command(OUTPUT ${OUTPUT}
+                           ${COMMANDS}
+                           DEPENDS ${DEPENDS}
+                           WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+                           COMMENT ${COMMENT})
+    elseif(TARGET)
+        if(PRE_BUILD AND NOT ${CMAKE_GENERATOR} MATCHES "Visual Studio")
+            add_custom_target(
+                ${NAME}
+                ${COMMANDS}
+                WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+                COMMENT ${COMMENT})
+            add_dependencies(${TARGET} ${NAME})
+        else()
+            add_custom_command(
+                TARGET ${TARGET}
+                ${STEP}
+                ${COMMANDS}
+                WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+                COMMENT ${COMMENT})
+        endif()
+    else()
+        message(FATAL_ERROR "Wrong syntax. A TARGET or OUTPUT must be specified.")
+    endif()
+endfunction()
+
+################################################################################
+# Use props file for a target and configs
+#     use_props(<target> <configs...> <props_file>)
+# Inside <props_file> there are following variables:
+#     PROPS_TARGET   - <target>
+#     PROPS_CONFIG   - One of <configs...>
+#     PROPS_CONFIG_U - Uppercase PROPS_CONFIG
+# Input:
+#     target      - Target to apply props file
+#     configs     - Build configurations to apply props file
+#     props_file  - CMake script
+################################################################################
+macro(use_props TARGET CONFIGS PROPS_FILE)
+    set(PROPS_TARGET "${TARGET}")
+    foreach(PROPS_CONFIG ${CONFIGS})
+        string(TOUPPER "${PROPS_CONFIG}" PROPS_CONFIG_U)
+
+        get_filename_component(ABSOLUTE_PROPS_FILE "${PROPS_FILE}" ABSOLUTE BASE_DIR "${CMAKE_CURRENT_LIST_DIR}")
+        if(EXISTS "${ABSOLUTE_PROPS_FILE}")
+            include("${ABSOLUTE_PROPS_FILE}")
+        else()
+            message(WARNING "Corresponding cmake file from props \"${ABSOLUTE_PROPS_FILE}\" doesn't exist")
+        endif()
+    endforeach()
+endmacro()
+
+################################################################################
+# Add compile options to source file
+#     source_file_compile_options(<source_file> [compile_options...])
+# Input:
+#     source_file     - Source file
+#     compile_options - Options to add to COMPILE_FLAGS property
+################################################################################
+function(source_file_compile_options SOURCE_FILE)
+    if("${ARGC}" LESS_EQUAL "1")
+        return()
+    endif()
+
+    get_source_file_property(COMPILE_OPTIONS "${SOURCE_FILE}" COMPILE_OPTIONS)
+
+    if(COMPILE_OPTIONS)
+        list(APPEND COMPILE_OPTIONS ${ARGN})
+    else()
+        set(COMPILE_OPTIONS "${ARGN}")
+    endif()
+
+    set_source_files_properties("${SOURCE_FILE}" PROPERTIES COMPILE_OPTIONS "${COMPILE_OPTIONS}")
+endfunction()
+
+################################################################################
+# Default properties of visual studio projects
+################################################################################
+set(DEFAULT_CXX_PROPS "${CMAKE_CURRENT_LIST_DIR}/DefaultCXX.cmake")
+
+function(get_linux_lsb_release_information)
+    find_program(LSB_RELEASE_EXEC lsb_release)
+    if(NOT LSB_RELEASE_EXEC)
+        message(FATAL_ERROR "Could not detect lsb_release executable, can not gather required information")
+    endif()
+
+    execute_process(COMMAND "${LSB_RELEASE_EXEC}" --short --id OUTPUT_VARIABLE LSB_RELEASE_ID_SHORT OUTPUT_STRIP_TRAILING_WHITESPACE)
+    execute_process(COMMAND "${LSB_RELEASE_EXEC}" --short --release OUTPUT_VARIABLE LSB_RELEASE_VERSION_SHORT OUTPUT_STRIP_TRAILING_WHITESPACE)
+    execute_process(COMMAND "${LSB_RELEASE_EXEC}" --short --codename OUTPUT_VARIABLE LSB_RELEASE_CODENAME_SHORT OUTPUT_STRIP_TRAILING_WHITESPACE)
+
+    set(LSB_RELEASE_ID_SHORT "${LSB_RELEASE_ID_SHORT}" PARENT_SCOPE)
+    set(LSB_RELEASE_VERSION_SHORT "${LSB_RELEASE_VERSION_SHORT}" PARENT_SCOPE)
+    set(LSB_RELEASE_CODENAME_SHORT "${LSB_RELEASE_CODENAME_SHORT}" PARENT_SCOPE)
+endfunction()

cmake/automate-vcpkg.cmake

@@ -0,0 +1,191 @@
+#------------------------------------------------------------------------------------------------------------
+#
+# Automate-VCPKG by Andre Taulien
+# ===============================
+#
+# Project Repository: https://github.com/REGoth-project/Automate-VCPKG
+# License ..........: MIT, see end of file.
+#
+# Based on: https://github.com/sutambe/cpptruths/blob/vcpkg_cmake_blog/cpp0x/vcpkg_test/CMakeLists.txt
+#
+# 
+# While [Vcpkg](https://github.com/microsoft/vcpkg) on it's own is awesome, it does add 
+# a little bit of complexity to getting a project to build. Even more if the one trying 
+# to compile your application is not too fond of the commandline. Additionally, CMake 
+# commands tend to get rather long with the toolchain path. 
+# 
+# To keep things simple for new users who just want to get the project to build, this 
+# script offers a solution.
+# 
+# Lets assume your main `CMakelists.txt` looks something like this:
+#
+#     cmake_minimum_required (VERSION 3.12.0)
+#     project (MyProject)
+#     
+#     add_executable(MyExecutable main.c)
+# 
+# To integrate Vcpkg into that `CMakelists.txt`, simple put the following lines before the 
+# call to `project(MyProject)`:
+# 
+#     include(cmake/automate-vcpkg.cmake)
+#     
+#     vcpkg_bootstrap()
+#     vcpkg_install_packages(libsquish physfs)
+# 
+# The call to `vcpkg_bootstrap()` will clone the official Vcpkg repository and bootstrap it. 
+# If it detected an existing environment variable defining a valid `VCPKG_ROOT`, it will 
+# update the existing installation of Vcpkg.
+# 
+# Arguments to `vcpkg_install_packages()` are the packages you want to install using Vcpkg.
+# 
+# If you want to keep the possibility for users to chose their own copy of Vcpkg, you can 
+# simply not run the code snippet mentioned above, something like this will work:
+# 
+#     option(SKIP_AUTOMATE_VCPKG "When ON, you will need to built the packages 
+#      required by MyProject on your own or supply your own vcpkg toolchain.")
+#     
+#     if (NOT SKIP_AUTOMATE_VCPKG)
+#       include(cmake/automate-vcpkg.cmake)
+#     
+#       vcpkg_bootstrap()
+#       vcpkg_install_packages(libsquish physfs)
+#     endif()
+#  
+# Then, the user has to supply the packages on their own, be it through Vcpkg or manually 
+# specifying their locations.
+#------------------------------------------------------------------------------------------------------------
+
+cmake_minimum_required (VERSION 3.12)
+
+if(WIN32)
+    set(VCPKG_FALLBACK_ROOT ${CMAKE_CURRENT_BINARY_DIR}/vcpkg CACHE STRING "vcpkg configuration directory to use if vcpkg was not installed on the system before")
+else()
+    set(VCPKG_FALLBACK_ROOT ${CMAKE_CURRENT_BINARY_DIR}/.vcpkg CACHE STRING  "vcpkg configuration directory to use if vcpkg was not installed on the system before")
+endif()
+
+# On Windows, Vcpkg defaults to x86, even on x64 systems. If we're 
+# doing a 64-bit build, we need to fix that.
+if (WIN32)
+
+    # Since the compiler checks haven't run yet, we need to figure
+    # out the value of CMAKE_SIZEOF_VOID_P ourselfs
+
+    include(CheckTypeSize)
+    enable_language(C)
+    check_type_size("void*" SIZEOF_VOID_P BUILTIN_TYPES_ONLY)
+    
+    if (SIZEOF_VOID_P EQUAL 8)
+        message(STATUS "Using Vcpkg triplet 'x64-windows'")
+        
+        set(VCPKG_TRIPLET x64-windows)
+    endif()
+endif()
+
+if(NOT DEFINED VCPKG_ROOT)
+    if(NOT DEFINED ENV{VCPKG_ROOT})
+	    set(VCPKG_ROOT ${VCPKG_FALLBACK_ROOT})
+    else()
+        set(VCPKG_ROOT $ENV{VCPKG_ROOT})
+    endif()
+endif()
+
+# Installs a new copy of Vcpkg or updates an existing one
+macro(vcpkg_bootstrap)
+    _install_or_update_vcpkg()
+
+    # Find out whether the user supplied their own VCPKG toolchain file
+    if(NOT DEFINED ${CMAKE_TOOLCHAIN_FILE})
+        # We know this wasn't set before so we need point the toolchain file to the newly found VCPKG_ROOT
+        set(CMAKE_TOOLCHAIN_FILE ${VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake CACHE STRING "")
+    
+        # Just setting vcpkg.cmake as toolchain file does not seem to actually pull in the code
+        include(${VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake)
+    
+        set(AUTOMATE_VCPKG_USE_SYSTEM_VCPKG OFF)
+    else()
+        # VCPKG_ROOT has been defined by the toolchain file already
+        set(AUTOMATE_VCPKG_USE_SYSTEM_VCPKG ON)
+    endif()
+    
+    message(STATUS "Automate VCPKG status:")
+    message(STATUS "  VCPKG_ROOT.....: ${VCPKG_ROOT}")
+    message(STATUS "  VCPKG_EXEC.....: ${VCPKG_EXEC}")
+    message(STATUS "  VCPKG_BOOTSTRAP: ${VCPKG_BOOTSTRAP}")
+endmacro()
+
+macro(_install_or_update_vcpkg)
+    if(NOT EXISTS ${VCPKG_ROOT})
+        message(STATUS "Cloning vcpkg in ${VCPKG_ROOT}")
+        execute_process(COMMAND git clone https://github.com/Microsoft/vcpkg.git ${VCPKG_ROOT})
+
+        # If a reproducible build is desired (and potentially old libraries are # ok), uncomment the
+        # following line and pin the vcpkg repository to a specific githash.
+        # execute_process(COMMAND git checkout 745a0aea597771a580d0b0f4886ea1e3a94dbca6 WORKING_DIRECTORY ${VCPKG_ROOT})
+    else()
+        # The following command has no effect if the vcpkg repository is in a detached head state.
+        message(STATUS "Auto-updating vcpkg in ${VCPKG_ROOT}")
+        execute_process(COMMAND git pull WORKING_DIRECTORY ${VCPKG_ROOT})
+    endif()
+
+    if(NOT EXISTS ${VCPKG_ROOT}/README.md)
+        message(FATAL_ERROR "***** FATAL ERROR: Could not clone vcpkg *****")
+    endif()
+
+    if(WIN32)
+        set(VCPKG_EXEC ${VCPKG_ROOT}/vcpkg.exe)
+        set(VCPKG_BOOTSTRAP ${VCPKG_ROOT}/bootstrap-vcpkg.bat)
+    else()
+        set(VCPKG_EXEC ${VCPKG_ROOT}/vcpkg)
+        set(VCPKG_BOOTSTRAP ${VCPKG_ROOT}/bootstrap-vcpkg.sh)
+    endif()
+
+    if(NOT EXISTS ${VCPKG_EXEC})
+        message("Bootstrapping vcpkg in ${VCPKG_ROOT}")
+        execute_process(COMMAND ${VCPKG_BOOTSTRAP} WORKING_DIRECTORY ${VCPKG_ROOT})
+    endif()
+
+    if(NOT EXISTS ${VCPKG_EXEC})
+        message(FATAL_ERROR "***** FATAL ERROR: Could not bootstrap vcpkg *****")
+    endif()
+   
+endmacro()
+
+# Installs the list of packages given as parameters using Vcpkg
+macro(vcpkg_install_packages)
+    
+    # Need the given list to be space-separated
+    #string (REPLACE ";" " " PACKAGES_LIST_STR "${ARGN}")
+
+    message(STATUS "Installing/Updating the following vcpkg-packages: ${PACKAGES_LIST_STR}")
+
+    if (VCPKG_TRIPLET)
+        set(ENV{VCPKG_DEFAULT_TRIPLET} "${VCPKG_TRIPLET}")
+    endif()
+
+    execute_process(
+        COMMAND ${VCPKG_EXEC} install ${ARGN}
+        WORKING_DIRECTORY ${VCPKG_ROOT}
+        )
+endmacro()
+    
+# MIT License
+# 
+# Copyright (c) 2019 REGoth-project
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.

extern/CMakeLists.txt

@@ -0,0 +1,133 @@
+find_package(OpenGL QUIET)
+
+if (CMAKE_SYSTEM_NAME MATCHES "Windows")
+    find_package(SDL2 CONFIG REQUIRED)
+else()
+    find_package(SDL2 REQUIRED)
+endif()
+
+#=================== DrLibs ===================
+
+set(DRLIBS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/dr_libs)
+add_library(DrLibs INTERFACE)
+
+target_include_directories(DrLibs INTERFACE ${DRLIBS_DIR})
+
+#=================== Storm ===================
+
+set(STORMLIB_DIR ${CMAKE_CURRENT_SOURCE_DIR}/StormLib)
+add_subdirectory(${STORMLIB_DIR})
+
+#=================== ImGui ===================
+
+set(IMGUI_DIR ${CMAKE_CURRENT_SOURCE_DIR}/ImGui)
+add_library(ImGui STATIC)
+set_property(TARGET ImGui PROPERTY CXX_STANDARD 20)
+
+target_sources(ImGui
+    PRIVATE
+    ${IMGUI_DIR}/imgui_demo.cpp
+    ${IMGUI_DIR}/imgui_draw.cpp
+    ${IMGUI_DIR}/imgui_tables.cpp
+    ${IMGUI_DIR}/imgui_widgets.cpp
+    ${IMGUI_DIR}/imgui.cpp
+)
+
+if (NOT CMAKE_SYSTEM_NAME STREQUAL "CafeOS")
+    target_sources(ImGui
+        PRIVATE
+        ${IMGUI_DIR}/backends/imgui_impl_opengl3.cpp
+        ${IMGUI_DIR}/backends/imgui_impl_sdl.cpp
+    )
+endif()
+
+if (CMAKE_SYSTEM_NAME STREQUAL "Windows")
+    target_sources(ImGui
+        PRIVATE
+        ${IMGUI_DIR}/backends/imgui_impl_dx11.cpp
+        ${IMGUI_DIR}/backends/imgui_impl_win32.cpp
+    )
+elseif (CMAKE_SYSTEM_NAME STREQUAL "CafeOS")
+
+    target_sources(ImGui
+        PRIVATE
+        ${IMGUI_DIR}/backends/imgui_impl_wiiu.cpp
+        ${IMGUI_DIR}/backends/imgui_impl_gx2.cpp
+    )
+endif()
+
+target_include_directories(ImGui PUBLIC ${IMGUI_DIR} ${IMGUI_DIR}/backends PRIVATE ${SDL2_INCLUDE_DIRS})
+target_link_libraries(ImGui PUBLIC storm)
+
+if (CMAKE_SYSTEM_NAME STREQUAL "Windows")
+    target_link_libraries(ImGui PUBLIC SDL2::SDL2 SDL2::SDL2main)
+elseif (CMAKE_SYSTEM_NAME STREQUAL "CafeOS")
+    target_link_libraries(ImGui PUBLIC SDL2::SDL2-static)
+else()
+    target_link_libraries(ImGui PUBLIC SDL2::SDL2)
+endif()
+
+if (CMAKE_SYSTEM_NAME STREQUAL "Windows")
+    find_package(GLEW REQUIRED)
+    target_link_libraries(ImGui PUBLIC opengl32 GLEW::GLEW)
+elseif (CMAKE_SYSTEM_NAME STREQUAL "Darwin")
+    find_package(GLEW REQUIRED)
+    target_link_libraries(ImGui PUBLIC ${OPENGL_opengl_LIBRARY} GLEW::GLEW)
+elseif (CMAKE_SYSTEM_NAME STREQUAL "Linux")
+    find_package(GLEW REQUIRED)
+    target_link_libraries(ImGui PUBLIC ${OPENGL_glx_LIBRARY} ${OPENGL_opengl_LIBRARY} GLEW::GLEW)
+endif()
+
+#=================== tinyxml2 ===================
+
+set(TINYXML2_DIR ${CMAKE_CURRENT_SOURCE_DIR}/tinyxml2)
+add_library(tinyxml2 STATIC)
+
+target_sources(tinyxml2 PRIVATE ${TINYXML2_DIR}/tinyxml2.cpp)
+target_include_directories(tinyxml2 PUBLIC ${TINYXML2_DIR})
+
+#=================== ZAPDUtils ===================
+
+set(ZAPDUTILS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/ZAPDUtils)
+add_subdirectory(${ZAPDUTILS_DIR})
+
+#=================== nlohmann-json ===================
+
+set(JSON_BuildTests OFF CACHE INTERNAL "")
+
+set(NLOHMANN_JSON_DIR ${CMAKE_CURRENT_SOURCE_DIR}/nlohmann-json)
+add_subdirectory(${NLOHMANN_JSON_DIR})
+
+#=================== Mercury ===================
+
+set(MERCURY_DIR ${CMAKE_CURRENT_SOURCE_DIR}/Mercury)
+add_library(Mercury STATIC)
+set_property(TARGET Mercury PROPERTY CXX_STANDARD 20)
+
+target_sources(Mercury PRIVATE ${MERCURY_DIR}/Mercury.cpp)
+target_include_directories(Mercury PUBLIC ${MERCURY_DIR} ${ZAPDUTILS_DIR})
+
+target_link_libraries(Mercury PUBLIC ZAPDUTILS nlohmann_json::nlohmann_json)
+
+#=================== STB ===================
+
+set(STB_DIR ${CMAKE_CURRENT_SOURCE_DIR}/stb)
+add_library(stb STATIC)
+
+target_sources(stb PRIVATE ${STB_DIR}/stb_impl.c)
+
+target_include_directories(stb PUBLIC ${STB_DIR})
+
+#=================== StrHash64 ===================
+
+set(STRHASH64_DIR ${CMAKE_CURRENT_SOURCE_DIR}/StrHash64)
+add_library(StrHash64 STATIC)
+
+target_sources(StrHash64 PRIVATE ${STRHASH64_DIR}/StrHash64.cpp)
+
+target_include_directories(StrHash64 PUBLIC ${STRHASH64_DIR})
+
+#=================== spdlog ===================
+
+set(SPDLOG_DIR ${CMAKE_CURRENT_SOURCE_DIR}/spdlog)
+add_subdirectory(${SPDLOG_DIR})