DSU: Fix bad crc calculate (#410)

* Refactor spinlock to meet Lockable requirements
* Input: Refactor button code and make it thread-safe

.github/ISSUE_TEMPLATE/bug-report-feature-request.md

@@ -0,0 +1,34 @@
+---
+name: Bug Report / Feature Request
+about: Tech support does not belong here. You should only file an issue here if you think you have experienced an actual bug with Cemu or you are requesting a feature you believe would make Cemu better.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!---
+Please keep in mind Cemu is EXPERIMENTAL SOFTWARE.
+
+Please read the FAQ:
+https://cemu.info/faq.html/
+
+THIS IS NOT A SUPPORT FORUM, FOR SUPPORT GO TO:
+https://discord.com/invite/5psYsup/
+
+If the FAQ does not answer your question, please go to:
+https://discord.com/invite/5psYsup/
+
+When submitting an issue, please check the following:
+
+- You have read the above.
+- You have provided the version (commit hash) of Cemu you are using.
+- You have provided sufficient detail for the issue to be reproduced.
+- You have provided system specs (if relevant).
+- Please also provide:
+  - For any issues, a log file
+  - For crashes, a backtrace.
+  - For graphical issues, comparison screenshots with real hardware.
+  - For emulation inaccuracies, a test-case (if able).
+
+-->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Cemu Discord
+    url: https://discord.com/invite/5psYsup
+    about: If you are experiencing an issue with Cemu, and you need tech support, or if you have a general question, try asking in the official Cemu Discord linked here. Piracy is not allowed.

.github/workflows/build.yml

@@ -1,19 +1,14 @@
 name: Build Cemu
 
 on:
-  pull_request_target:
-    types:
-      - opened
-      - synchronize
-      - reopened
-  push:
-    branches:
-      - main
   workflow_call:
     inputs:
       deploymode:
         required: false
         type: string
+      experimentalversion:
+        required: false
+        type: string
 
 env:
   VCPKG_ROOT: "${{github.workspace}}/dependencies/vcpkg"
@@ -22,9 +17,6 @@ env:
 jobs:
   build-ubuntu:
     runs-on: ubuntu-20.04
-    env:
-      install_vulkan_folder: "$GITHUB_WORKSPACE/vulkan_sdk"
-      install_vulkan_version: "1.3.216.0"
     steps:
     - name: "Checkout repo"
       uses: actions/checkout@v3
@@ -35,9 +27,8 @@ jobs:
       if: ${{ inputs.deploymode == 'release' }}
       run: |
         echo "BUILD_MODE=release" >> $GITHUB_ENV
-        echo "BUILD_FLAGS=-DPUBLIC_RELEASE=ON" >> $GITHUB_ENV
+        echo "BUILD_FLAGS=" >> $GITHUB_ENV
         echo "Build mode is release"
-
     - name: Setup debug mode parameters (for continous build)
       if: ${{ inputs.deploymode != 'release' }}
       run: |
@@ -45,17 +36,18 @@ jobs:
         echo "BUILD_FLAGS=" >> $GITHUB_ENV
         echo "Build mode is debug"
         
+    - name: Setup version for experimental
+      if: ${{ inputs.experimentalversion != '' }}
+      run: |
+        echo "[INFO] Experimental version ${{ inputs.experimentalversion }}"
+        echo "BUILD_FLAGS=${{ env.BUILD_FLAGS }} -DEXPERIMENTAL_VERSION=${{ inputs.experimentalversion }}" >> $GITHUB_ENV
+        
     - name: "Install system dependencies"
       run: |
         sudo apt update -qq
         sudo apt install -y ninja-build cmake libgtk-3-dev libsecret-1-dev libgcrypt20-dev libsystemd-dev freeglut3-dev clang-12 nasm
-        wget https://sdk.lunarg.com/sdk/download/${{ env.install_vulkan_version }}/linux/vulkansdk-linux-x86_64-${{ env.install_vulkan_version }}.tar.gz -q -O vulkansdk.tar.gz
-        mkdir -p "${{ env.install_vulkan_folder }}"
-        tar -xf vulkansdk.tar.gz --directory ${{ env.install_vulkan_folder }}
-
     - name: "Bootstrap vcpkg"
       run: |
-        export VULKAN_SDK="${{ env.install_vulkan_folder }}/${{ env.install_vulkan_version }}/x86_64"
         bash ./dependencies/vcpkg/bootstrap-vcpkg.sh
         
     - name: 'Setup NuGet Credentials for vcpkg'
@@ -74,7 +66,6 @@ jobs:
         
     - name: "cmake"
       run: |
-        export VULKAN_SDK="${{ env.install_vulkan_folder }}/${{ env.install_vulkan_version }}/x86_64"
         mkdir -p build
         cd build
         cmake .. ${{ env.BUILD_FLAGS }} -DCMAKE_BUILD_TYPE=${{ env.BUILD_MODE }} -DCMAKE_C_COMPILER=/usr/bin/clang-12 -DCMAKE_CXX_COMPILER=/usr/bin/clang++-12 -G Ninja -DCMAKE_MAKE_PROGRAM=/usr/bin/ninja
@@ -83,7 +74,11 @@ jobs:
       run: |
         cd build
         ninja
-        
+
+    - name: Prepare artifact
+      if: ${{ inputs.deploymode == 'release' }}
+      run: mv bin/Cemu_release bin/Cemu
+              
     - name: Upload artifact
       uses: actions/upload-artifact@v3
       if: ${{ inputs.deploymode == 'release' }}
@@ -94,9 +89,6 @@ jobs:
         
   build-windows:
     runs-on: windows-2022
-    env:
-      install_vulkan_folder: "$GITHUB_WORKSPACE/vulkan_sdk"
-      install_vulkan_version: "1.3.216.0"
     steps:
     - name: "Checkout repo"
       uses: actions/checkout@v3
@@ -107,7 +99,7 @@ jobs:
       if: ${{ inputs.deploymode == 'release' }}
       run: |
         echo "BUILD_MODE=release" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
-        echo "BUILD_FLAGS=-DPUBLIC_RELEASE=ON" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
+        echo "BUILD_FLAGS=" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
         echo "Build mode is release"
         
     - name: Setup debug mode parameters (for continous build)
@@ -116,44 +108,12 @@ jobs:
         echo "BUILD_MODE=debug" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
         echo "BUILD_FLAGS=" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
         echo "Build mode is debug"
-        
+    - name: Setup version for experimental
-    - name: Prepare Vulkan SDK
+      if: ${{ inputs.experimentalversion != '' }}
-      uses: humbletim/setup-vulkan-sdk@v1.2.0
-      with:
-        vulkan-query-version: 1.3.216.0
-        vulkan-components: Vulkan-Headers, Vulkan-Loader
-        vulkan-use-cache: false
-    
-    - name: Workaround
       run: |
-        Set-Location "C:\Program Files (x86)\Microsoft Visual Studio\Installer\"
+        echo "[INFO] Experimental version ${{ inputs.experimentalversion }}"
-        $InstallPath = "C:\Program Files\Microsoft Visual Studio\2022\Enterprise"
+        echo "BUILD_FLAGS=${{ env.BUILD_FLAGS }} -DEXPERIMENTAL_VERSION=${{ inputs.experimentalversion }}" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
-        $componentsToRemove= @(
+    
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.ARM"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.ARM.Spectre"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.ARM64"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.ARM64.Spectre"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.x86.x64"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.x86.x64.Spectre"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.ATL"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.ATL.Spectre"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.ATL.ARM"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.ATL.ARM.Spectre"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.ATL.ARM64"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.ATL.ARM64.Spectre"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.MFC"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.MFC.Spectre"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.MFC.ARM"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.MFC.ARM.Spectre"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.MFC.ARM64"
-          "Microsoft.VisualStudio.Component.VC.14.32.17.2.MFC.ARM64.Spectre"
-        )
-        [string]$workloadArgs = $componentsToRemove | ForEach-Object {" --remove " +  $_}
-        $Arguments = ('/c', "vs_installer.exe", 'modify', '--installPath', "`"$InstallPath`"",$workloadArgs, '--quiet', '--norestart', '--nocache')
-        # should be run twice
-        $process = Start-Process -FilePath cmd.exe -ArgumentList $Arguments -Wait -PassThru -WindowStyle Hidden
-        $process = Start-Process -FilePath cmd.exe -ArgumentList $Arguments -Wait -PassThru -WindowStyle Hidden
-
     - name: Configure MSVC
       uses: ilammy/msvc-dev-cmd@v1
       with:
@@ -183,20 +143,100 @@ jobs:
       run: |
         mkdir -p build
         cd build
-        cmake .. ${{ env.BUILD_FLAGS }} -DCMAKE_BUILD_TYPE=${{ env.BUILD_MODE }}
+        echo "[INFO] BUILD_FLAGS: ${{ env.BUILD_FLAGS }}"
-        
+        echo "[INFO] BUILD_MODE: ${{ env.BUILD_MODE }}"
-    - name: "Free up space"
+        cmake .. ${{ env.BUILD_FLAGS }} -DCMAKE_BUILD_TYPE=${{ env.BUILD_MODE }} -DVCPKG_INSTALL_OPTIONS="--clean-after-build"
-      run: |
-        Remove-Item './dependencies/vcpkg/downloads' -Recurse
         
     - name: "Build Cemu"
       run: |
         cd build
         cmake --build . --config ${{ env.BUILD_MODE }} -j 2
-        
+
+    - name: Prepare artifact
+      if: ${{ inputs.deploymode == 'release' }}
+      run: Rename-Item bin/Cemu_release.exe Cemu.exe
+      
     - name: Upload artifact
       uses: actions/upload-artifact@v3
       if: ${{ inputs.deploymode == 'release' }}
       with:
         name: cemu-bin-windows-x64
         path: ./bin/Cemu.exe
+
+
+  build-macos:
+    runs-on: macos-12
+    steps:
+    - name: "Checkout repo"
+      uses: actions/checkout@v3
+      with:
+        submodules: "recursive"
+    - name: Setup release mode parameters (for deploy)
+      if: ${{ inputs.deploymode == 'release' }}
+      run: |
+        echo "BUILD_MODE=release" >> $GITHUB_ENV
+        echo "BUILD_FLAGS=" >> $GITHUB_ENV
+        echo "Build mode is release"
+    - name: Setup debug mode parameters (for continous build)
+      if: ${{ inputs.deploymode != 'release' }}
+      run: |
+        echo "BUILD_MODE=debug" >> $GITHUB_ENV
+        echo "BUILD_FLAGS=" >> $GITHUB_ENV
+        echo "Build mode is debug"
+        
+    - name: Setup version for experimental
+      if: ${{ inputs.experimentalversion != '' }}
+      run: |
+        echo "[INFO] Experimental version ${{ inputs.experimentalversion }}"
+        echo "BUILD_FLAGS=${{ env.BUILD_FLAGS }} -DEXPERIMENTAL_VERSION=${{ inputs.experimentalversion }}" >> $GITHUB_ENV
+        
+    - name: "Install system dependencies"
+      run: |
+        brew install llvm@14 ninja nasm molten-vk
+    - name: "Bootstrap vcpkg"
+      run: |
+        bash ./dependencies/vcpkg/bootstrap-vcpkg.sh
+        
+    - name: 'Setup NuGet Credentials for vcpkg'
+      shell: 'bash'
+      run: |
+        mono `./dependencies/vcpkg/vcpkg fetch nuget | tail -n 1` \
+        sources add \
+        -source "https://nuget.pkg.github.com/${{ github.repository_owner }}/index.json" \
+        -storepasswordincleartext \
+        -name "GitHub" \
+        -username "${{ github.repository_owner }}" \
+        -password "${{ secrets.GITHUB_TOKEN }}"
+        mono `./dependencies/vcpkg/vcpkg fetch nuget | tail -n 1` \
+        setapikey "${{ secrets.GITHUB_TOKEN }}" \
+        -source "https://nuget.pkg.github.com/${{ github.repository_owner }}/index.json"
+        
+    - name: "cmake"
+      run: |
+        mkdir build
+        cd build
+        cmake .. ${{ env.BUILD_FLAGS }} -DCMAKE_BUILD_TYPE=${{ env.BUILD_MODE }} -DPORTABLE=OFF -DMACOS_BUNDLE=ON -DCMAKE_C_COMPILER=/usr/local/opt/llvm@14/bin/clang -DCMAKE_CXX_COMPILER=/usr/local/opt/llvm@14/bin/clang++ -G Ninja
+        
+    - name: "Build Cemu"
+      run: |
+        cmake --build build
+
+    - name: Prepare artifact
+      if: ${{ inputs.deploymode == 'release' }}
+      run: |
+        mkdir bin/Cemu_app
+        mv bin/Cemu_release.app bin/Cemu_app/Cemu.app
+        mv bin/Cemu_app/Cemu.app/Contents/MacOS/Cemu_release bin/Cemu_app/Cemu.app/Contents/MacOS/Cemu
+        sed -i '' 's/Cemu_release/Cemu/g' bin/Cemu_app/Cemu.app/Contents/Info.plist
+        chmod a+x bin/Cemu_app/Cemu.app/Contents/MacOS/Cemu
+        ln -s /Applications bin/Cemu_app/Applications
+        hdiutil create ./bin/tmp.dmg -ov -volname "Cemu" -fs HFS+ -srcfolder "./bin/Cemu_app"
+        hdiutil convert ./bin/tmp.dmg -format UDZO -o bin/Cemu.dmg
+        rm bin/tmp.dmg
+              
+    - name: Upload artifact
+      uses: actions/upload-artifact@v3
+      if: ${{ inputs.deploymode == 'release' }}
+      with:
+        name: cemu-bin-macos-x64
+        path: ./bin/Cemu.dmg

.github/workflows/build_check.yml

@@ -0,0 +1,21 @@
+name: Build check
+on: 
+  pull_request:
+    paths-ignore:
+      - "*.md"
+    types:
+      - opened
+      - synchronize
+      - reopened
+  push:
+    paths-ignore:
+      - "*.md"
+    branches:
+      - main
+
+jobs:
+  build:
+    uses: ./.github/workflows/build.yml
+    with:
+      deploymode: release
+      experimentalversion: 999999

.github/workflows/deploy_experimental_release.yml

@@ -0,0 +1,74 @@
+name: Deploy experimental release
+on: 
+  workflow_dispatch:
+
+jobs:
+  call-release-build:
+    uses: ./.github/workflows/build.yml
+    with:
+      deploymode: release
+      experimentalversion: ${{ github.run_number }}
+  deploy:
+    name: Deploy experimental release
+    runs-on: ubuntu-20.04
+    needs: call-release-build
+    steps:
+      - uses: actions/checkout@v2
+ 
+      - uses: actions/download-artifact@v3
+        with:
+          name: cemu-bin-linux-x64
+          path: cemu-bin-linux-x64
+
+      - uses: actions/download-artifact@v3
+        with:
+          name: cemu-bin-windows-x64
+          path: cemu-bin-windows-x64
+
+      - uses: actions/download-artifact@v3
+        with:
+          name: cemu-bin-macos-x64
+          path: cemu-bin-macos-x64
+
+      - name: Initialize
+        run: |
+          mkdir upload
+          sudo apt install zip
+          
+      - name: Get version
+        run: |
+          echo "Experimental version: ${{ github.run_number }}"
+          ls
+          gcc -o getversion .github/getversion.cpp
+          ./getversion
+          echo "Cemu CI version: $(./getversion)"
+          echo "CEMU_FOLDER_NAME=Cemu_$(./getversion)-${{ github.run_number }}" >> $GITHUB_ENV
+          echo "CEMU_VERSION=$(./getversion)-${{ github.run_number }}" >> $GITHUB_ENV
+
+      - name: Create release from windows-bin
+        run: |
+          ls ./
+          ls ./bin/
+          cp -R ./bin ./${{ env.CEMU_FOLDER_NAME }}
+          mv cemu-bin-windows-x64/Cemu.exe ./${{ env.CEMU_FOLDER_NAME }}/Cemu.exe
+          zip -9 -r upload/cemu-${{ env.CEMU_VERSION }}-windows-x64.zip ${{ env.CEMU_FOLDER_NAME }}
+          rm -r ./${{ env.CEMU_FOLDER_NAME }}
+          
+      - name: Create release from linux-bin
+        run: |
+          ls ./
+          ls ./bin/
+          cp -R ./bin ./${{ env.CEMU_FOLDER_NAME }}
+          mv cemu-bin-linux-x64/Cemu ./${{ env.CEMU_FOLDER_NAME }}/Cemu
+          zip -9 -r upload/cemu-${{ env.CEMU_VERSION }}-ubuntu-20.04-x64.zip ${{ env.CEMU_FOLDER_NAME }}
+          rm -r ./${{ env.CEMU_FOLDER_NAME }}
+          
+      - name: Create release from macos-bin
+        run: cp cemu-bin-macos-x64/Cemu.dmg upload/cemu-${{ env.CEMU_VERSION }}-macos-12-x64.dmg
+
+      - name: Create release
+        run: |
+          wget -O ghr.tar.gz https://github.com/tcnksm/ghr/releases/download/v0.15.0/ghr_v0.15.0_linux_amd64.tar.gz
+          tar xvzf ghr.tar.gz; rm ghr.tar.gz
+          echo "[INFO] Release tag: v${{ env.CEMU_VERSION }}"
+          ghr_v0.15.0_linux_amd64/ghr -prerelease -t ${{ secrets.GITHUB_TOKEN }} -n "Cemu ${{ env.CEMU_VERSION }} (Experimental)" -b "Cemu experimental release" "v${{ env.CEMU_VERSION }}" ./upload

.github/workflows/deploy_stable_release.yml

@@ -27,6 +27,11 @@ jobs:
           name: cemu-bin-windows-x64
           path: cemu-bin-windows-x64
 
+      - uses: actions/download-artifact@v3
+        with:
+          name: cemu-bin-macos-x64
+          path: cemu-bin-macos-x64
+
       - name: Initialize
         run: |
           mkdir upload
@@ -61,7 +66,10 @@ jobs:
           mv cemu-bin-linux-x64/Cemu ./${{ env.CEMU_FOLDER_NAME }}/Cemu
           zip -9 -r upload/cemu-${{ env.CEMU_VERSION }}-ubuntu-20.04-x64.zip ${{ env.CEMU_FOLDER_NAME }}
           rm -r ./${{ env.CEMU_FOLDER_NAME }}
-  
+          
+      - name: Create release from macos-bin
+        run: cp cemu-bin-macos-x64/Cemu.dmg upload/cemu-${{ env.CEMU_VERSION }}-macos-12-x64.dmg
+          
       - name: Create release
         run: |
           wget -O ghr.tar.gz https://github.com/tcnksm/ghr/releases/download/v0.15.0/ghr_v0.15.0_linux_amd64.tar.gz

.github/workflows/generate_pot.yml

@@ -0,0 +1,42 @@
+name: Generate translation template
+
+on:
+  pull_request:
+    paths-ignore:
+      - "*.md"
+    types:
+      - opened
+      - synchronize
+      - reopened
+  push:
+    paths-ignore:
+      - "*.md"
+    branches:
+      - main
+
+jobs:
+  generate-pot:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout repo"
+        uses: actions/checkout@v3
+
+      - name: "Install gettext"
+        run: |
+          sudo apt update -qq
+          sudo apt install -y gettext
+
+      - name: "Generate POT file using xgettext"
+        run: >
+          find src -name *.cpp -o -name *.hpp -o -name *.h | 
+          xargs xgettext --from-code=utf-8
+          -k_ -kwxTRANSLATE -w 100
+          --check=space-ellipsis --omit-header
+          -o cemu.pot
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: POT file
+          path: ./cemu.pot
+          if-no-files-found: error

.gitignore

@@ -13,10 +13,35 @@
 *.out
 *.app
 .vs
+.idea/
 
 build/
 out/
+.cache/
+bin/Cemu_*
+bin/Cemu_*.exe
 
 # Cemu bin files
-otp.bin
+bin/otp.bin
-seeprom.bin
+bin/seeprom.bin
+bin/log.txt
+bin/Cemu_*.pdb
+bin/Cemu_*.ilk
+bin/Cemu.exe.backup
+bin/mlc01/*
+bin/settings.xml
+bin/network_services.xml
+bin/title_list_cache.xml
+bin/debugger/*
+bin/sdcard/*
+bin/screenshots/*
+
+!bin/shaderCache/info.txt
+bin/shaderCache/*
+
+bin/controllerProfiles/*
+
+!bin/gameProfiles/default/*
+bin/gameProfiles/*
+
+bin/graphicPacks/*

.gitmodules

@@ -10,3 +10,9 @@
 	path = dependencies/vcpkg
 	url = https://github.com/microsoft/vcpkg
 	shallow = true
+[submodule "dependencies/Vulkan-Headers"]
+	path = dependencies/Vulkan-Headers
+	url = https://github.com/KhronosGroup/Vulkan-Headers
+[submodule "dependencies/imgui"]
+	path = dependencies/imgui
+	url = https://github.com/ocornut/imgui

BUILD.md

@@ -0,0 +1,92 @@
+# Build instructions
+
+## Windows
+
+Prerequisites:
+- A recent version of Visual Studio 2022 (recommended but not required) with the following additional components:
+  - C++ CMake tools for Windows
+  - Windows 10/11 SDK
+- git
+
+Instructions:
+
+1. Run `git clone --recursive https://github.com/cemu-project/Cemu`
+2. Launch `Cemu/generate_vs_solution.bat`.
+    - If you installed VS to a custom location or use VS 2019, you may need to manually change the path inside the .bat file.
+3. Wait until it's done, then open `Cemu/build/Cemu.sln` in Visual Studio.
+4. Then build the solution and once finished you can run and debug it, or build it and check the /bin folder for the final Cemu_release.exe.
+
+You can also skip steps 3-5 and open the root folder of the cloned repo directly in Visual Studio (as a folder) and use the built-in CMake support but be warned that cmake support in VS can be a bit finicky.
+
+## Linux
+
+To compile Cemu, a recent enough compiler and STL with C++20 support is required! clang-12 or higher is what we recommend.
+
+### Installing dependencies
+
+#### For Ubuntu and derivatives:
+`sudo apt install -y git curl cmake ninja-build nasm libgtk-3-dev libsecret-1-dev libgcrypt20-dev libsystemd-dev freeglut3-dev libpulse-dev` 
+
+*Additionally, for Ubuntu 22.04 only:*
+ - `sudo apt install -y clang-12`
+ - At step 3 while building, use  
+   `cmake -S . -B build -DCMAKE_BUILD_TYPE=release -DCMAKE_C_COMPILER=/usr/bin/clang-12 -DCMAKE_CXX_COMPILER=/usr/bin/clang++-12 -G Ninja -DCMAKE_MAKE_PROGRAM=/usr/bin/ninja`
+
+#### For Arch and derivatives:
+`sudo pacman -S --needed git cmake llvm clang ninja nasm base-devel linux-headers gtk3 libsecret libgcrypt systemd freeglut zip unzip libpulse`
+
+#### For Fedora and derivatives:
+`sudo dnf install git cmake clang ninja-build nasm kernel-headers gtk3-devel libsecret-devel libgcrypt-devel systemd-devel freeglut-devel perl-core zlib-devel cubeb-devel`
+
+### Build Cemu using cmake and clang
+1. `git clone --recursive https://github.com/cemu-project/Cemu`
+2. `cd Cemu`
+3. `cmake -S . -B build -DCMAKE_BUILD_TYPE=release -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -G Ninja`
+4. `cmake --build build`
+5. You should now have a Cemu executable file in the /bin folder, which you can run using `./bin/Cemu_release`.
+
+#### Using GCC
+While we use and test Cemu using clang, using GCC might work better with your distro (they should be fairly similar performance/issues wise and should only be considered if compilation is the issue).  
+You can use it by replacing the step 3 with the following:
+`cmake -S . -B build -DCMAKE_BUILD_TYPE=release -DCMAKE_C_COMPILER=/usr/bin/gcc -DCMAKE_CXX_COMPILER=/usr/bin/g++ -G Ninja`
+
+#### Troubleshooting steps
+ - If step 3 gives you an error about not being able to find ninja, try appending `-DCMAKE_MAKE_PROGRAM=/usr/bin/ninja` to the command and running it again.
+ - If step 3 fails while compiling the boost-build dependency, it means you don't have a working/good standard library installation. Check the integrity of your system headers and making sure that C++ related packages are installed and intact.
+ - If step 3 gives a random error, read the `[package-name-and-platform]-out.log` and `[package-name-and-platform]-err.log` for the actual reason to see if you might be lacking the headers from a dependency.
+ - If step 3 is still failing or if you're not able to find the cause, please make an issue on our Github about it!
+ - If step 4 gives you an error that contains something like `main.cpp.o: in function 'std::__cxx11::basic_string...`, you likely are experiencing a clang-14 issue. This can only be fixed by either lowering the clang version or using GCC, see below.
+ - If step 4 gives you a different error, you could report it to this repo or try using GCC. Just make sure your standard library and compilers are updated since Cemu uses a lot of modern features!
+- If step 4 gives you undefined libdecor_xx, you are likely experiencing an issue with sdl2 package that comes with vcpkg. Delete sdl2 from vcpkg.json in source file and recompile.
+
+## MacOS
+
+To compile Cemu, a recent enough compiler and STL with C++20 support is required! LLVM 13 and 
+below, built in LLVM, and Xcode LLVM don't support the C++20 feature set required. Currently, 
+LLVM 15 isn't supported due to compatibility issues with Boost dependency. The OpenGL graphics
+API isn't support on MacOS, Vulkan must be used. Additionally Vulkan must be used through the 
+Molten-VK compatibility layer.  
+
+### Installing brew
+`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
+
+### Installing dependencies
+`brew install git cmake llvm@14 ninja nasm molten-vk`
+
+### Build Cemu using cmake and clang
+1. `git clone --recursive https://github.com/cemu-project/Cemu`
+2. `cd Cemu`
+3. `cmake -S . -B build -DCMAKE_BUILD_TYPE=release
+   -DCMAKE_C_COMPILER=/usr/local/opt/llvm@14/bin/clang -DCMAKE_CXX_COMPILER=/usr/local/opt/llvm@14/bin/clang++ -G Ninja`
+4. `cmake --build build`
+5. You should now have a Cemu executable file in the /bin folder, which you can run using `./bin/Cemu_release`.
+
+#### Troubleshooting steps
+- If step 3 gives you an error about not being able to find ninja, try appending `-DCMAKE_MAKE_PROGRAM=/usr/local/bin/ninja` to the command and running it again.
+
+## Updating Cemu and source code
+1. To update your Cemu local repository, use the command `git pull --recurse-submodules` (run this command on the Cemu root).
+    - This should update your local copy of Cemu and all of its dependencies.
+2. Then, you can rebuild Cemu using the steps listed above, according to whether you use Linux or Windows.
+
+If CMake complains about Cemu already being compiled or another similar error, try deleting the `CMakeCache.txt` file inside the `build` folder and retry building.

CMakeLists.txt

@@ -1,116 +1,151 @@
 cmake_minimum_required(VERSION 3.21.1)
 
-option(PUBLIC_RELEASE "Compile with debug asserts disabled and no console" OFF)
+option(ENABLE_VCPKG "Enable the vcpkg package manager" ON)
+option(PORTABLE "All data created and maintained by Cemu will be in the directory where the executable file is located" ON)
+option(MACOS_BUNDLE "The executable when built on macOS will be created as an application bundle" OFF)
+set(EXPERIMENTAL_VERSION "" CACHE STRING "") # used by CI script to set experimental version
 
-if (PUBLIC_RELEASE)
+if (EXPERIMENTAL_VERSION)
-  add_definitions(-DPUBLIC_RELEASE)
+  add_definitions(-DEMULATOR_VERSION_MINOR=${EXPERIMENTAL_VERSION})
-  set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE) # enable LTO
 endif()
 
-if(WIN32)
+if (ENABLE_VCPKG)
-set(VCPKG_TARGET_TRIPLET "x64-windows-static" CACHE STRING "")
+	set(VCPKG_OVERLAY_PORTS "${CMAKE_CURRENT_LIST_DIR}/dependencies/vcpkg_overlay_ports")
+	set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_SOURCE_DIR}/dependencies/vcpkg/scripts/buildsystems/vcpkg.cmake"
+		CACHE STRING "Vcpkg toolchain file")
+	# Set this so that all the various find_package() calls don't need an explicit
+	# CONFIG option
+	set(CMAKE_FIND_PACKAGE_PREFER_CONFIG TRUE)
+	if (WIN32)
+		set(VCPKG_TARGET_TRIPLET "x64-windows-static" CACHE STRING "")
+	endif()
 endif()
 
-set(VCPKG_OVERLAY_PORTS "${CMAKE_CURRENT_LIST_DIR}/dependencies/vcpkg_overlay_ports")
+project(Cemu VERSION 2.0)
-set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_SOURCE_DIR}/dependencies/vcpkg/scripts/buildsystems/vcpkg.cmake"
+
-  CACHE STRING "Vcpkg toolchain file")
+list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake")
 
-project(Cemu VERSION 0.1)
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
+add_compile_definitions($<$<CONFIG:Debug>:CEMU_DEBUG_ASSERT>) # if build type is debug, set CEMU_DEBUG_ASSERT
+
+if(PORTABLE)
+	add_compile_definitions(PORTABLE)
+endif()
+
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
-IF(MSVC)
+# enable link time optimization for release builds
-    SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /EHsc")
+set(CMAKE_INTERPROCEDURAL_OPTIMIZATION_RELEASE ON)
-    SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /fp:precise") # floating point model: precise
+set(CMAKE_INTERPROCEDURAL_OPTIMIZATION_RELWITHDEBINFO ON)
-    SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /GT") # fiber safe optimizations
-ENDIF()
 
-IF(MSVC AND PUBLIC_RELEASE)
+if (MSVC)
-    message(STATUS "Using additional optimization flags for MSVC")
+	set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT CemuBin)
-    SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /Oi /Ot") # enable intrinsic functions, favor speed
+	# floating point model: precise, fiber safe optimizations
-ENDIF()
+	add_compile_options(/EHsc /fp:precise)
+	if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+		# Speeds up static linking (especially helpful in incremental compilation)
+		if((CMAKE_LINKER MATCHES ".*lld-link.*") AND (CMAKE_AR MATCHES ".*llvm-lib.*"))
+			set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY STATIC_LIBRARY_OPTIONS /llvmlibthin)
+		endif()
+  	else()
+	  add_compile_options(/GT)
+	endif()
+	# enable additional optimization flags for release builds
+	add_compile_options($<$<CONFIG:Release,RelWithDebInfo>:/Oi>) # enable intrinsic functions
+	add_compile_options($<$<CONFIG:Release,RelWithDebInfo>:/Ot>) # favor speed
+endif()
+
+if (APPLE)
+    enable_language(OBJC OBJCXX)
+endif()
 
 option(ENABLE_OPENGL "Enables the OpenGL backend" ON)
 option(ENABLE_VULKAN "Enables the Vulkan backend" ON)
 option(ENABLE_DISCORD_RPC "Enables the Discord Rich Presence feature" ON)
 
-if(WIN32)
-    option(ENABLE_CEMUHOOK "Enables Cemuhook compatibility" ON)
-endif()
-
 # input backends
-if(WIN32)
+if (WIN32)
-    option(ENABLE_XINPUT "Enables the usage of XInput" ON)
+	option(ENABLE_XINPUT "Enables the usage of XInput" ON)
-    option(ENABLE_DIRECTINPUT "Enables the usage of DirectInput" ON)
+	option(ENABLE_DIRECTINPUT "Enables the usage of DirectInput" ON)
-    add_definitions(-DHAS_DIRECTINPUT)
+	add_compile_definitions(HAS_DIRECTINPUT)
 endif()
 option(ENABLE_SDL "Enables the SDLController backend" ON)
 
 # audio backends
-if(WIN32)
+if (WIN32)
-option(ENABLE_DIRECTAUDIO "Enables the directaudio backend" ON)
+	option(ENABLE_DIRECTAUDIO "Enables the directaudio backend" ON)
-option(ENABLE_XAUDIO "Enables the xaudio backend" ON)
+	option(ENABLE_XAUDIO "Enables the xaudio backend" ON)
 endif()
 option(ENABLE_CUBEB "Enabled cubeb backend" ON)
 
 option(ENABLE_WXWIDGETS "Build with wxWidgets UI (Currently required)" ON)
 
-find_package(SDL2 CONFIG REQUIRED)
+set(THREADS_PREFER_PTHREAD_FLAG true)
-find_package(CURL CONFIG REQUIRED)
+find_package(Threads REQUIRED)
-find_package(pugixml CONFIG REQUIRED)
+find_package(SDL2 REQUIRED)
-find_package(imgui CONFIG REQUIRED)
+find_package(CURL REQUIRED)
-find_package(RapidJSON CONFIG REQUIRED)
+find_package(pugixml REQUIRED)
+find_package(RapidJSON REQUIRED)
 find_package(Boost COMPONENTS program_options filesystem nowide REQUIRED)
 find_package(libzip REQUIRED)
 find_package(glslang REQUIRED)
 find_package(ZLIB REQUIRED)
-find_package(zstd CONFIG REQUIRED)
+find_package(zstd MODULE REQUIRED) # MODULE so that zstd::zstd is available
+find_package(OpenSSL COMPONENTS Crypto SSL REQUIRED)
+find_package(glm REQUIRED)
+find_package(fmt 9.1.0 REQUIRED)
+find_package(PNG REQUIRED)
 
-if(ENABLE_VULKAN)
+# glslang versions older than 11.11.0 define targets without a namespace
-    find_package(Vulkan REQUIRED)
+if (NOT TARGET glslang::SPIRV AND TARGET SPIRV)
-    include_directories("${Vulkan_INCLUDE_DIRS}")
+	add_library(glslang::SPIRV ALIAS SPIRV)
-endif()
-if(ENABLE_OPENGL)
-    find_package(OpenGL REQUIRED)
-endif()
-if(ENABLE_DISCORD_RPC)
-    add_definitions(-DENABLE_DISCORD_RPC)
-    add_subdirectory(dependencies/discord-rpc EXCLUDE_FROM_ALL)
-    target_include_directories(discord-rpc INTERFACE ./dependencies/discord-rpc/include)
 endif()
 
-if(ENABLE_WXWIDGETS)
+if (UNIX AND NOT APPLE)
-    find_package(wxWidgets CONFIG REQUIRED)
+	find_package(X11 REQUIRED)
 endif()
 
-find_package(OpenSSL REQUIRED)
+if (ENABLE_VULKAN)
-find_package(X11)
+	include_directories("dependencies/Vulkan-Headers/include")
-
-# find a better way to handle this
-link_libraries(${Boost_LIBRARIES})
-link_libraries(${X11_LIBRARIES})
-link_libraries(SDL2::SDL2 SDL2::SDL2main SDL2::SDL2-static)
-if(ENABLE_WXWIDGETS)
-link_libraries(wx::core wx::base)
 endif()
 
-if(ENABLE_CUBEB)
+if (ENABLE_OPENGL)
-    option(BUILD_TESTS "" OFF)
+	find_package(OpenGL REQUIRED)
-    option(BUILD_TOOLS "" OFF)
-    option(BUNDLE_SPEEX "" OFF)
-    set(USE_WINMM OFF CACHE BOOL "")
-    add_subdirectory(dependencies/cubeb)
-    set_property(TARGET cubeb PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
-    link_libraries(cubeb)
-    add_compile_definitions(HAS_CUBEB=1)
 endif()
 
-add_subdirectory(dependencies/ih264d)
+if (ENABLE_DISCORD_RPC)
-add_subdirectory(dependencies/ZArchive)
+	add_compile_definitions(ENABLE_DISCORD_RPC)
+	add_subdirectory(dependencies/discord-rpc EXCLUDE_FROM_ALL)
+	target_include_directories(discord-rpc INTERFACE ./dependencies/discord-rpc/include)
+endif()
+
+if (ENABLE_WXWIDGETS)
+	find_package(wxWidgets 3.2 REQUIRED COMPONENTS base core gl propgrid xrc)
+endif()
+
+if (ENABLE_CUBEB)
+	find_package(cubeb)
+	if (NOT cubeb_FOUND)
+		option(BUILD_TESTS "" OFF)
+		option(BUILD_TOOLS "" OFF)
+		option(BUNDLE_SPEEX "" OFF)
+		set(USE_WINMM OFF CACHE BOOL "")
+		add_subdirectory("dependencies/cubeb" EXCLUDE_FROM_ALL)
+		set_property(TARGET cubeb PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
+		add_library(cubeb::cubeb ALIAS cubeb)
+	endif()
+	add_compile_definitions("HAS_CUBEB=1")
+endif()
+
+add_subdirectory("dependencies/ih264d" EXCLUDE_FROM_ALL)
+
+find_package(ZArchive)
+if (NOT ZArchive_FOUND)
+	add_subdirectory("dependencies/ZArchive" EXCLUDE_FROM_ALL)
+endif()
 
 add_subdirectory(src)
-

CMakeSettings.json

@@ -1,37 +1,28 @@
 {
   "configurations": [
     {
-      "name": "x64-Debug",
+      "name": "RelWithDebInfo",
+      "configurationType": "RelWithDebInfo",
+      "generator": "Ninja",
+      "inheritEnvironments": [ "msvc_x64_x64" ],
+      "buildRoot": "${projectDir}\\out\\build\\${name}",
+      "installRoot": "${projectDir}\\out\\install\\${name}"
+    },
+    {
+      "name": "Release",
+      "configurationType": "Release",
       "generator": "Ninja",
-      "configurationType": "Debug",
       "inheritEnvironments": [ "msvc_x64_x64" ],
       "buildRoot": "${projectDir}\\out\\build\\${name}",
       "installRoot": "${projectDir}\\out\\install\\${name}",
-      "cmakeCommandArgs": "",
-      "buildCommandArgs": "",
-      "ctestCommandArgs": ""
     },
     {
-      "name": "x64-Release",
+      "name": "Debug",
+      "configurationType": "Debug",
       "generator": "Ninja",
-      "configurationType": "RelWithDebInfo",
+      "inheritEnvironments": [ "msvc_x64_x64" ],
       "buildRoot": "${projectDir}\\out\\build\\${name}",
-      "installRoot": "${projectDir}\\out\\install\\${name}",
+      "installRoot": "${projectDir}\\out\\install\\${name}"
-      "cmakeCommandArgs": "",
-      "buildCommandArgs": "",
-      "ctestCommandArgs": "",
-      "inheritEnvironments": [ "msvc_x64_x64" ]
-    },
-    {
-      "name": "x64-Public-Release",
-      "generator": "Ninja",
-      "configurationType": "RelWithDebInfo",
-      "buildRoot": "${projectDir}\\out\\build\\${name}",
-      "installRoot": "${projectDir}\\out\\install\\${name}",
-      "cmakeCommandArgs": "-DPUBLIC_RELEASE=ON",
-      "buildCommandArgs": "",
-      "ctestCommandArgs": "",
-      "inheritEnvironments": [ "msvc_x64_x64" ]
     }
   ]
 }

README.md

@@ -0,0 +1,53 @@
+# **Cemu - Wii U emulator**
+
+[![Build Process](https://github.com/cemu-project/Cemu/actions/workflows/build.yml/badge.svg)](https://github.com/cemu-project/Cemu/actions/workflows/build.yml)
+[![Discord](https://img.shields.io/discord/286429969104764928?label=Cemu&logo=discord&logoColor=FFFFFF)](https://discord.gg/5psYsup)
+[![Matrix Server](https://img.shields.io/matrix/cemu:cemu.info?server_fqdn=matrix.cemu.info&label=cemu:cemu.info&logo=matrix&logoColor=FFFFFF)](https://matrix.to/#/#cemu:cemu.info)
+
+This is the code repository of Cemu, a Wii U emulator that is able to run most Wii U games and homebrew in a playable state.
+It's written in C/C++ and is being actively developed with new features and fixes to increase compatibility, convenience and usability.
+
+Cemu is currently only available for 64-bit Windows and Linux devices.
+
+### Links:
+ - [Original 2.0 announcement post](https://www.reddit.com/r/cemu/comments/wwa22c/cemu_20_announcement_linux_builds_opensource_and/)
+ - [Official Website](https://cemu.info)
+ - [Compatibility List/Wiki](https://wiki.cemu.info/wiki/Main_Page)
+ - [Official Subreddit](https://reddit.com/r/Cemu)
+ - [Official Discord](https://discord.gg/5psYsup)
+ - [Official Matrix Server](https://matrix.to/#/#cemu:cemu.info)
+ - [Unofficial Setup Guide](https://cemu.cfw.guide)
+
+#### Other relevant repositories:
+ - [Cemu-Language](https://github.com/cemu-project/Cemu-Language)
+ - [Cemu's Community Graphic Packs](https://github.com/ActualMandM/cemu_graphic_packs)
+
+## Download
+
+You can download the latest Cemu releases from the [GitHub Releases](https://github.com/cemu-project/Cemu/releases/) or from [Cemu's website](https://cemu.info).
+
+Cemu is currently only available in a portable format so no installation is required besides extracting it in a safe place.
+
+The native Linux build is currently a work-in-progress. See [Current State Of Linux builds](https://github.com/cemu-project/Cemu/issues/107) for more information about the things to be aware of. 
+
+Pre-2.0 releases can be found on Cemu's [changelog page](https://cemu.info/changelog.html).
+
+## Build Instructions
+
+To compile Cemu yourself on Windows or Linux, view the [BUILD.md file](/BUILD.md).
+
+## Issues
+
+Issues with the emulator should be filed using [GitHub Issues](https://github.com/cemu-project/Cemu/issues).  
+The old bug tracker can be found at [bugs.cemu.info](https://bugs.cemu.info) and still contains relevant issues and feature suggestions.
+
+## Contributing
+
+Pull requests are very welcome. For easier coordination you can visit the developer discussion channel on [Discord](https://discord.gg/5psYsup) or alternatively the [Matrix Server](https://matrix.to/#/#cemu:cemu.info).
+
+If coding isn't your thing, testing games and making detailed bug reports or updating the (usually outdated) compatibility wiki is also appreciated!
+
+Questions about Cemu's software architecture can also be answered on Discord (through the Matrix bridge).
+
+## License
+Cemu is licensed under [Mozilla Public License 2.0](/LICENSE.txt). Exempt from this are all files in the dependencies directory for which the licenses of the original code apply as well as some individual files in the src folder, as specified in those file headers respectively.

bin/gameProfiles/default/0005000010101a00.ini

@@ -1,7 +1 @@
-# LEGO City Undercover (USA)
+# LEGO City Undercover (USA)
-
-[General]
-loadSharedLibraries = false
-
-[Graphics]
-GPUBufferCacheAccuracy = 0

bin/gameProfiles/default/0005000010101b00.ini

@@ -1,7 +1 @@
-# LEGO City Undercover (EUR)
+# LEGO City Undercover (EUR)
-
-[General]
-loadSharedLibraries = false
-
-[Graphics]
-GPUBufferCacheAccuracy = 0

bin/gameProfiles/default/0005000010104d00.ini

@@ -1,5 +1,4 @@
 # Monster Hunter 3(tri-)GHD Ver. (JPN)
 
 [Graphics]
-GPUBufferCacheAccuracy = 1
 streamoutBufferCacheSize = 48

bin/gameProfiles/default/0005000010106100.ini

@@ -1,7 +1,4 @@
 # Super Mario 3D World (JPN)
 
-[CPU]
-
 [Graphics]
 accurateShaderMul = false
-GPUBufferCacheAccuracy = 2

bin/gameProfiles/default/000500001010EB00.ini

@@ -2,6 +2,3 @@
 
 [CPU]
 cpuMode = Singlecore-Recompiler
-
-[Graphics]
-GPUBufferCacheAccuracy = 2

bin/gameProfiles/default/000500001010F900.ini

@@ -1,7 +1 @@
-# Scribblenauts Unlimited (EUR)
+# Scribblenauts Unlimited (EUR)
-
-[General]
-loadSharedLibraries = true
-
-[Graphics]
-GPUBufferCacheAccuracy = 0