From b147f71e50f46d07f9f17747602ab4406fd98768 Mon Sep 17 00:00:00 2001 From: Zephyron-Dev Date: Thu, 16 Oct 2025 18:55:27 +1000 Subject: [PATCH] Initial CI setup with Discord notifications and updated repository links This repository builds upon the excellent work of previous contributors: - pkgforge-dev for the original Citron AppImage build scripts and infrastructure - CollectingW for the Citron-Nightly build workflows and automation Changes made in this commit: - Updated all repository links from pkgforge-dev/Citron-AppImage and CollectingW/Citron-Nightly to Zephyron-Dev/Citron-CI - Added Discord webhook notifications for successful builds (Android, Linux, Windows) - Integrated automated notifications with build metadata (version, date, download links) Build workflows included: - Android: Daily APK builds for arm64-v8a - Linux: Multiple variants (x86_64, x86_64_v3, PGO optimized) as AppImages - Windows: x64 builds with Qt6 support All builds run daily at 12 AM UTC and can be triggered manually via workflow_dispatch. --- .github/workflows/build-android.yml | 131 ++++++ .github/workflows/build-linux.yml | 140 ++++++ .github/workflows/build-windows.yml | 111 +++++ .pre-commit-config.yaml | 38 ++ LATEST_VERSION | 1 + LICENSE | 674 ++++++++++++++++++++++++++++ PKGBUILD | 69 +++ README.md | 47 ++ build-citron.sh | 124 +++++ get-dependencies.sh | 56 +++ package-citron.sh | 64 +++ 11 files changed, 1455 insertions(+) create mode 100644 .github/workflows/build-android.yml create mode 100644 .github/workflows/build-linux.yml create mode 100644 .github/workflows/build-windows.yml create mode 100644 .pre-commit-config.yaml create mode 100644 LATEST_VERSION create mode 100644 LICENSE create mode 100644 PKGBUILD create mode 100644 README.md create mode 100644 build-citron.sh create mode 100644 get-dependencies.sh create mode 100644 package-citron.sh diff --git a/.github/workflows/build-android.yml b/.github/workflows/build-android.yml new file mode 100644 index 0000000..533186b --- /dev/null +++ b/.github/workflows/build-android.yml @@ -0,0 +1,131 @@ +name: Build Citron (Android) + +on: + workflow_dispatch: + schedule: + - cron: "0 12 * * *" + +jobs: + build-android: + name: Build Android APK + runs-on: ubuntu-24.04 + outputs: + git_hash: ${{ steps.get_hash.outputs.git_hash }} + + steps: + - name: Clone Citron Source Code + run: git clone --recursive --depth 1 https://git.citron-emu.org/citron/emulator.git citron_source + + - name: Clean and Force-Update Submodules + working-directory: ./citron_source + run: | + git submodule deinit --all --force + git submodule update --init --recursive --force + + - name: Get Citron Commit Hash + id: get_hash + working-directory: ./citron_source + run: echo "git_hash=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT + + - name: Set up JDK 17 + uses: actions/setup-java@v4 + with: + distribution: 'temurin' + java-version: '17' + + - name: Install system dependencies + run: | + sudo apt-get update -qq + sudo apt-get install -y -qq wget unzip curl git cmake build-essential pkg-config zip glslang-tools + + - name: Install Android SDK + run: | + wget -q https://dl.google.com/android/repository/commandlinetools-linux-11076708_latest.zip + unzip -q commandlinetools-linux-11076708_latest.zip + mkdir -p android-sdk/cmdline-tools + mv cmdline-tools android-sdk/cmdline-tools/latest + echo "ANDROID_HOME=$PWD/android-sdk" >> $GITHUB_ENV + echo "$PWD/android-sdk/cmdline-tools/latest/bin" >> $GITHUB_PATH + + - name: Accept Android SDK licenses and install components + run: | + yes | sdkmanager --licenses > /dev/null || true + sdkmanager "platform-tools" "platforms;android-34" "build-tools;34.0.0" + + - name: Install Android NDK + run: | + wget -q https://dl.google.com/android/repository/android-ndk-r26b-linux.zip + unzip -q android-ndk-r26b-linux.zip + echo "ANDROID_NDK_HOME=$PWD/android-ndk-r26b" >> $GITHUB_ENV + + - name: Configure CMake + run: | + cmake -B build-android -S citron_source \ + -DCMAKE_BUILD_TYPE=Release \ + -DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK_HOME/build/cmake/android.toolchain.cmake \ + -DANDROID_ABI=arm64-v8a \ + -DANDROID_PLATFORM=android-30 \ + -DENABLE_QT=OFF \ + -DENABLE_SDL2=OFF \ + -DENABLE_WEB_SERVICE=OFF \ + -DCITRON_USE_BUNDLED_VCPKG=ON \ + -DCITRON_USE_BUNDLED_FFMPEG=ON \ + -DANDROID_ARM_NEON=ON \ + -DCITRON_ENABLE_LTO=ON + + - name: Build with CMake + run: | + cmake --build build-android --config Release --parallel $(nproc) + + - name: Build APK with Gradle + run: | + cd citron_source/src/android + export ANDROID_SDK_ROOT="$ANDROID_HOME" + ./gradlew assembleMainlineRelease + + - name: Upload APK artifact + uses: actions/upload-artifact@v4 + with: + name: citron-android-nightly + path: citron_source/src/android/app/build/outputs/apk/mainline/release/*.apk + + release-android: + name: "Release Android Nightly" + needs: [build-android] + permissions: + contents: write + runs-on: ubuntu-latest + + steps: + - name: Download APK artifact + uses: actions/download-artifact@v4 + with: + name: citron-android-nightly + path: . + + - name: Get version info for release name + shell: bash + run: | + echo "DATE=$(date +'%Y-%m-%d')" >> $GITHUB_ENV + echo "GIT_HASH=${{ needs.build-android.outputs.git_hash }}" >> $GITHUB_ENV + + - name: Delete previous nightly release and tag + run: gh release delete "nightly-android" --repo "${{ github.repository }}" --cleanup-tag -y || true + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Create new nightly release + uses: softprops/action-gh-release@v2 + with: + name: "Continuous Build: (Android Nightly: ${{ env.GIT_HASH }})" + tag_name: "nightly-android" + prerelease: true + files: "*.apk" + + - name: Post to Discord + if: success() + run: | + DOWNLOAD_URL="https://github.com/${{ github.repository }}/releases/tag/nightly-android" + curl -H "Content-Type: application/json" \ + -d "{\"content\":\"πŸ€– **New Android Build Available!**\n\nπŸ“¦ **Version:** \`${{ env.GIT_HASH }}\`\nπŸ“… **Date:** ${{ env.DATE }}\nπŸ”— **Download:** $DOWNLOAD_URL\"}" \ + https://discord.com/api/webhooks/1428304731809517588/fG7t7MBprKFss5oGcI05DIFM3JdO41Z0juSV_zOfb9K-UTvyI2fd3-Ciwi48npWXYHLb \ No newline at end of file diff --git a/.github/workflows/build-linux.yml b/.github/workflows/build-linux.yml new file mode 100644 index 0000000..76ba444 --- /dev/null +++ b/.github/workflows/build-linux.yml @@ -0,0 +1,140 @@ +name: Build Citron (Linux) +concurrency: + group: build-nightly-${{ github.ref }} + cancel-in-progress: true + +on: + schedule: + - cron: "0 12 * * *" + workflow_dispatch: {} + +jobs: + build: + name: "${{ matrix.name }}" + runs-on: ${{ matrix.os }} # Use matrix to select the runner + timeout-minutes: 120 + strategy: + fail-fast: false # Allows all matrix jobs to complete + matrix: + include: + # --- x86_64 Builds --- + - name: "Citron Build (Normal x86_64)" + os: ubuntu-latest + arch_suffix: "" + build_arg: "" + - name: "Citron Build (Optimized x86_64)" + os: ubuntu-latest + arch_suffix: "_v3" + build_arg: "v3" + - name: "Citron Build (Normal PGO x86_64)" + os: ubuntu-latest + arch_suffix: "_pgo" + build_arg: "pgo" + - name: "Citron Build (Optimized PGO x86_64)" + os: ubuntu-latest + arch_suffix: "_v3_pgo" + build_arg: "v3-pgo" + + container: ghcr.io/pkgforge-dev/archlinux:latest + + steps: + - name: Install Git + run: pacman -Syu --noconfirm --needed git + + - name: Checkout Workflow Scripts + uses: actions/checkout@v4 + + - name: Checkout Upstream Source Code + run: git clone --recurse-submodules https://git.citron-emu.org/citron/emulator.git emulator + + - name: Prepare Build Environment + run: | + mv get-dependencies.sh emulator/ + mv build-citron.sh emulator/ + mv package-citron.sh emulator/ + + - name: Add Git Safe Directory + working-directory: ./emulator + run: git config --global --add safe.directory "$PWD" + + - name: Install dependencies + working-directory: ./emulator + run: chmod +x ./get-dependencies.sh && ./get-dependencies.sh + + - name: Build Citron from source + working-directory: ./emulator + run: | + NPROC_VAL=$(nproc --all) + JOBS_VAL=$((NPROC_VAL > 4 ? 4 : NPROC_VAL)) + chmod +x ./build-citron.sh + JOBS=${JOBS_VAL} DEVEL=true ./build-citron.sh ${{ matrix.build_arg }} + + - name: Package AppImage with Correct Name + working-directory: ./emulator + run: | + GIT_SHA=$(git rev-parse --short HEAD) + + export APP_VERSION="${GIT_SHA}" + export VERSION="${GIT_SHA}" + export ARCH_SUFFIX="${{ matrix.arch_suffix }}" + export DEVEL="true" + + chmod +x ./package-citron.sh + ./package-citron.sh + + - name: Upload Artifacts + uses: actions/upload-artifact@v4 + with: + name: Artifacts${{ matrix.arch_suffix }} + path: emulator/dist/ + + release: + if: ${{ github.ref_name == 'main' }} + name: "release" + needs: [build] + permissions: + actions: read + security-events: write + contents: write + runs-on: ubuntu-latest + steps: + - name: Checkout Upstream Repository + run: git clone https://git.citron-emu.org/citron/emulator.git . + + - name: Set Version + id: version + run: echo "sha=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT + + - name: Download all artifacts + uses: actions/download-artifact@v4 + with: + pattern: Artifacts* + merge-multiple: true + path: . + + - name: Del Previous Release + run: gh release delete "nightly-linux" --repo "${GITHUB_REPOSITORY}" --cleanup-tag -y && sleep 5 + env: + GH_TOKEN: "${{ secrets.GITHUB_TOKEN }}" + continue-on-error: true + + - uses: softprops/action-gh-release@v2 + with: + name: "Continuous Build (Linux Nightly: ${{ steps.version.outputs.sha }})" + tag_name: "nightly-linux" + prerelease: true + draft: false + generate_release_notes: false + make_latest: false + files: | + *.AppImage* + *.tar.zst + + - name: Post to Discord + if: success() + run: | + DOWNLOAD_URL="https://github.com/${{ github.repository }}/releases/tag/nightly-linux" + DATE=$(date +'%Y-%m-%d') + curl -H "Content-Type: application/json" \ + -d "{\"content\":\"🐧 **New Linux Build Available!**\n\nπŸ“¦ **Version:** \`${{ steps.version.outputs.sha }}\`\nπŸ“… **Date:** ${DATE}\nπŸ”— **Download:** $DOWNLOAD_URL\n\n✨ Includes x86_64, x86_64_v3, PGO builds\"}" \ + https://discord.com/api/webhooks/1428304731809517588/fG7t7MBprKFss5oGcI05DIFM3JdO41Z0juSV_zOfb9K-UTvyI2fd3-Ciwi48npWXYHLb \ No newline at end of file diff --git a/.github/workflows/build-windows.yml b/.github/workflows/build-windows.yml new file mode 100644 index 0000000..755b137 --- /dev/null +++ b/.github/workflows/build-windows.yml @@ -0,0 +1,111 @@ +name: Build Citron (Windows) +concurrency: + group: build-windows-nightly-${{ github.ref }} + cancel-in-progress: true + +on: + schedule: + - cron: "0 12 * * *" + workflow_dispatch: {} + +jobs: + build: + name: "Citron Build (Windows)" + runs-on: windows-latest + timeout-minutes: 120 + + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + + - name: Install Vulkan SDK + shell: pwsh + run: | + $vulkan_sdk_url = "https://sdk.lunarg.com/sdk/download/1.3.283.0/windows/VulkanSDK-1.3.283.0-Installer.exe" + Invoke-WebRequest -Uri $vulkan_sdk_url -OutFile VulkanSDK-Installer.exe + Start-Process -FilePath ".\VulkanSDK-Installer.exe" -ArgumentList "--accept-licenses", "--default-answer", "--confirm-command", "install" -Wait + echo "C:\VulkanSDK\1.3.283.0\Bin" | Out-File -FilePath $env:GITHUB_PATH -Append + + - name: Clone Citron Source + shell: bash + run: git clone --recursive "https://git.citron-emu.org/citron/emulator.git" citron + + - name: Get Nightly Version + id: version + working-directory: ./citron + shell: bash + run: | + git fetch --tags + VERSION=$(git rev-parse --short HEAD) + echo "VERSION=${VERSION}" >> $GITHUB_OUTPUT + + - name: Configure CMake + working-directory: ./citron + shell: cmd + run: | + cmake -B build -S . -G "Visual Studio 17 2022" -A x64 ^ + -DCITRON_USE_BUNDLED_VCPKG=ON ^ + -DCITRON_ENABLE_LTO=ON ^ + -DCITRON_USE_BUNDLED_QT=ON ^ + -DENABLE_QT6=ON ^ + -DCITRON_TESTS=OFF ^ + -DUSE_DISCORD_PRESENCE=ON + + - name: Build Citron + working-directory: ./citron + shell: cmd + run: cmake --build build --config Release --parallel + + - name: Package Windows Build + shell: pwsh + run: | + mkdir dist + echo "Creating final zip archive..." + Compress-Archive -Path ".\citron\build\bin\Release\*" -DestinationPath ".\dist\Citron-windows-nightly-${{ steps.version.outputs.VERSION }}.zip" + + - name: Upload Windows Build + uses: actions/upload-artifact@v4 + with: + name: Citron-Windows-Nightly + path: "dist/*.zip" + + release: + if: ${{ github.ref_name == 'main' }} + name: "Release" + needs: [build] + permissions: + contents: write + runs-on: ubuntu-latest + steps: + - uses: actions/download-artifact@v4 + with: + name: Citron-Windows-Nightly + path: . + - name: Get Version from Filename + shell: bash + run: | + FILENAME=$(ls *.zip) + VERSION=${FILENAME#Citron-windows-nightly-} + VERSION=${VERSION%.zip} + echo "APP_VERSION=${VERSION}" >> $GITHUB_ENV + - name: Delete Previous Release + run: gh release delete "nightly-windows" --repo "${{ github.repository }}" --cleanup-tag -y || true + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: Release Artifacts + uses: softprops/action-gh-release@v2 + with: + name: "Continuous Build (Windows Nightly: ${{ env.APP_VERSION }})" + tag_name: "nightly-windows" + prerelease: true + files: "*.zip" + + - name: Post to Discord + if: success() + run: | + DOWNLOAD_URL="https://github.com/${{ github.repository }}/releases/tag/nightly-windows" + DATE=$(date +'%Y-%m-%d') + curl -H "Content-Type: application/json" \ + -d "{\"content\":\"πŸͺŸ **New Windows Build Available!**\n\nπŸ“¦ **Version:** \`${{ env.APP_VERSION }}\`\nπŸ“… **Date:** ${DATE}\nπŸ”— **Download:** $DOWNLOAD_URL\"}" \ + https://discord.com/api/webhooks/1428304731809517588/fG7t7MBprKFss5oGcI05DIFM3JdO41Z0juSV_zOfb9K-UTvyI2fd3-Ciwi48npWXYHLb \ No newline at end of file diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..d359fac --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,38 @@ +--- +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v5.0.0 + hooks: + - id: check-executables-have-shebangs + - id: check-merge-conflict + - id: check-shebang-scripts-are-executable + - id: fix-byte-order-marker + - id: mixed-line-ending + - id: end-of-file-fixer + - id: trailing-whitespace + args: [--markdown-linebreak-ext=md] + - id: check-yaml + - id: no-commit-to-branch + + - repo: https://github.com/shellcheck-py/shellcheck-py + rev: v0.10.0.1 + hooks: + - id: shellcheck + args: ["--severity=error"] + + - repo: https://github.com/scop/pre-commit-shfmt + rev: v3.10.0-2 + hooks: + - id: shfmt + args: ["-w", "-s"] + + - repo: https://github.com/rhysd/actionlint + rev: v1.7.6 + hooks: + - id: actionlint + + - repo: https://github.com/woodruffw/zizmor + rev: v0.8.0 + hooks: + - id: zizmor + files: ^\.github/workflows/.*\.ya?ml$ diff --git a/LATEST_VERSION b/LATEST_VERSION new file mode 100644 index 0000000..a3df0a6 --- /dev/null +++ b/LATEST_VERSION @@ -0,0 +1 @@ +0.8.0 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/PKGBUILD b/PKGBUILD new file mode 100644 index 0000000..9f1c57e --- /dev/null +++ b/PKGBUILD @@ -0,0 +1,69 @@ +# Maintainer: Collecting + +# The '-git' suffix signifies this is a bleeding-edge build from the git repo +pkgname=citron-git +pkgver=0.1.r0.g1a2b3c4 # This will be replaced by the pkgver() function +pkgrel=1 +pkgdesc="A Nintendo Switch emulator" +arch=('x86_64' 'aarch64') +url="https://citron-emu.org/" +license=('GPL2') + +# Dependencies needed to run the emulator +depends=( + 'boost-libs' 'enet' 'fmt' 'ffmpeg' 'gamemode' 'glslang' 'hicolor-icon-theme' + 'libdecor' 'libxkbcommon-x11' 'mbedtls2' 'nlohmann-json' 'qt6-base' + 'qt6-multimedia' 'sdl2' 'vulkan-icd-loader' +) + +# Dependencies needed only to build the emulator from source +makedepends=( + 'boost' 'catch2' 'cmake' 'git' 'ninja' 'nasm' 'qt6-tools' 'vulkan-headers' +) + +# This points to the source code repository +source=("git+https://git.citron-emu.org/citron/emulator.git") +sha256sums=('SKIP') + +# This function automatically generates a version string based on the latest git commit +pkgver() { + cd "$pkgname" + git describe --long --tags | sed 's/\([^-]*-g\)/r\1/;s/-/./g' +} + +# This function runs before the build and is used to apply patches +prepare() { + cd "$pkgname" + # Apply compatibility patches for newer Boost versions + find . -type f \( -name '*.cpp' -o -name '*.h' \) | xargs sed -i 's/\bboost::asio::io_service\b/boost::asio::io_context/g' + find . -type f \( -name '*.cpp' -o -name '*.h' \) | xargs sed -i 's/\bboost::asio::io_service::strand\b/boost::asio::strand/g' + find . -type f \( -name '*.cpp' -o -name '*.h' \) | xargs sed -i 's|#include *|#include |g' + find . -type f \( -name '*.cpp' -o -name '*.h' \) | xargs sed -i 's/\bboost::process::async_pipe\b/boost::process::v1::async_pipe/g' +} + +# This function contains the build commands +build() { + cd "$pkgname" + # makepkg sets CFLAGS and CXXFLAGS, so we don't need to specify arch flags + cmake -B build -S . -GNinja \ + -DCMAKE_BUILD_TYPE=Release \ + -DCMAKE_INSTALL_PREFIX=/usr \ + -DCITRON_USE_BUNDLED_VCPKG=OFF \ + -DCITRON_USE_BUNDLED_QT=OFF \ + -DUSE_SYSTEM_QT=ON \ + -DCITRON_USE_BUNDLED_FFMPEG=OFF \ + -DCITRON_USE_BUNDLED_SDL2=OFF \ + -DCITRON_TESTS=OFF \ + -DCITRON_CHECK_SUBMODULES=OFF \ + -DCITRON_ENABLE_LTO=ON \ + -DCITRON_USE_QT_MULTIMEDIA=ON \ + -DENABLE_QT_TRANSLATION=ON + + ninja -C build +} + +# This function installs the built files into a temporary directory +package() { + cd "$pkgname" + DESTDIR="$pkgdir/" ninja -C build install +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..29be6b6 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# Citron-Nightly 🐧 + +[![GitHub Downloads](https://img.shields.io/github/downloads/Zephyron-Dev/Citron-CI/total?logo=github&label=GitHub%20Downloads)](https://github.com/Zephyron-Dev/Citron-CI/releases/latest) +[![CI Build Status](https://github.com/Zephyron-Dev/Citron-CI/actions/workflows/build-stable.yml/badge.svg)](https://github.com/Zephyron-Dev/Citron-CI/releases/latest) + +This repository makes Nightly builds for **x86_64** (generic) and **x86_64_v3** on Linux, and also Windows & Android builds! If your CPU is less than 10 years old, for Linux, use the x86_64_v3 build since it has a significant performance boost. These builds are all produced @ 12 AM UTC every single day. + +* [Latest Commits Can Be Found Here](https://git.citron-emu.org/citron/emulator/-/commits/f3374ea7e61cb0bba79d17272964717e37935575) + +* [Latest Android Nightly Release](https://github.com/Zephyron-Dev/Citron-CI/releases/tag/nightly-android) + +* [Latest Linux Nightly Release](https://github.com/Zephyron-Dev/Citron-CI/releases/tag/nightly-linux) + +* [Latest Windows Nightly Release](https://github.com/Zephyron-Dev/Citron-CI/releases/tag/nightly-windows) + +# READ THIS IF YOU HAVE ISSUES + +If you are on wayland (specially GNOME wayland) and get freezes or crahes you are likely affected by this issue that affects all Qt6 apps: https://github.com/Zephyron-Dev/Citron-CI/issues/50 + +To fix it simply set the env variable `QT_QPA_PLATFORM=xcb` + +--- + +**Looking for AppImages of other emulators? Check:** [AnyLinux-AppImages](https://pkgforge-dev.github.io/Anylinux-AppImages/) + +---- + +AppImage made using [sharun](https://github.com/VHSgunzo/sharun), which makes it extremely easy to turn any binary into a portable package without using containers or similar tricks. + +**This AppImage bundles everything and should work on any linux distro, even on musl based ones.** + +It is possible that this appimage may fail to work with appimagelauncher, I recommend these alternatives instead: + +* [AM](https://github.com/ivan-hc/AM) `am -i citron` or `appman -i citron` + +* [dbin](https://github.com/xplshn/dbin) `dbin install citron.appimage` + +* [soar](https://github.com/pkgforge/soar) `soar install citron` + +This appimage works without fuse2 as it can use fuse3 instead, it can also work without fuse at all thanks to the [uruntime](https://github.com/VHSgunzo/uruntime) + +
+ raison d'Γͺtre + Inspiration Image + +
+ diff --git a/build-citron.sh b/build-citron.sh new file mode 100644 index 0000000..9ac07a9 --- /dev/null +++ b/build-citron.sh @@ -0,0 +1,124 @@ +#!/bin/sh +set -ex + +ARCH="${ARCH:-$(uname -m)}" +BUILD_PGO=false + +if [ "$1" = 'v3-pgo' ] && [ "$ARCH" = 'x86_64' ]; then + ARCH_FLAGS="-march=x86-64-v3 -O3 -USuccess -UNone -fuse-ld=lld" + BUILD_PGO=true +elif [ "$1" = 'pgo' ] && [ "$ARCH" = 'x86_64' ]; then + ARCH_FLAGS="-march=x86-64 -mtune=generic -O3 -USuccess -UNone -fuse-ld=lld" + BUILD_PGO=true +elif [ "$1" = 'v3' ] && [ "$ARCH" = 'x86_64' ]; then + ARCH_FLAGS="-march=x86-64-v3 -O3 -USuccess -UNone -fuse-ld=lld" +elif [ "$ARCH" = 'x86_64' ]; then + ARCH_FLAGS="-march=x86-64 -mtune=generic -O3 -USuccess -UNone -fuse-ld=lld" +else + + ARCH_FLAGS="-march=armv8-a -mtune=generic -O3 -USuccess -UNone -fuse-ld=lld" + +fi + +git clone --recursive "https://git.citron-emu.org/citron/emulator.git" ./citron +cd ./citron + +if [ "$DEVEL" = 'true' ]; then + CITRON_TAG="$(git rev-parse --short HEAD)" + VERSION="$CITRON_TAG" +else + CITRON_TAG=$(git describe --tags) + git checkout "$CITRON_TAG" + VERSION="$(echo "$CITRON_TAG" | awk -F'-' '{print $1}')" +fi + +find . -type f \( -name '*.cpp' -o -name '*.h' \) | xargs sed -i 's/\bboost::asio::io_service\b/boost::asio::io_context/g' +find . -type f \( -name '*.cpp' -o -name '*.h' \) | xargs sed -i 's/\bboost::asio::io_service::strand\b/boost::asio::strand/g' +find . -type f \( -name '*.cpp' -o -name '*.h' \) | xargs sed -i 's|#include *|#include |g' +find . -type f \( -name '*.cpp' -o -name '*.h' \) | xargs sed -i 's/\bboost::process::async_pipe\b/boost::process::v1::async_pipe/g' +sed -i '/sse2neon/d' ./src/video_core/CMakeLists.txt +sed -i '/sse2neon/d' ./src/video_core/CMakeLists.txt +sed -i 's/cmake_minimum_required(VERSION 2.8)/cmake_minimum_required(VERSION 3.5)/' externals/xbyak/CMakeLists.txt + +HEADER_PATH=$(pacman -Ql qt6-base | grep 'qpa/qplatformnativeinterface.h$' | awk '{print $2}') +if [ -z "$HEADER_PATH" ]; then + echo "ERROR: Could not find qplatformnativeinterface.h path." >&2 + exit 1 +fi +QT_PRIVATE_INCLUDE_DIR=$(dirname "$(dirname "$HEADER_PATH")") +CXX_FLAGS_EXTRA="-I${QT_PRIVATE_INCLUDE_DIR}" + +if [ -z "$JOBS" ]; then JOBS=$(nproc --all); fi + +if [ "$BUILD_PGO" = true ]; then + # STAGE 1: Build with instrumentation using manual flags for reliability + mkdir build_instrumented && cd build_instrumented + PGO_FLAGS="-fprofile-generate" + cmake .. -GNinja \ + -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ \ + -DCITRON_USE_BUNDLED_VCPKG=OFF -DCITRON_USE_BUNDLED_QT=OFF -DUSE_SYSTEM_QT=ON -DENABLE_QT6=ON \ + -DCITRON_USE_BUNDLED_FFMPEG=OFF -DCITRON_USE_BUNDLED_SDL2=ON -DCITRON_USE_EXTERNAL_SDL2=OFF \ + -DCITRON_TESTS=OFF -DCITRON_CHECK_SUBMODULES=OFF -DCITRON_USE_LLVM_DEMANGLE=OFF \ + -DCITRON_ENABLE_LTO=ON -DCITRON_USE_QT_MULTIMEDIA=ON -DCITRON_USE_QT_WEB_ENGINE=OFF \ + -DENABLE_QT_TRANSLATION=ON -DUSE_DISCORD_PRESENCE=ON -DBUNDLE_SPEEX=ON -DCITRON_USE_FASTER_LD=OFF \ + -DCITRON_USE_EXTERNAL_Vulkan_HEADERS=ON -DCITRON_USE_EXTERNAL_VULKAN_UTILITY_LIBRARIES=ON \ + -DCITRON_ENABLE_UPDATER=OFF -DCMAKE_INSTALL_PREFIX=/usr \ + -DCMAKE_CXX_FLAGS="$ARCH_FLAGS $PGO_FLAGS -Wno-error -w ${CXX_FLAGS_EXTRA}" \ + -DCMAKE_C_FLAGS="$ARCH_FLAGS $PGO_FLAGS" \ + -DCMAKE_SYSTEM_PROCESSOR="$(uname -m)" -DCMAKE_BUILD_TYPE=Release \ + -DCMAKE_POLICY_VERSION_MINIMUM=3.5 + ninja -j${JOBS} + + # STAGE 2: Generate, merge, and copy profile data + echo "Starting instrumented application to generate profile data..." + export LLVM_PROFILE_FILE="${PWD}/citron.profraw" + xvfb-run -a --server-args="-screen 0 1024x768x24" ./bin/citron & + XVFB_PID=$! + echo "Running for 20 seconds to collect data... (PID: $XVFB_PID)" + sleep 20 + echo "Stopping application..." + kill -9 $XVFB_PID || true + echo "Application stopped." + llvm-profdata merge -o ./default.profdata "${LLVM_PROFILE_FILE}" + + cd .. && rm -rf build && mkdir build + echo "Copying profile data to the final build directory..." + cp build_instrumented/default.profdata build/ + cd build + + # STAGE 3: Build again using manual flags for reliability + PGO_FLAGS="-fprofile-use=${PWD}/default.profdata" + cmake .. -GNinja \ + -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ \ + -DCITRON_USE_BUNDLED_VCPKG=OFF -DCITRON_USE_BUNDLED_QT=OFF -DUSE_SYSTEM_QT=ON -DENABLE_QT6=ON \ + -DCITRON_USE_BUNDLED_FFMPEG=OFF -DCITRON_USE_BUNDLED_SDL2=ON -DCITRON_USE_EXTERNAL_SDL2=OFF \ + -DCITRON_TESTS=OFF -DCITRON_CHECK_SUBMODULES=OFF -DCITRON_USE_LLVM_DEMANGLE=OFF \ + -DCITRON_ENABLE_LTO=ON -DCITRON_USE_QT_MULTIMEDIA=ON -DCITRON_USE_QT_WEB_ENGINE=OFF \ + -DENABLE_QT_TRANSLATION=ON -DUSE_DISCORD_PRESENCE=ON -DBUNDLE_SPEEX=ON -DCITRON_USE_FASTER_LD=OFF \ + -DCITRON_USE_EXTERNAL_Vulkan_HEADERS=ON -DCITRON_USE_EXTERNAL_VULKAN_UTILITY_LIBRARIES=ON \ + -DCITRON_ENABLE_UPDATER=OFF -DCMAKE_INSTALL_PREFIX=/usr \ + -DCMAKE_CXX_FLAGS="$ARCH_FLAGS $PGO_FLAGS -Wno-error -w ${CXX_FLAGS_EXTRA}" \ + -DCMAKE_C_FLAGS="$ARCH_FLAGS $PGO_FLAGS" \ + -DCMAKE_SYSTEM_PROCESSOR="$(uname -m)" -DCMAKE_BUILD_TYPE=Release \ + -DCMAKE_POLICY_VERSION_MINIMUM=3.5 +else + # REGULAR BUILD + mkdir build && cd build + cmake .. -GNinja \ + -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ \ + -DCITRON_USE_BUNDLED_VCPKG=OFF -DCITRON_USE_BUNDLED_QT=OFF -DUSE_SYSTEM_QT=ON -DENABLE_QT6=ON \ + -DCITRON_USE_BUNDLED_FFMPEG=OFF -DCITRON_USE_BUNDLED_SDL2=ON -DCITRON_USE_EXTERNAL_SDL2=OFF \ + -DCITRON_TESTS=OFF -DCITRON_CHECK_SUBMODULES=OFF -DCITRON_USE_LLVM_DEMANGLE=OFF \ + -DCITRON_ENABLE_LTO=ON -DCITRON_USE_QT_MULTIMEDIA=ON -DCITRON_USE_QT_WEB_ENGINE=OFF \ + -DENABLE_QT_TRANSLATION=ON -DUSE_DISCORD_PRESENCE=ON -DBUNDLE_SPEEX=ON -DCITRON_USE_FASTER_LD=OFF \ + -DCITRON_USE_EXTERNAL_Vulkan_HEADERS=ON -DCITRON_USE_EXTERNAL_VULKAN_UTILITY_LIBRARIES=ON \ + -DCITRON_ENABLE_UPDATER=OFF -DCMAKE_INSTALL_PREFIX=/usr \ + -DCMAKE_CXX_FLAGS="$ARCH_FLAGS -Wno-error -w ${CXX_FLAGS_EXTRA}" \ + -DCMAKE_C_FLAGS="$ARCH_FLAGS" \ + -DCMAKE_SYSTEM_PROCESSOR="$(uname -m)" -DCMAKE_BUILD_TYPE=Release \ + -DCMAKE_POLICY_VERSION_MINIMUM=3.5 +fi + +ninja -j${JOBS} +sudo ninja install +echo "$VERSION" >~/version diff --git a/get-dependencies.sh b/get-dependencies.sh new file mode 100644 index 0000000..cc7e383 --- /dev/null +++ b/get-dependencies.sh @@ -0,0 +1,56 @@ +#!/bin/sh + +set -ex +ARCH="$(uname -m)" + +pacman -Syu --noconfirm --needed \ + base-devel \ + boost \ + boost-libs \ + catch2 \ + clang \ + cmake \ + curl \ + enet \ + fmt \ + ffmpeg \ + gamemode \ + gcc \ + git \ + glslang \ + glu \ + hidapi \ + libdecor \ + libvpx \ + libxi \ + libxkbcommon-x11 \ + libxss \ + lld \ + llvm \ + mbedtls2 \ + mesa \ + nasm \ + ninja \ + nlohmann-json \ + numactl \ + openal \ + pulseaudio \ + pulseaudio-alsa \ + qt6-base \ + qt6-networkauth \ + qt6-multimedia \ + qt6-tools \ + qt6-wayland \ + qt6-translations \ + sdl2 \ + unzip \ + vulkan-headers \ + vulkan-mesa-layers \ + wget \ + xcb-util-cursor \ + xcb-util-image \ + xcb-util-renderutil \ + xcb-util-wm \ + xorg-server-xvfb \ + zip \ + zsync diff --git a/package-citron.sh b/package-citron.sh new file mode 100644 index 0000000..5cf6d28 --- /dev/null +++ b/package-citron.sh @@ -0,0 +1,64 @@ +#!/bin/sh +set -ex +ARCH="${ARCH:-$(uname -m)}" + +# The VERSION is now passed as an environment variable from the workflow +if [ -z "$APP_VERSION" ]; then + echo "Error: APP_VERSION environment variable is not set." + exit 1 +fi + +# Construct unique names for the AppImage and tarball based on the build matrix. +OUTNAME_BASE="citron_nightly-${APP_VERSION}-linux-${ARCH}${ARCH_SUFFIX}" +export OUTNAME_APPIMAGE="${OUTNAME_BASE}.AppImage" +export OUTNAME_TAR="${OUTNAME_BASE}.tar.zst" + +URUNTIME="https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/uruntime2appimage.sh" +SHARUN="https://raw.githubusercontent.com/pkgforge-dev/Anylinux-AppImages/refs/heads/main/useful-tools/quick-sharun.sh" + +export DESKTOP=/usr/share/applications/org.citron_emu.citron.desktop +export ICON=/usr/share/icons/hicolor/scalable/apps/org.citron_emu.citron.svg +export DEPLOY_OPENGL=1 +export DEPLOY_VULKAN=1 +export DEPLOY_PIPEWIRE=1 + +wget --retry-connrefused --tries=30 "$SHARUN" -O ./quick-sharun +chmod +x ./quick-sharun + +./quick-sharun /usr/bin/citron* /usr/lib/libgamemode.so* /usr/lib/libpulse.so* + +echo "Copying Qt translation files..." + +mkdir -p ./AppDir/usr/share/qt6 + +cp -r /usr/share/qt6/translations ./AppDir/usr/share/qt6/ + +if [ "$DEVEL" = 'true' ]; then + sed -i 's|Name=citron|Name=citron nightly|' ./AppDir/*.desktop +fi + +echo 'SHARUN_ALLOW_SYS_VK_ICD=1' > ./AppDir/.env + + +echo "Creating tar.zst archive..." + +(cd AppDir && tar -c --zstd -f ../"$OUTNAME_TAR" usr) +echo "Successfully created $OUTNAME_TAR" + + +wget --retry-connrefused --tries=30 "$URUNTIME" -O ./uruntime2appimage +chmod +x ./uruntime2appimage + +./uruntime2appimage + +echo "Renaming versioned AppImage to the final suffixed name: ${OUTNAME_APPIMAGE}..." + +SOURCE_APPIMAGE="citron_nightly-${APP_VERSION}-${ARCH}.AppImage" + +mv -v "${SOURCE_APPIMAGE}" "${OUTNAME_APPIMAGE}" +mv -v "${SOURCE_APPIMAGE}.zsync" "${OUTNAME_APPIMAGE}.zsync" + +mkdir -p ./dist + +mv -v ./*.AppImage* ./dist +mv -v ./*.tar.zst ./dist