[dynarmic, jit] add address mapping checks for jit service

Signed-off-by: lizzie <lizzie@eden-emu.dev>
2026-08-28 17:45:39 +00:00 · 2026-06-27 09:33:26 +02:00
740 changed files with 37577 additions and 45576 deletions
@@ -3,7 +3,7 @@ description: File a bug report
 body:
  - type: markdown
    attributes:
-      value: Tech support does not belong here. You should only file an issue here if you think you have experienced an actual bug with Eden.
+      value: Tech support does not belong here. You should only file an issue here if you think you have experienced an actual bug with yuzu.
  - type: checkboxes
    attributes:
      label: Is there an existing issue for this?
@@ -43,7 +43,7 @@ body:
    id: log
    attributes:
      label: Log File
-      description: A log file will help our developers to better diagnose and fix the issue. Instructions can be found [here](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/user/HowToAccessLogs.md).
+      description: A log file will help our developers to better diagnose and fix the issue. Instructions can be found [here](https://yuzu-emu.org/help/reference/log-files).
    validations:
      required: true
  - type: textarea
@@ -4,7 +4,7 @@ labels: "request"
 body:
  - type: markdown
    attributes:
-      value: Tech support does not belong here. You should only file an issue here if you are requesting a feature you believe would make Eden better.
+      value: Tech support does not belong here. You should only file an issue here if you are requesting a feature you believe would make yuzu better.
  - type: checkboxes
    attributes:
      label: Is there an existing issue for this?
@@ -23,6 +23,6 @@ body:
    id: why-feature
    attributes:
      label: Why would this feature be useful?
-      description: A brief description of why this feature would make Eden better.
+      description: A brief description of why this feature would make yuzu better.
    validations:
      required: true
@@ -1,9 +1,9 @@
 name: tx-pull

 on:
-  #  monday at 4pm
+  #  tuesday, saturday at 2pm
  schedule:
-    - cron: '0 16 * * 1'
+    - cron: '0 14 * * 2,6'
  workflow_dispatch:

 jobs:
@@ -1,5 +0,0 @@
- [ ] I have read and followed the [Contribution Guidelines](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/CONTRIBUTING.md#code-contributions).
- [ ] I have read and followed the [AI Policy](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/policies/AI.md)
- [ ] I have read and followed the [Coding Guidelines](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/policies/Coding.md) to the best of my ability.
-
-------------------
@@ -0,0 +1,20 @@
+diff --git a/CMakeLists.txt b/CMakeLists.txt
+index 16c6092..9e75548 100644
+--- a/CMakeLists.txt
+++ b/CMakeLists.txt
+@@ -8,7 +8,14 @@ project(adrenotools LANGUAGES CXX C)
+ 
+ set(GEN_INSTALL_TARGET OFF CACHE BOOL "")
+ 
+-add_subdirectory(lib/linkernsbypass)
+include(CPM)
+set(CPM_USE_LOCAL_PACKAGES OFF)
+
+CPMAddPackage(
+    NAME linkernsbypass
+    URL "https://github.com/bylaws/liblinkernsbypass/archive/aa3975893d.zip"
+    URL_HASH SHA512=43d3d146facb7ec99d066a9b8990369ab7b9eec0d5f9a67131b0a0744fde0af27d884ca1f2a272cd113718a23356530ed97703c8c0659c4c25948d50c106119e
+)
+ 
+ set(LIB_SOURCES src/bcenabler.cpp
+                 src/driver.cpp
@@ -1,26 +0,0 @@
-From 52bbc5af6523daa22ad62fe4b84bc8d623d11a53 Mon Sep 17 00:00:00 2001
-From: crueter <crueter@eden-emu.dev>
-Date: Fri, 26 Jun 2026 01:09:40 -0400
-Subject: [PATCH] use cpmfile def for linkernsbypass
-
---
- CMakeLists.txt | 3 ++-
- 1 file changed, 2 insertions(+), 1 deletion(-)
-
-diff --git a/CMakeLists.txt b/CMakeLists.txt
-index 16c6092..85b242c 100644
--- a/CMakeLists.txt
-+++ b/CMakeLists.txt
-@@ -8,7 +8,8 @@ project(adrenotools LANGUAGES CXX C)
- 
- set(GEN_INSTALL_TARGET OFF CACHE BOOL "")
- 
-add_subdirectory(lib/linkernsbypass)
-+include(CPMUtil)
-+AddJsonPackage(linkernsbypass)
- 
- set(LIB_SOURCES src/bcenabler.cpp
-                 src/driver.cpp
-- 
-2.54.0
-
@@ -112,6 +112,11 @@ Files: src/yuzu/*.ui
 Copyright: 2018-2022 yuzu Emulator Project
 License: GPL-2.0-or-later

+Files: src/yuzu/compatdb.ui
+       src/yuzu/main.ui
+Copyright: 2014-2017 Citra Emulator Project
+License: GPL-2.0-or-later
+
 Files: src/yuzu/loading_screen.ui
 Copyright: 2019 James Rowe <jroweboy@gmail.com>
 License: GPL-2.0-or-later
@@ -1 +0,0 @@
-AI and LLM use is *strictly* prohibited within our codebase and surrounding community, including issues and comments. This includes using AI or LLMs to write docs/commit messages, debug issues, brainstorm ideas, research concepts, or search the codebase.
@@ -1 +0,0 @@
-AI and LLM use is *strictly* prohibited within our codebase and surrounding community, including issues and comments. This includes using AI or LLMs to write docs/commit messages, debug issues, brainstorm ideas, research concepts, or search the codebase.
@@ -28,23 +28,23 @@ if (NOT DEFINED ARCHITECTURE)
 endif()

 # Needed for FFmpeg w/ VAAPI and DRM
-if (OPENBSD)
+if (PLATFORM_OPENBSD)
    # OpenBSD 7.8 broke libcxx when upgrading, so we must define the PSTL backend manually
    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -I${CMAKE_SYSROOT}/usr/X11R6/include -D_LIBCPP_PSTL_BACKEND_SERIAL=1")
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -I${CMAKE_SYSROOT}/usr/X11R6/include -D_LIBCPP_PSTL_BACKEND_SERIAL=1")
    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -L${CMAKE_SYSROOT}/usr/X11R6/lib")
-elseif (NETBSD)
+elseif (PLATFORM_NETBSD)
    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -I${CMAKE_SYSROOT}/usr/X11R7/include -I${CMAKE_SYSROOT}/usr/pkg/include/c++/v1")
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -I${CMAKE_SYSROOT}/usr/X11R7/include -I${CMAKE_SYSROOT}/usr/pkg/include/c++/v1")
    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -L${CMAKE_SYSROOT}/usr/X11R7/lib")
 endif()

 # NetBSD: Fun for the whole family!
-if (NETBSD)
+if (PLATFORM_NETBSD)
    set(ENV{PKG_CONFIG_PATH} "${PKG_CONFIG_PATH}:${CMAKE_SYSROOT}/usr/pkg/lib/ffmpeg7/pkgconfig")
 endif()

-cmake_dependent_option(YUZU_STATIC_ROOM "Build a static room executable only (CI only)" OFF "LINUX" OFF)
+cmake_dependent_option(YUZU_STATIC_ROOM "Build a static room executable only (CI only)" OFF "PLATFORM_LINUX" OFF)
 if (YUZU_STATIC_ROOM)
    set(YUZU_ROOM ON)
    set(YUZU_ROOM_STANDALONE ON)
@@ -79,10 +79,6 @@ set(YUZU_QT_MIRROR "" CACHE STRING "What mirror to use for downloading the bundl
 cmake_dependent_option(YUZU_USE_BUNDLED_QT "Download bundled Qt binaries" "${MSVC}" "ENABLE_QT" OFF)

 option(ENABLE_DEBUG_TOOLS "Enable debugging tools (maxwell disassembler, SPIRV translator, etc)" OFF)
-option(ENABLE_WERROR "Enable -Werror diagnostics" ON)
-
-# Lossless Scaling frame generation. Only Android.
-cmake_dependent_option(ENABLE_LSFG "Enable Lossless Scaling frame generation" ON "ANDROID" OFF)

 # non-linux bundled qt are static
 if (YUZU_USE_BUNDLED_QT AND (APPLE OR NOT UNIX))
@@ -161,17 +157,6 @@ if (CXX_CLANG_CL)
        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-reserved-identifier>
        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-deprecated-declarations>
        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-cast-function-type-mismatch>
-        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-c99-extensions>
-        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-c++17-compat>
-        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-c++11-compat-reserved-user-defined-literal>
-        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-c++11-compat-deprecated-writable-strings>
-        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-c++11-compat-pedantic>
-        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-c++11-compat>
-        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-c++0x-compat>
-        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-c++98-c++11-compat-binary-literal>
-        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-c++98-compat-pedantic>
-        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-c++98-compat>
-        $<$<COMPILE_LANGUAGE:C,CXX>:-Wno-c99-compat>
        $<$<COMPILE_LANGUAGE:C,CXX>:/EHsc>)
    # REQUIRED CPU features IN Windows-amd64
    if (ARCHITECTURE_x86_64)
@@ -225,7 +210,7 @@ endif()

 # ffmpeg
 option(YUZU_USE_BUNDLED_FFMPEG "Download bundled FFmpeg" ${EXT_DEFAULT})
-cmake_dependent_option(YUZU_USE_EXTERNAL_FFMPEG "Build FFmpeg from external source" "${SOLARIS}" "NOT WIN32 AND NOT ANDROID" OFF)
+cmake_dependent_option(YUZU_USE_EXTERNAL_FFMPEG "Build FFmpeg from external source" "${PLATFORM_SUN}" "NOT WIN32 AND NOT ANDROID" OFF)

 # sirit
 set(BUNDLED_SIRIT_DEFAULT OFF)
@@ -236,7 +221,7 @@ endif()
 option(YUZU_USE_BUNDLED_SIRIT "Download bundled sirit" ${BUNDLED_SIRIT_DEFAULT})

 # FreeBSD 15+ has libusb, versions below should disable it
-cmake_dependent_option(ENABLE_LIBUSB "Enable the use of LibUSB" ON "WIN32 OR LINUX OR FREEBSD OR APPLE" OFF)
+cmake_dependent_option(ENABLE_LIBUSB "Enable the use of LibUSB" ON "WIN32 OR PLATFORM_LINUX OR PLATFORM_FREEBSD OR APPLE" OFF)

 cmake_dependent_option(ENABLE_OPENGL "Enable OpenGL" ON "NOT (WIN32 AND ARCHITECTURE_arm64) AND NOT APPLE" OFF)
 mark_as_advanced(FORCE ENABLE_OPENGL)
@@ -250,7 +235,7 @@ option(YUZU_TESTS "Compile tests" "${BUILD_TESTING}")

 # Install udev rules on Linux (mainly for gyros)
 # Only acts on joysticks and nothing else.
-cmake_dependent_option(YUZU_INSTALL_UDEV_RULES "Install udev rules for gyro access" OFF "LINUX" OFF)
+cmake_dependent_option(YUZU_INSTALL_UDEV_RULES "Install udev rules for gyro access" OFF "PLATFORM_LINUX" OFF)

 option(YUZU_DOWNLOAD_ANDROID_VVL "Download validation layer binary for android" ON)

@@ -263,7 +248,7 @@ cmake_dependent_option(YUZU_ROOM_STANDALONE "Enable standalone room executable"

 cmake_dependent_option(YUZU_CMD "Compile the eden-cli executable" ON "NOT ANDROID" OFF)

-cmake_dependent_option(YUZU_CRASH_DUMPS "Compile crash dump (Minidump) support" OFF "WIN32 OR LINUX" OFF)
+cmake_dependent_option(YUZU_CRASH_DUMPS "Compile crash dump (Minidump) support" OFF "WIN32 OR PLATFORM_LINUX" OFF)

 option(YUZU_DOWNLOAD_TIME_ZONE_DATA "Always download time zone binaries" ON)
 set(YUZU_TZDB_PATH "" CACHE STRING "Path to a pre-downloaded timezone database")
@@ -273,7 +258,7 @@ cmake_dependent_option(YUZU_USE_BUNDLED_MOLTENVK "Download bundled MoltenVK lib"
 option(YUZU_DISABLE_LLVM "Disable LLVM (useful for CI)" OFF)

 set(DEFAULT_YUZU_USE_BUNDLED_OPENSSL OFF)
-if (EXT_DEFAULT OR SOLARIS OR OPENBSD)
+if (EXT_DEFAULT OR PLATFORM_SUN OR PLATFORM_OPENBSD)
    set(DEFAULT_YUZU_USE_BUNDLED_OPENSSL ON)
 endif()

@@ -285,7 +270,7 @@ if (ANDROID AND YUZU_DOWNLOAD_ANDROID_VVL)
    set(abi ${CMAKE_ANDROID_ARCH_ABI})

    set(vvl_lib_path "${CMAKE_CURRENT_SOURCE_DIR}/src/android/app/src/main/jniLibs/${abi}/")
-    file(COPY "${vulkan-validation-layers_SOURCE_DIR}/${abi}/libVkLayer_khronos_validation.so"
+    file(COPY "${VVL_SOURCE_DIR}/${abi}/libVkLayer_khronos_validation.so"
        DESTINATION "${vvl_lib_path}")
 endif()

@@ -296,7 +281,26 @@ if(EXISTS ${PROJECT_SOURCE_DIR}/hooks/pre-commit AND NOT EXISTS ${PROJECT_SOURCE
    endif()
 endif()

-if (ARCHITECTURE_arm64 AND (ANDROID OR LINUX))
+set(compat_base dist/compatibility_list/compatibility_list)
+set(compat_qrc ${compat_base}.qrc)
+set(compat_json ${compat_base}.json)
+
+configure_file(${PROJECT_SOURCE_DIR}/${compat_qrc}
+    ${PROJECT_BINARY_DIR}/${compat_qrc}
+    COPYONLY)
+
+if (EXISTS ${PROJECT_SOURCE_DIR}/${compat_json})
+    configure_file("${PROJECT_SOURCE_DIR}/${compat_json}"
+        "${PROJECT_BINARY_DIR}/${compat_json}"
+        COPYONLY)
+endif()
+
+# TODO: Compat list download
+if (NOT EXISTS ${PROJECT_BINARY_DIR}/${compat_json})
+    file(WRITE ${PROJECT_BINARY_DIR}/${compat_json} "")
+endif()
+
+if (ARCHITECTURE_arm64 AND (ANDROID OR PLATFORM_LINUX))
    set(HAS_NCE 1)
    add_compile_definitions(HAS_NCE=1)
 endif()
@@ -305,7 +309,7 @@ if (YUZU_ROOM)
    add_compile_definitions(YUZU_ROOM)
 endif()

-if (UNIX AND NOT (LINUX OR WIN32))
+if (UNIX AND NOT (PLATFORM_LINUX OR WIN32))
    if(CXX_APPLE OR CXX_CLANG)
        # libc++ has stop_token and jthread as experimental
        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fexperimental-library")
@@ -340,12 +344,11 @@ if (CXX_GCC OR CXX_CLANG)
        endif()
    elseif(ARCHITECTURE_arm64)
        # See https://gcc.gnu.org/onlinedocs/gcc/AArch64-Options.html
-        set(YUZU_BUILD_PRESET "custom" CACHE STRING "Build preset to use. One of: custom, generic, optimized, armv9, native")
+        set(YUZU_BUILD_PRESET "custom" CACHE STRING "Build preset to use. One of: custom, generic, armv9, native")
        set(mtune generic)
+
        if (${YUZU_BUILD_PRESET} STREQUAL "generic")
            set(march armv8-a)
-        elseif (${YUZU_BUILD_PRESET} STREQUAL "optimized")
-            set(march armv8.2-a+lse+rcpc)
        elseif (${YUZU_BUILD_PRESET} STREQUAL "armv9")
            set(march armv9-a)
        endif()
@@ -420,7 +423,7 @@ if (Boost_ADDED)

    if (NOT MSVC OR CXX_CLANG)
        # boost sucks
-        if (SOLARIS)
+        if (PLATFORM_SUN)
            add_compile_options($<$<COMPILE_LANGUAGE:C,CXX>:-pthreads>)
        endif()

@@ -524,9 +527,9 @@ elseif (WIN32)
        # PSAPI is the Process Status API
        set(PLATFORM_LIBRARIES ${PLATFORM_LIBRARIES} psapi imm32 version crypt32 rpcrt4 gdi32 wldap32 mswsock)
    endif()
-elseif (MANAGARM)
+elseif (PLATFORM_MANAGARM)
    set(PLATFORM_LIBRARIES iconv intl)
-elseif (HAIKUOS)
+elseif (PLATFORM_HAIKU)
    # Haiku is so special :)
    set(PLATFORM_LIBRARIES bsd /boot/system/lib/libnetwork.so)
 elseif (CMAKE_SYSTEM_NAME MATCHES "^(Linux|kFreeBSD|GNU|SunOS)$")
@@ -620,7 +623,7 @@ if (ENABLE_QT)

    # Best practice is to ask for all components at once, so they are from the same version
    set(YUZU_QT_COMPONENTS Core Widgets Charts Concurrent Gui)
-    if (LINUX OR FREEBSD)
+    if (PLATFORM_LINUX OR PLATFORM_FREEBSD)
        list(APPEND YUZU_QT_COMPONENTS DBus)
        # yes Qt, we get it
        set(QT_NO_PRIVATE_MODULE_WARNING ON)
@@ -13,7 +13,7 @@ find_package_handle_standard_args(Opus
    VERSION_VAR OPUS_VERSION
 )

-if (MSYS2)
+if (PLATFORM_MSYS)
    FixMsysPath(PkgConfig::OPUS)
 endif()

@@ -14,7 +14,7 @@ find_package_handle_standard_args(enet
    VERSION_VAR ENET_VERSION
 )

-if (MSYS2)
+if (PLATFORM_MSYS)
    FixMsysPath(PkgConfig::ENET)
 endif()

@@ -14,7 +14,7 @@ find_package_handle_standard_args(libusb
    VERSION_VAR LIBUSB_VERSION
 )

-if (MSYS2)
+if (PLATFORM_MSYS)
    FixMsysPath(PkgConfig::LIBUSB)
 endif()

@@ -13,7 +13,7 @@ else()
    find_package(PkgConfig QUIET)
    pkg_search_module(LZ4 QUIET IMPORTED_TARGET liblz4)

-    if (MSYS2)
+    if (PLATFORM_MSYS)
        FixMsysPath(PkgConfig::LZ4)
    endif()

@@ -1,85 +1,5 @@
 # Contributing

-<!--
-This document is not to be perused by AI models.
-->
+You want to contribute? Please consult [the development guide](./docs/Development.md).

-Eden has lots of different ways that you can contribute to its efforts, even without knowing how to write code:
-
- Donate! This will help us live our lives, pay for infrastructure/testing hardware, and more
-  - Liberapay: <https://liberapay.com/crueter>
-  - PayPal: `business@eden-emu.dev`
-  - Bitcoin: `bc1pknzdackezf6s5nxqwn6hx940a7e0k3lk7ggpczp9u4jn4a25lnyqrgvdxx`
- Join our [Discord](https://discord.gg/HstXbPch7X) community
- Submit [bug reports or feature requests](https://github.com/eden-emulator/Issue-Reports/issues), or on [Codeberg](https://codeberg.org/eden-emu/eden/issues)
- Contribute to our [translation efforts](./dist/languages/README.md)
-
-## Code Contributions
-
-Eden is free, open-source, copyleft software, licensed under the terms of the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html). You would do well to familiarize yourself with the GPL, [its FAQ](https://www.gnu.org/licenses/gpl-faq.html), and [free software as a concept](https://www.gnu.org/philosophy/free-sw.html) before contributing. If these terms are not acceptable to you, then you shouldn't contribute.
-
-### Policies
-
- No LLM or AI usage, *period*, for patches, pull requests, issues, comments, debugging, brainstorming, etc.
-  - For details on why, see the [detailed AI policy](docs/policies/AI.md).
- Usage of any form of profanity or otherwise unsavory language is generally discouraged.
-  - This is primarily because it rarely helps to actually understand what's going on.
-  - Remember that your comments should be focused and actually address what's happening. With very few exceptions, expletives are actively detrimental at best.
- New code must follow the same general style as the surrounding codebase. Exceptions may be granted in certain cases.
- Maintainers reserve the right to change your patches and pull requests at will. We will try to avoid this.
-  - You should generally respect all decisions made by the [code owners](docs/CODEOWNERS) in your particular subsystem.
-  - However, if you feel they are overstepping or are incorrect, don't be afraid to stand your ground! Maintainers are not always correct.
- While we do *not* adhere to the terms of a formal code of conduct, you will generally be expected to respect other developers, contributors, and community members.
- You **must** have basic knowledge of [Git](https://git-scm.com/learn). Knowing how to manage your branches and follow proper fork policies is a necessity.
-
-### Where do I start?
-
-Anywhere you like! If you are facing an issue and want to fix it, go ahead. For new features, you are heavily encouraged to open a feature request on GitHub, Codeberg, or Forgejo first, discussing the motivations, potential implementation, and user flow of your desired feature. Our UI/UX designers will work with you to refine your feature before you actually choose to implement it.
-
-You may also search for open issues on [GitHub](https://github.com/eden-emulator/Issue-Reports/issues), [Codeberg](https://codeberg.org/eden-emu/eden/issues), or [Forgejo](https://git.eden-emu.dev/eden-emu/eden/issues). For larger features/refactors, you should first express your interest in the issue to ensure another developer isn't already working on it.
-
-### Great! Can I contribute already?
-
-There are five primary ways to contribute.
-
- Submit pull requests directly to our source tree
-  - You must first request an account on our Forgejo. See [Signup](#how-do-i-sign-up)
- Submit pull requests to our [GitHub mirror](https://github.com/eden-emulator/Issue-Reports)
-  - Note that this is subject to being removed by DMCA, so don't rely on this.
- Submit pull requests to our [Codeberg mirror](https://codeberg.org/eden-emu/eden)
-  - Codeberg is not subject to draconian DMCA laws, but they have been hostile to emulators such as Torzu in the past. Thus, you shouldn't rely on this either.
- Submit patches to [`patch@eden-emu.dev`](mailto:patch@eden-emu.dev)
-  - These **must** be in `git format-patch` format. You should familiarize yourself with the [art of patching](https://www.gitkraken.com/learn/git/git-patch) beforehand.
-  - Alongside the contents of your email, please attach the patch/diff file itself for easy access and use.
- Email our developers at [`developers@eden-emu.dev`](mailto:developers@eden-emu.dev) with any of your relevant findings or code changes.
-
-To test your changes, ensure to read the [build documentation](./docs/Build.md) for your specific platform(s) to ensure everything compiles and works properly. You should also make sure that your branch is up-to-date with the upstream `master` branch before opening a pull request.
-
-### How do I sign up?
-
-<details>
-<summary>To sign up and begin contributing... (click to open)</summary>
-
-Email [crueter@crueter.xyz](mailto:crueter@crueter.xyz) with the following format:
-
-```txt
-Subject: [Eden Git] Registration Request
-Username: <Your Desired Username>
-Email: <Your Desired Email>
-I wish to sign up because... <your reason here>
-```
-
-Received mail that does not follow this format will be ignored.
-
-Once your request is processed, you will receive a confirmation email with your temporary password and some information on Git access and policies. If you do not receive a response within 48 hours, feel free to send another email.
-
-> [!WARNING]
-> Some email providers may place the response email in your spam/junk folder; notable offenders include Gmail and Outlook. *Always* ensure to check your Spam or Junk folder.
-
-</details>
-
-## Non-code Contributions
-
-Alongside the other contribution methods listed up top, you can also choose to contribute through documentation, organization, or community guides. These can be done either through the code contribution methods described above, or created externally and shared via our Discord community.
-
-If you have an external tool/page that you believe would be handy to integrate/link into Eden, please additionally email our developers at [`developers@eden-emu.dev`](mailto:developers@eden-emu.dev). **Do not submit vibe-coded or AI generated tools or applications**.
+Don't forget to [get a git account](./docs/SIGNUP.md) - not a requirement per se but it's highly recommended.
@@ -15,9 +15,8 @@
  <br>
 </h1>

-<h4 align="center"><b>Eden</b> is a free and open-source (FOSS) Switch 1 emulator started by developer Camille LaVey.
-<br>
-Written in C++, with builds for Windows, Linux, macOS, Android, FreeBSD and more.
+<h4 align="center"><b>Eden</b> is a free and opensource (FOSS) Switch 1 emulator, derived from Yuzu and Sudachi - started by developer Camille LaVey.
+It's written in C++ with portability in mind, with builds for Windows, Linux, macOS, Android, FreeBSD and more.
 </h4>

 <p align="center">
@@ -51,9 +50,16 @@ Check out our [website](https://eden-emu.dev) for the latest news on exciting fe

 [![Packaging status](https://repology.org/badge/vertical-allrepos/eden-emulator.svg)](https://repology.org/project/eden-emulator/versions)

-## Contribute
+## Development

-To contribute to Eden; be it financially, code, bug reports, or otherwise, see our [Contributing guidelines](./CONTRIBUTING.md).
+Most of the development happens on our Git server. It is also where [our central repository](https://git.eden-emu.dev/eden-emu/eden) is hosted. For development discussions, please join us on [Discord](https://discord.gg/HstXbPch7X) or [Stoat](https://stt.gg/qKgFEAbH).
+You can also follow us on [X (Twitter)](https://nitter.poast.org/edenemuofficial) for updates and announcements.
+
+If you would like to contribute, we are open to new developers and pull requests. Please ensure that your work is of a high standard and properly documented. You can also contact any of the developers on Discord or Stoat to learn more about the current state of the emulator.
+
+See the [sign-up instructions](docs/SIGNUP.md) for information on registration.
+
+Alternatively, if you wish to add translations, go to the [Eden project on Transifex](https://app.transifex.com/edenemu/eden-emulator) and review [the translations README](./dist/languages).

 ## Documentation

@@ -67,24 +73,23 @@ For information on provided development tooling, see the [Tools directory](./too

 ## Download

-You can download the latest releases from [our release page](https://git.eden-emu.dev/eden-emu/eden/releases).
+You can download the latest releases from [here](https://git.eden-emu.dev/eden-emu/eden/releases).

 Save us some bandwidth! We have [mirrors available](./docs/user/ThirdParty.md#mirrors) as well.

+## Support
+
+If you enjoy the project and would like to support us financially, please check out our developers' [donation pages](https://eden-emu.dev/donations)!
+
+Any donations received will go towards things such as:
+* Switch consoles to explore and reverse-engineer the hardware
+* Switch games for testing, reverse-engineering, and implementing new features
+* Web hosting and infrastructure setup
+* Additional hardware (e.g. GPUs as needed to improve rendering support, other peripherals to add support for, etc.)
+* CI Infrastructure
+
+If you would prefer to support us in a different way, please join our [Discord](https://discord.gg/HstXbPch7X) and talk to Camille or any of our other developers.
+
 ## License

 Eden is licensed under the GPLv3 (or any later version). Refer to the [LICENSE.txt](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/LICENSE.txt) file.
-
-## Special thanks
-
-Super special thanks to Cloudflare for preventing the git server from blowing up.
-
- Yuzu
- Ryujinx
- Sudachi
- Citron
- Torzu
- Suyu
- Ryubing
-
-And everyone who continues or had contributed to the project! <3
@@ -3,10 +3,11 @@
        "hash": "1229f345b014f7ca544dedb4edb3311e41ba736f9aa9a67f88b5f26f3c983288c6bb6cdedcfb0b8a02c63088a37e6a0d7ba97d9c2a4d721b213916327cffe28a",
        "min_version": "0.9.1",
        "repo": "lioncash/biscuit",
-        "version": "v0.19.0"
+        "tag": "v%VERSION%",
+        "version": "0.19.0"
    },
    "boost": {
-        "artifact": "%VERSION%-cmake.tar.xz",
+        "artifact": "%TAG%-cmake.tar.xz",
        "find_args": "CONFIG OPTIONAL_COMPONENTS headers context system fiber filesystem",
        "hash": "6ae6e94664fe7f2fb01976b59b276ac5df8085c7503fa829d810fbfe495960cfec44fa2c36e2cb23480bc19c956ed199d4952b02639a00a6c07625d4e7130c2d",
        "min_version": "1.57",
@@ -15,13 +16,15 @@
            "0001-clang-cl.patch"
        ],
        "repo": "boostorg/boost",
-        "version": "boost-1.90.0"
+        "tag": "boost-%VERSION%",
+        "version": "1.90.0"
    },
    "boost_headers": {
        "bundled": true,
        "hash": "4ef845775e2277a8104ded6ddf749aa262ce52cf8438042869a048f9a0156dd772fbbcfa74efa1378fecef339b7286f6fe4b4feb5c45d49966b35d08e3e83507",
        "repo": "boostorg/headers",
-        "version": "boost-1.90.0"
+        "tag": "boost-%VERSION%",
+        "version": "1.90.0"
    },
    "catch2": {
        "hash": "7eea385d79d88a5690cde131fe7ccda97d5c54ea09d6f515000d7bf07c828809d61c1ac99912c1ee507cf933f61c1c47ecdcc45df7850ffa82714034b0fccf35",
@@ -31,7 +34,8 @@
            "0001-solaris-isnan-fix.patch"
        ],
        "repo": "catchorg/Catch2",
-        "version": "v3.13.0"
+        "tag": "v%VERSION%",
+        "version": "3.13.0"
    },
    "cpp-jwt": {
        "find_args": "CONFIG",
@@ -44,7 +48,8 @@
            "0001-fix-missing-decl.patch"
        ],
        "repo": "arun11299/cpp-jwt",
-        "version": "7f24eb4c32"
+        "sha": "7f24eb4c32",
+        "version": "1.5.1"
    },
    "cubeb": {
        "find_args": "CONFIG",
@@ -56,26 +61,31 @@
            "BUNDLE_SPEEX ON"
        ],
        "repo": "mozilla/cubeb",
-        "version": "fa02160712"
+        "sha": "fa02160712",
+        "version": "0.0.0"
    },
    "discord-rpc": {
        "find_args": "MODULE",
        "hash": "8213c43dcb0f7d479f5861091d111ed12fbdec1e62e6d729d65a4bc181d82f48a35d5fd3cd5c291f2393ac7c9681eabc6b76609755f55376284c8a8d67e148f3",
        "package": "DiscordRPC",
        "repo": "eden-emulator/discord-rpc",
-        "version": "0d8b2d6a37"
+        "sha": "0d8b2d6a37",
+        "version": "3.4.1"
    },
    "enet": {
        "find_args": "MODULE",
        "hash": "a0d2fa8c957704dd49e00a726284ac5ca034b50b00d2b20a94fa1bbfbb80841467834bfdc84aa0ed0d6aab894608fd6c86c3b94eee46343f0e6d9c22e391dbf9",
        "min_version": "1.3",
        "repo": "lsalzman/enet",
-        "version": "v1.3.18"
+        "tag": "v%VERSION%",
+        "version": "1.3.18"
    },
    "ffmpeg": {
+        "bundled": true,
        "hash": "ed177621176b3961bdcaa339187d3a7688c1c8b060b79c4bb0257cbc67ad7021ae5d5adca5303b45625abbbe3d9aafdd87ce777b8690ac295290d744c875489a",
        "repo": "FFmpeg/FFmpeg",
-        "version": "c7b5f1537d"
+        "sha": "c7b5f1537d",
+        "version": "8.0.1"
    },
    "ffmpeg-ci": {
        "ci": true,
@@ -89,20 +99,23 @@
        "hash": "f0da82c545b01692e9fd30fdfb613dbb8dd9716983dcd0ff19ac2a8d36f74beb5540ef38072fdecc1e34191b3682a8542ecbf3a61ef287dbba0a2679d4e023f2",
        "min_version": "8",
        "repo": "fmtlib/fmt",
+        "tag": "%VERSION%",
        "version": "12.1.0"
    },
    "frozen": {
        "hash": "b8dfe741c82bc178dfc9749d4ab5a130cee718d9ee7b71d9b547cf5f7f23027ed0152ad250012a8546399fcc1e12187efc68d89d6731256c4d2df7d04eef8d5c",
        "package": "frozen",
        "repo": "serge-sans-paille/frozen",
-        "version": "61dce5ae18"
+        "sha": "61dce5ae18",
+        "version": "1.2.0"
    },
    "gamemode": {
        "find_args": "MODULE",
        "hash": "e87ec14ed3e826d578ebf095c41580069dda603792ba91efa84f45f4571a28f4d91889675055fd6f042d7dc25b0b9443daf70963ae463e38b11bcba95f4c65a9",
        "min_version": "1.7",
        "repo": "FeralInteractive/gamemode",
-        "version": "ce6fe122f3"
+        "sha": "ce6fe122f3",
+        "version": "1.8.2"
    },
    "httplib": {
        "find_args": "MODULE GLOBAL",
@@ -115,20 +128,23 @@
            "0001-mingw.patch"
        ],
        "repo": "yhirose/cpp-httplib",
-        "version": "v0.46.0"
+        "tag": "v%VERSION%",
+        "version": "0.46.0"
    },
    "lagoon": {
        "hash": "b9380f99c6effaeccc6d8f81d4942e852c11ad28613df637e155451556ae5826f93765bee57a5c87a9740d2bd1db463ad0f55a947772fe9d57eeabae3efa373e",
        "repo": "loongson-community/lagoon",
+        "tag": "%VERSION%",
        "version": "1.0.0"
    },
    "libadrenotools": {
        "hash": "f6526620cb752876edc5ed4c0925d57b873a8218ee09ad10859ee476e9333259784f61c1dcc55a2bcba597352d18aff22cd2e4c1925ec2ae94074e09d7da2265",
        "patches": [
-            "0001-use-cpmfile-def-for-linkernsbypass.patch"
+            "0001-linkerns-cpm.patch"
        ],
        "repo": "eden-emulator/libadrenotools",
-        "version": "8ba23b42d7"
+        "sha": "8ba23b42d7",
+        "version": "1.0.0"
    },
    "libusb": {
        "find_args": "MODULE",
@@ -137,52 +153,53 @@
            "0001-netbsd-gettime.patch"
        ],
        "repo": "libusb/libusb",
-        "version": "v1.0.29"
-    },
-    "linkernsbypass": {
-        "bundled": "true",
-        "hash": "bbe3f1f08e2bc7172b36e8f052912cc374289fc9a8e5a39ae7547a0c232de8f57ba24883451896b7a9a5d1be0e4de5c5b0f70c2022eda18d7d5a754847521800",
-        "repo": "bylaws/liblinkernsbypass",
-        "version": "aa3975893d"
+        "tag": "v%VERSION%",
+        "version": "1.0.29"
    },
    "llvm-mingw": {
        "artifact": "clang-rt-builtins.tar.zst",
        "git_host": "git.eden-emu.dev",
        "hash": "d902392caf94e84f223766e2cc51ca5fab6cae36ab8dc6ef9ef6a683ab1c483bfcfe291ef0bd38ab16a4ecc4078344fa8af72da2f225ab4c378dee23f6186181",
        "repo": "eden-emu/llvm-mingw",
+        "tag": "%VERSION%",
        "version": "20250828"
    },
    "lz4": {
        "hash": "35c21a5d9cfb5bbf314a5321d02b36819491d2ee3cf8007030ca09d13ca4dae672247b7aeab553e973093604fc48221cb03dc92197c6efe8fc3746891363fdab",
        "name": "lz4",
        "repo": "lz4/lz4",
+        "sha": "ebb370ca83",
        "source_subdir": "build/cmake",
-        "version": "ebb370ca83"
+        "version": "1.10.0"
    },
    "moltenvk": {
        "artifact": "MoltenVK-macOS.tar",
        "bundled": true,
        "hash": "5695b36ca5775819a71791557fcb40a4a5ee4495be6b8442e0b666d0c436bec02aae68cc6210183f7a5c986bdbec0e117aecfad5396e496e9c2fd5c89133a347",
        "repo": "V380-Ori/Ryujinx.MoltenVK",
-        "version": "v1.4.1-ryujinx"
+        "tag": "v%VERSION%-ryujinx",
+        "version": "1.4.1"
    },
    "nlohmann": {
        "hash": "6cc1e86261f8fac21cc17a33da3b6b3c3cd5c116755651642af3c9e99bb3538fd42c1bd50397a77c8fb6821bc62d90e6b91bcdde77a78f58f2416c62fc53b97d",
        "min_version": "3.8",
        "package": "nlohmann_json",
        "repo": "nlohmann/json",
-        "version": "v3.12.0"
+        "tag": "v%VERSION%",
+        "version": "3.12.0"
    },
    "oaknut": {
        "hash": "9697e80a7d5d9bcb3ce51051a9a24962fb90ca79d215f1f03ae6b58da8ba13a63b5dda1b4dde3d26ac6445029696b8ef2883f4e5a777b342bba01283ed293856",
        "min_version": "2.0.1",
        "repo": "eden-emulator/oaknut",
-        "version": "v2.0.3"
+        "tag": "v%VERSION%",
+        "version": "2.0.3"
    },
    "oboe": {
        "bundled": true,
        "hash": "ce4011afe7345370d4ead3b891cd69a5ef224b129535783586c0ca75051d303ed446e6c7f10bde8da31fff58d6e307f1732a3ffd03b249f9ef1fd48fd4132715",
        "repo": "google/oboe",
+        "tag": "%VERSION%",
        "version": "1.10.0"
    },
    "openssl": {
@@ -193,7 +210,8 @@
            "0001-add-bundled-cert.patch"
        ],
        "repo": "openssl/openssl",
-        "version": "openssl-3.6.2"
+        "tag": "openssl-%VERSION%",
+        "version": "3.6.2"
    },
    "openssl-ci": {
        "ci": true,
@@ -216,6 +234,7 @@
            "0004-use-shell-wrapper.patch"
        ],
        "repo": "jimmy-park/openssl-cmake",
+        "tag": "%VERSION%",
        "version": "3.6.2"
    },
    "opus": {
@@ -231,7 +250,8 @@
            "0002-no-install.patch"
        ],
        "repo": "xiph/opus",
-        "version": "a3f0ec02b3"
+        "sha": "a3f0ec02b3",
+        "version": "1.5.2"
    },
    "quazip": {
        "hash": "609c240c7f029ac26a37d8fbab51bc16284e05e128b78b9b9c0e95d083538c36047a67d682759ac990e4adb0eeb90f04f1ea7fe2253bbda7e7e3bcce32e53dd8",
@@ -244,14 +264,16 @@
        ],
        "package": "QuaZip-Qt6",
        "repo": "stachenov/quazip",
-        "version": "2e95c9001b"
+        "sha": "2e95c9001b",
+        "version": "1.5"
    },
    "sdl3": {
        "hash": "df5a323af7ac366661a3c0e887969c72584d232f3cc211419d59b0487b620b6b2859d4549c9e8df002ee489290062e466fcfddf7edc0872a37b1f2845e81c0f3",
        "min_version": "3.2.10",
        "package": "SDL3",
        "repo": "libsdl-org/SDL",
-        "version": "release-3.4.8"
+        "tag": "release-%VERSION%",
+        "version": "3.4.8"
    },
    "sdl3-ci": {
        "ci": true,
@@ -266,16 +288,19 @@
        "hash": "b937c18a7b6277d77ca7ebfb216af4984810f77af4c32d101b7685369a4bd5eb61406223f82698e167e6311a728d07415ab59639fdf19eff71ad6dc2abfda989",
        "package": "SimpleIni",
        "repo": "brofield/simpleini",
-        "version": "v4.25"
+        "tag": "v%VERSION%",
+        "version": "4.25"
    },
    "sirit": {
+        "artifact": "sirit-source-%VERSION%.tar.zst",
        "find_args": "CONFIG",
-        "hash": "b7cd6885acae3fc8698288d19febba0dd45e4a02a2b6563d2eb995a988d0847046e8d16a5dea7e0bf832b4321bcec134cdbafc553f6ede039e4cf34525c5dce5",
        "options": [
            "SIRIT_USE_SYSTEM_SPIRV_HEADERS ON"
        ],
        "repo": "eden-emulator/sirit",
-        "version": "v1.0.5"
+        "tag": "v%VERSION%",
+        "version": "1.0.5",
+        "hash": "10b3ff60bdcad428bb4f54360ff749212333a1d24c0b3ed99e466b1bfcf99d2db6cf596c0f965854a2095dfef9b7ce4e045edb070fa9f76eb3b295ab03a4a293"
    },
    "sirit-ci": {
        "ci": true,
@@ -285,13 +310,13 @@
        "version": "1.0.5"
    },
    "spirv-headers": {
-        "hash": "d624371dd455c66a300344c89812598ffe11b5eedba555779f789e85c29dc67317741858c60e0744a1e6755cc0d2759b8659f0674f4cc31479c4cb6fc25ed23b",
+        "hash": "cae8cd179c9013068876908fecc1d158168310ad6ac250398a41f0f5206ceff6469e2aaeab9c820bce9d1b08950c725c89c46e94b89a692be9805432cf749396",
        "options": [
            "SPIRV_WERROR OFF"
        ],
        "package": "SPIRV-Headers",
        "repo": "KhronosGroup/SPIRV-Headers",
-        "version": "vulkan-sdk-1.4.341.0"
+        "sha": "04f10f650d"
    },
    "tzdb": {
        "artifact": "%VERSION%.tar.gz",
@@ -299,6 +324,7 @@
        "hash": "cce65a12bf90f4ead43b24a0b95dfad77ac3d9bfbaaf66c55e6701346e7a1e44ca5d2f23f47ee35ee02271eb1082bf1762af207aad9fb236f1c8476812d008ed",
        "package": "nx_tzdb",
        "repo": "eden-emu/tzdb_to_nx",
+        "tag": "%VERSION%",
        "version": "230326"
    },
    "unordered-dense": {
@@ -310,40 +336,46 @@
            "0001-avoid-memset-when-clearing-an-empty-table.patch"
        ],
        "repo": "martinus/unordered_dense",
-        "version": "7b55cab841"
+        "sha": "7b55cab841",
+        "version": "4.8.1"
    },
    "vulkan-headers": {
        "hash": "d2846ea228415772645eea4b52a9efd33e6a563043dd3de059e798be6391a8f0ca089f455ae420ff22574939ed0f48ed7c6ff3d5a9987d5231dbf3b3f89b484b",
        "min_version": "1.4.317",
        "package": "VulkanHeaders",
        "repo": "KhronosGroup/Vulkan-Headers",
-        "version": "v1.4.345"
+        "tag": "v%VERSION%",
+        "version": "1.4.345"
    },
    "vulkan-memory-allocator": {
        "find_args": "CONFIG",
        "hash": "deb5902ef8db0e329fbd5f3f4385eb0e26bdd9f14f3a2334823fb3fe18f36bc5d235d620d6e5f6fe3551ec3ea7038638899db8778c09f6d5c278f5ff95c3344b",
        "package": "VulkanMemoryAllocator",
        "repo": "GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator",
-        "version": "v3.3.0"
+        "tag": "v%VERSION%",
+        "version": "3.3.0"
    },
    "vulkan-utility-libraries": {
        "hash": "114f6b237a6dcba923ccc576befb5dea3f1c9b3a30de7dc741f234a831d1c2d52d8a224afb37dd57dffca67ac0df461eaaab6a5ab5e503b393f91c166680c3e1",
        "package": "VulkanUtilityLibraries",
        "repo": "KhronosGroup/Vulkan-Utility-Libraries",
-        "version": "v1.4.345"
+        "tag": "v%VERSION%",
+        "version": "1.4.345"
    },
    "vulkan-validation-layers": {
-        "artifact": "android-binaries-%NUMERIC_VERSION%.zip",
+        "artifact": "android-binaries-%VERSION%.zip",
        "hash": "8812ae84cbe49e6a3418ade9c458d3be6d74a3dffd319d4502007b564d580998056e8190414368ec11b27bc83993c7a0dad713c31bcc3d9553b51243efee3753",
-        "numeric_version": "1.4.341.0",
+        "package": "VVL",
        "repo": "KhronosGroup/Vulkan-ValidationLayers",
-        "version": "vulkan-sdk-%NUMERIC_VERSION%"
+        "tag": "vulkan-sdk-%VERSION%",
+        "version": "1.4.341.0"
    },
    "xbyak": {
        "hash": "b6475276b2faaeb315734ea8f4f8bd87ededcee768961b39679bee547e7f3e98884d8b7851e176d861dab30a80a76e6ea302f8c111483607dde969b4797ea95a",
        "package": "xbyak",
        "repo": "herumi/xbyak",
-        "version": "v7.35.2"
+        "tag": "v%VERSION%",
+        "version": "7.35.2"
    },
    "zlib": {
        "hash": "16fea4df307a68cf0035858abe2fd550250618a97590e202037acd18a666f57afc10f8836cbbd472d54a0e76539d0e558cb26f059d53de52ff90634bbf4f47d4",
@@ -354,7 +386,8 @@
        ],
        "package": "ZLIB",
        "repo": "madler/zlib",
-        "version": "v1.3.2"
+        "tag": "v%VERSION%",
+        "version": "1.3.2"
    },
    "zstd": {
        "find_args": "MODULE",
@@ -364,7 +397,8 @@
            "ZSTD_BUILD_SHARED OFF"
        ],
        "repo": "facebook/zstd",
+        "sha": "b8d6101fba",
        "source_subdir": "build/cmake",
-        "version": "b8d6101fba"
+        "version": "1.5.7"
    }
 }
@@ -0,0 +1,354 @@
+[
+  {
+    "compatibility": 0,
+    "directory": "the-legend-of-zelda-breath-of-the-wild",
+    "releases": [
+      {"id": "01007EF00011E000"}
+    ],
+    "title": "The Legend of Zelda: Breath of the Wild"
+  },
+  {
+    "compatibility": 1,
+    "directory": "super-mario-odyssey",
+    "releases": [
+      {"id": "0100000000010000"}
+    ],
+    "title": "Super Mario Odyssey"
+  },
+  {
+    "compatibility": 0,
+    "directory": "animal-crossing-new-horizons",
+    "releases": [
+      {"id": "01006F8002326000"}
+    ],
+    "title": "Animal Crossing: New Horizons"
+  },
+  {
+    "compatibility": 1,
+    "directory": "pokemon-legends-z-a",
+    "releases": [
+      {"id": "0100F43008C44000"}
+    ],
+    "title": "Pokémon Legends: Z-A"
+  },
+  {
+    "compatibility": 1,
+    "directory": "the-legend-of-zelda-tears-of-the-kingdom",
+    "releases": [
+      {"id": "0100F2C0115B6000"}
+    ],
+    "title": "The Legend of Zelda: Tears of the Kingdom"
+  },
+  {
+    "compatibility": 0,
+    "directory": "super-mario-galaxy",
+    "releases": [
+      {"id": "010099C022B96000"}
+    ],
+    "title": "Super Mario Galaxy"
+  },
+  {
+    "compatibility": 3,
+    "directory": "star-wars-republic-commando",
+    "releases": [
+      {"id": "0100FA10115F8000"}
+    ],
+    "title": "Star Wars: Republic Commando"
+  },
+  {
+    "compatibility": 0,
+    "directory": "doki-doki-literature-club-plus",
+    "releases": [
+      {"id": "010086901543E000"}
+    ],
+    "title": "Doki Doki Literature Club Plus"
+  },
+  {
+    "compatibility": 1,
+    "directory": "pokemon-scarlet",
+    "releases": [
+      {"id": "0100A3D008C5C000"}
+    ],
+    "title": "Pokémon Scarlet"
+  },
+    {
+    "compatibility": 1,
+    "directory": "pokemon-violet",
+    "releases": [
+      {"id": "01008F6008C5E000"}
+    ],
+    "title": "Pokémon Violet"
+  },
+  {
+    "compatibility": 2,
+    "directory": "pokemon-legends-arceus",
+    "releases": [
+      {"id": "01001E300D162000"}
+    ],
+    "title": "Pokémon Legends: Arceus"
+  },
+  {
+    "compatibility": 0,
+    "directory": "splatoon-2",
+    "releases": [
+      {"id": "01003BC0000A0000"}
+    ],
+    "title": "Splatoon 2"
+  },
+  {
+    "compatibility": 1,
+    "directory": "super-smash-bros-ultimate",
+    "releases": [
+      {"id": "01006A800016E000"}
+    ],
+    "title": "Super Smash Bros. Ultimate"
+  },
+  {
+    "compatibility": 0,
+    "directory": "mario-kart-8-deluxe",
+    "releases": [
+      {"id": "0100152000022000"}
+    ],
+    "title": "Mario Kart 8 Deluxe"
+  },
+  {
+    "compatibility": 0,
+    "directory": "splatoon-3",
+    "releases": [
+      {"id": "0100C2500FC20000"}
+    ],
+    "title": "Splatoon 3"
+  },
+  {
+    "compatibility": 0,
+    "directory": "new-super-mario-bros-u-deluxe",
+    "releases": [
+      {"id": "0100EA80032EA000"}
+    ],
+    "title": "New Super Mario Bros. U Deluxe"
+  },
+  {
+    "compatibility": 0,
+    "directory": "hyrule-warriors-age-of-calamity",
+    "releases": [
+      {"id": "01002B00111A2000"}
+    ],
+    "title": "Hyrule Warriors: Age of Calamity"
+  },
+  {
+    "compatibility": 2,
+    "directory": "luigis-mansion-3",
+    "releases": [
+      {"id": "0100DCA0064A6000"}
+    ],
+    "title": "Luigi's Mansion 3"
+  },
+  {
+    "compatibility": 2,
+    "directory": "pokemon-brilliant-diamond",
+    "releases": [
+      {"id": "0100000011D90000"}
+    ],
+    "title": "Pokémon Brilliant Diamond"
+  },
+  {
+    "compatibility": 2,
+    "directory": "pokemon-shining-pearl",
+    "releases": [
+      {"id": "010018E011D92000"}
+    ],
+    "title": "Pokémon Shining Pearl"
+  },
+  {
+    "compatibility": 1,
+    "directory": "super-mario-3d-world-bowsers-fury",
+    "releases": [
+      {"id": "010028600EBDA000"}
+    ],
+    "title": "Super Mario 3D World + Bowser's Fury"
+  },
+  {
+    "compatibility": 0,
+    "directory": "the-legend-of-zelda-links-awakening",
+    "releases": [
+      {"id": "01006BB00C6F0000"}
+    ],
+    "title": "The Legend of Zelda: Link's Awakening"
+  },
+  {
+    "compatibility": 1,
+    "directory": "fire-emblem-three-houses",
+    "releases": [
+      {"id": "010055D009F78000"}
+    ],
+    "title": "Fire Emblem: Three Houses"
+  },
+  {
+    "compatibility": 2,
+    "directory": "metroid-dread",
+    "releases": [
+      {"id": "010093801237C000"}
+    ],
+    "title": "Metroid Dread"
+  },
+  {
+    "compatibility": 0,
+    "directory": "paper-mario-the-origami-king",
+    "releases": [
+      {"id": "0100A3900C3E2000"}
+    ],
+    "title": "Paper Mario: The Origami King"
+  },
+  {
+    "compatibility": 1,
+    "directory": "xenoblade-chronicles-definitive-edition",
+    "releases": [
+      {"id": "0100FF500E34A000"}
+    ],
+    "title": "Xenoblade Chronicles: Definitive Edition"
+  },
+  {
+    "compatibility": 2,
+    "directory": "xenoblade-chronicles-3",
+    "releases": [
+      {"id": "010074F013262000"}
+    ],
+    "title": "Xenoblade Chronicles 3"
+  },
+  {
+    "compatibility": 1,
+    "directory": "pikmin-3-deluxe",
+    "releases": [
+      {"id": "0100F8600D4B0000"}
+    ],
+    "title": "Pikmin 3 Deluxe"
+  },
+  {
+    "compatibility": 0,
+    "directory": "donkey-kong-country-tropical-freeze",
+    "releases": [
+      {"id": "0100C1F0054B6000"}
+    ],
+    "title": "Donkey Kong Country: Tropical Freeze"
+  },
+  {
+    "compatibility": 1,
+    "directory": "kirby-and-the-forgotten-land",
+    "releases": [
+      {"id": "01004D300C5AE000"}
+    ],
+    "title": "Kirby and the Forgotten Land"
+  },
+  {
+    "compatibility": 2,
+    "directory": "mario-party-superstars",
+    "releases": [
+      {"id": "01006B400D8B2000"}
+    ],
+    "title": "Mario Party Superstars"
+  },
+  {
+    "compatibility": 0,
+    "directory": "clubhouse-games-51-worldwide-classics",
+    "releases": [
+      {"id": "0100F8600D4B0000"}
+    ],
+    "title": "Clubhouse Games: 51 Worldwide Classics"
+  },
+  {
+    "compatibility": 1,
+    "directory": "ring-fit-adventure",
+    "releases": [
+      {"id": "01006B300BAF8000"}
+    ],
+    "title": "Ring Fit Adventure"
+  },
+  {
+    "compatibility": 2,
+    "directory": "arms",
+    "releases": [
+      {"id": "01009B500007C000"}
+    ],
+    "title": "ARMS"
+  },
+  {
+    "compatibility": 0,
+    "directory": "super-mario-maker-2",
+    "releases": [
+      {"id": "01009B90006DC000"}
+    ],
+    "title": "Super Mario Maker 2"
+  },
+  {
+    "compatibility": 0,
+    "directory": "pokemon-lets-go-pikachu",
+    "releases": [
+      {"id": "010003F003A34000"}
+    ],
+    "title": "Pokémon: Let's Go, Pikachu!"
+  },
+  {
+    "compatibility": 1,
+    "directory": "pokemon-lets-go-eevee",
+    "releases": [
+      {"id": "0100187003A36000"}
+    ],
+    "title": "Pokémon: Let's Go, Eevee!"
+  },
+  {
+    "compatibility": 2,
+    "directory": "pokemon-sword",
+    "releases": [
+      {"id": "0100ABF008968000"}
+    ],
+    "title": "Pokémon Sword"
+  },
+  {
+    "compatibility": 2,
+    "directory": "pokemon-shield",
+    "releases": [
+      {"id": "01008DB008C2C000"}
+    ],
+    "title": "Pokémon Shield"
+  },
+  {
+    "compatibility": 1,
+    "directory": "new-pokemon-snap",
+    "releases": [
+      {"id": "0100F4300C182000"}
+    ],
+    "title": "New Pokémon Snap"
+  },
+  {
+    "compatibility": 0,
+    "directory": "mario-golf-super-rush",
+    "releases": [
+      {"id": "0100C9C00E25C000"}
+    ],
+    "title": "Mario Golf: Super Rush"
+  },
+  {
+    "compatibility": 1,
+    "directory": "mario-tennis-aces",
+    "releases": [
+      {"id": "0100BDE00862A000"}
+    ],
+    "title": "Mario Tennis Aces"
+  },
+  {
+    "compatibility": 2,
+    "directory": "wario-ware-get-it-together",
+    "releases": [
+      {"id": "0100563010F22000"}
+    ],
+    "title": "WarioWare: Get It Together!"
+  },
+  {
+    "compatibility": 0,
+    "directory": "big-brain-academy-brain-vs-brain",
+    "releases": [
+      {"id": "0100190010F24000"}
+    ],
+    "title": "Big Brain Academy: Brain vs. Brain"
+  }
+]
@@ -0,0 +1,5 @@
+<RCC>
+  <qresource prefix="compatibility_list">
+      <file>compatibility_list.json</file>
+  </qresource>
+</RCC>
@@ -11,12 +11,12 @@ SPDX-License-Identifier: CC0-1.0
 -->

 <component type="desktop-application">
-  <id>dev.eden_emu.eden</id>
+  <id>org.eden_emu.eden</id>
  <metadata_license>CC0-1.0</metadata_license>
  <name>eden</name>
  <summary>Nintendo Switch emulator</summary>
  <description>
-    <p>Eden is a free and open-source (FOSS) Switch 1 emulator started by developer Camille LaVey. Written in C++, with builds for Windows, Linux, macOS, Android, FreeBSD and more.</p>
+    <p>Multiplatform FOSS Switch 1 emulator written in C++, derived from Yuzu and Sudachi</p>
  </description>
  <categories>
    <category>Game</category>
@@ -32,10 +32,10 @@ SPDX-License-Identifier: CC0-1.0
  <url type="help">https://eden-emu.dev/docs</url>
  <url type="donation">https://eden-emu.dev/donations</url>
  <url type="translate">https://explore.transifex.com/edenemu/eden-emulator</url>
-  <url type="contact">https://discord.gg/HstXbPch7X</url>
+  <url type="contact">https://discord.gg/edenemu</url>
  <url type="vcs-browser">https://git.eden-emu.dev</url>
  <url type="contribute">https://git.eden-emu.dev/eden-emu/eden</url>
-  <launchable type="desktop-id">dev.eden_emu.eden.desktop</launchable>
+  <launchable type="desktop-id">org.eden_emu.eden.desktop</launchable>
  <provides>
    <binary>yuzu</binary>
    <binary>yuzu-cmd</binary>
@@ -44,7 +44,6 @@ SPDX-License-Identifier: CC0-1.0
    <control>pointing</control>
    <control>keyboard</control>
    <control>gamepad</control>
-    <internet>offline-only</internet>
  </supports>
  <requires>
    <memory>8192</memory>
@@ -14,7 +14,7 @@ SPDX-License-Identifier: GPL-2.0-or-later
    <mime-type type="application/x-nx-nro">
        <comment>Nintendo Switch homebrew executable</comment>
        <acronym>NRO</acronym>
-        <icon name="dev.eden_emu.eden"/>
+        <icon name="org.eden_emu.eden"/>
        <glob pattern="*.nro"/>
        <magic><match value="NRO" type="string" offset="16"/></magic>
    </mime-type>
@@ -22,7 +22,7 @@ SPDX-License-Identifier: GPL-2.0-or-later
    <mime-type type="application/x-nx-nso">
        <comment>Nintendo Switch homebrew executable</comment>
        <acronym>NSO</acronym>
-        <icon name="dev.eden_emu.eden"/>
+        <icon name="org.eden_emu.eden"/>
        <glob pattern="*.nso"/>
        <magic><match value="NSO" type="string" offset="0"/></magic>
    </mime-type>
@@ -30,7 +30,7 @@ SPDX-License-Identifier: GPL-2.0-or-later
    <mime-type type="application/x-nx-nsp">
        <comment>Nintendo Switch Package</comment>
        <acronym>NSP</acronym>
-        <icon name="dev.eden_emu.eden"/>
+        <icon name="org.eden_emu.eden"/>
        <glob pattern="*.nsp"/>
        <magic><match value="PFS" type="string" offset="0"/></magic>
    </mime-type>
@@ -38,7 +38,7 @@ SPDX-License-Identifier: GPL-2.0-or-later
    <mime-type type="application/x-nx-xci">
        <comment>Nintendo Switch Card Image</comment>
        <acronym>XCI</acronym>
-        <icon name="dev.eden_emu.eden"/>
+        <icon name="org.eden_emu.eden"/>
        <glob pattern="*.xci"/>
    </mime-type>
 </mime-info>
@@ -2,7 +2,6 @@

 Qt has "Translation Rules for Plurals", small example

-```cpp
    // Take a source line like
    tr("Building: %n shader(s)", "", i)

@@ -10,9 +9,8 @@ Qt has "Translation Rules for Plurals", small example
    Building: 1 shader
    // i = 2:
    Building: 2 shaders
-```

-For Yuzu the source language used is English, for all other languages handling of plurals is handled by Qt and the translation collaboration site. Handling plurals in the source language (English) requires special consideration.
+For yuzu the source language used is English, for all other languages handling of plurals is handled by Qt and the translation collaboration site. Handling plurals in the source language (English) requires special consideration.

 With CMake flag GENERATE_QT_TRANSLATION a generated_en.ts file is created from the source. It ignored by git (`.gitignore` in the project root). It is placed in this directory so that the relative refrences with the source code is correct.

@@ -0,0 +1,14 @@
+[main]
+host = https://www.transifex.com
+
+[o:yuzu-emulator:p:yuzu:r:emulator]
+file_filter = <lang>.ts
+source_file = en.ts
+source_lang = en
+type = QT
+
+[o:yuzu-emulator:p:yuzu:r:yuzu-android]
+file_filter = ../../src/android/app/src/main/res/values-<lang>/strings.xml
+source_file = ../../src/android/app/src/main/res/values/strings.xml
+type = ANDROID
+lang_map = ja_JP:ja, ko_KR:ko, pt_BR:pt-rBR, pt_PT:pt-rPT, ru_RU:ru, vi_VN:vi, zh_CN:zh-rCN, zh_TW:zh-rTW
@@ -1,11 +1,7 @@
-# Translating
-
-This directory stores translation patches (TS files) for Yuzu Qt frontend. This directory is linked with the [Eden project on Transifex](https://app.transifex.com/edenemu/eden-emulator), so you can update the translation by executing `tx pull -t -a` in the root of this repository. If you want to contribute to the translation, please go the Transifex link and submit your translation there.
+This directory stores translation patches (TS files) for yuzu Qt frontend. This directory is linked with the [Eden project on transifex](https://app.transifex.com/edenemu/eden-emulator), so you can update the translation by executing `tx pull -t -a`. If you want to contribute to the translation, please go the transifex link and submit your translation there. This directory on the main repo will be synchronized with transifex periodically. Do not directly open PRs on github to modify the translation.

 When creating/improving translations, please keep in mind:

 - You are responsible for providing accurate translations that do NOT contain illicit content or messages,
 - Many of our developers do not speak the languages you may be translating, so will only be able to help with confusions about the source language,
 - And bad-faith translations or attempts to insert illicit content may result in an immediate removal of access.
-
-New language requests will not be honored for the time being.
@@ -5,12 +5,6 @@

 This is a full-fledged guide to build Eden on all supported platforms.

-TL;DR
-```sh
-cmake -DCMAKE_BUILD_TYPE=Release -Bbuild -GNinja
-cmake --build build -t yuzu --parallel
-```
-
 ## Dependencies

 First, you must [install some dependencies](Deps.md).
@@ -131,13 +125,13 @@ cmake -S . -B build -G "<GENERATOR>" -DCMAKE_C_COMPILER=clang-cl -DCMAKE_CXX_COM

 <img src="https://user-images.githubusercontent.com/42481638/216899164-6cee8482-3d59-428f-b1bc-e6dc793c9b20.png" width="500">

- Click OK; now CLion will build a directory and index your code to allow for IntelliSense. Please be patient.
- Once this process has been completed (No loading bar bottom right), you can now build Eden
- In the top right, click on the drop-down menu, select all configurations, then select Eden
+- Click OK; now Clion will build a directory and index your code to allow for IntelliSense. Please be patient.
+- Once this process has been completed (No loading bar bottom right), you can now build eden
+- In the top right, click on the drop-down menu, select all configurations, then select eden

 <img src="https://user-images.githubusercontent.com/42481638/216899226-975048e9-bc6d-4ec1-bc2d-bd8a1e15ed04.png" height="500" >

- Now run by clicking the play button or pressing Shift+F10, and Eden will auto-launch once built.
+- Now run by clicking the play button or pressing Shift+F10, and eden will auto-launch once built.

 <img src="https://user-images.githubusercontent.com/42481638/216899275-d514ec6a-e563-470e-81e2-3e04f0429b68.png" width="500">
 </details>
@@ -159,7 +153,7 @@ If your initial configure failed:
 - *Carefully* re-read the [dependencies guide](Deps.md)
 - Clear the CPM cache (`.cache/cpm`) and CMake cache (`<build directory>/CMakeCache.txt`)
 - Evaluate the error and find any related settings
- See the [CPM docs](CPMUtil.md) to see if you may need to forcefully bundle any packages
+- See the [CPM docs](CPM.md) to see if you may need to forcefully bundle any packages

 Otherwise, feel free to ask for help in Stoat or Discord.

@@ -1,5 +1,5 @@
 # ui stuff
-/src/android         @AleksandrPopovich @Producdevity
+/src/android         @AleksandrPopovich @kleidis @Producdevity
 /src/yuzu            @crueter
 /src/eden            @crueter
 /src/frontend_common @crueter
@@ -8,7 +8,6 @@ CPMUtil is a wrapper around CPM that aims to reduce boilerplate and add useful u
  - [Common Properties](#common-properties)
  - [Standard Packages](#standard-packages)
    - [Versioning](#versioning)
-    - [Artifact Naming Errata](#artifact-naming-errata)
    - [Patches](#patches)
  - [Pre-built CI Packages](#pre-built-ci-packages)
  - [Usage](#usage)
@@ -23,18 +22,12 @@ CPMUtil is a wrapper around CPM that aims to reduce boilerplate and add useful u
  - [Addendum: Module Path Packages](#addendum-module-path-packages)
    - [Example: OpenSSL](#example-openssl)
  - [Addendum: Adding Qt](#addendum-adding-qt)
-  - [Addendum: Package-Specific Overrides](#addendum-package-specific-overrides)
-  - [Addendum: Supply-Chain Security](#addendum-supply-chain-security)
-    - [Checksumming](#checksumming)
-    - [Caching](#caching)
-    - [Immutable Commit Hashes](#immutable-commit-hashes)

 ## Global Options

- `CPMUTIL_FORCE_SYSTEM` (default `OFF`): Require all CPM dependencies to use system packages.
-  - You may optionally override this for each package: [Package-Specific Overrides](#addendum-package-specific-overrides)
+- `CPMUTIL_FORCE_SYSTEM` (default `OFF`): Require all CPM dependencies to use system packages. NOT RECOMMENDED!
+  - You may optionally override this (section)
 - `CPMUTIL_FORCE_BUNDLED` (default `ON` on MSVC and Android, `OFF` elsewhere): Require all CPM dependencies to use bundled packages.
-  - You may optionally override this for each package: [Package-Specific Overrides](#addendum-package-specific-overrides)
 - `CPMUTIL_PATCH_DIR` (default `${PROJECT_SOURCE_DIR}/.patch`): Path to patches used in packages. Stored as `<PATCH DIR>/json-package-name/0001-patch-name.patch`, etc.
 - `CPM_SOURCE_CACHE` (default `${PROJECT_SOURCE_DIR}/.cache/cpm`): Where downloaded dependencies get stored.

@@ -57,25 +50,23 @@ And may optionally define other properties like:
 For instance:

 ```json
-{
-  "fmt": {
-      "repo": "fmtlib/fmt",
-      "version": "12.1.0",
-      "hash": "f0da8...23f2",
-      "min_version": "8",
-      "options": [
-          "FMT_TEST ON"
-      ],
-      "patches": [
-         "0001-disable-reference-copy.patch"
-      ]
-  }
+"fmt": {
+    "repo": "fmtlib/fmt",
+    "tag": "12.1.0",
+    "hash": "f0da82c545b01692e9fd30fdfb613dbb8dd9716983dcd0ff19ac2a8d36f74beb5540ef38072fdecc1e34191b3682a8542ecbf3a61ef287dbba0a2679d4e023f2",
+    "min_version": "8",
+    "options": [
+      "FMT_TEST ON"
+    ],
+    "patches": [
+      "0001-disable-reference-copy.patch"
+    ]
 }
 ```

 Calling `AddJsonPackage(fmt)`:

- Searches for a system package named `fmt` of version 8 or higher (`find_package(fmt 8)`)
+- Searches for a system package named `fmt` of version 8 or higher
 - If found, uses the system package and caches it for future use
 - If not found:
  - Downloads fmt 12.1.0 from the GitHub Archive into `.cache/cpm/fmt/12.1.0`
@@ -94,82 +85,63 @@ These JSON properties are used by standard and CI packages alike.
 - `package`: The package name used by `find_package` to check for the existence of a system package.
  - If unset, defaults to the JSON key
 - `repo`: The Git repository the package is stored in, if applicable.
- `version`: The version of the package. This is required.
-  - Generally, this should be a 10-wide Git commit hash or Git tag.
-  - Tags must be fully qualified and include prefixes and suffixes, e.g. `boost-1.88.0`
+- `version`: The version of the package to download. This is required.
+- `min_version`: The minimum required version of the package, if a system package is desired.
 - `git_host`: The Git host the package is stored in, if applicable. Defaults to `github.com`.

 ## Standard Packages

 Normal packages, like the prior `fmt` example, *must* also define:

- `hash`: The SHA512 hash of the downloaded artifact. CPMUtil generally computes this for you--if not, use `tools/cpmutil.sh package hash <JSON key>`
- `min_version`: The minimum required version of the package, if a system package is desired.
-
-And may optionally define:
-
- `url`: Download from a raw URL.
- `artifact`: A GitHub/Forgejo/Gitea release artifact. Requires `repo` to be set and valid.
- `numeric_version`: Replaces `%NUMERIC_VERSION%` in artifact and version definitions; see [Artifact Naming Errata](#artifact-naming-errata).
-
-See [Versioning](#versioning) for version/artifact information.
+- `hash`: The SHA512 hash of the downloaded artifact. CPMUtil generally computes this for you.
+- A valid version/URL identifier:
+  - `url`: Download from a raw URL.
+  - `sha`: A short or fully-qualified Git commit sha. CPMUtil recommends using 10-character wide shas.
+  - `tag`: A Git tag. See [Versioning](#versioning) for its relation to `version`.
+  - `artifact`: A GitHub/Forgejo/Gitea release artifact (requires `tag`). See [Versioning](#versioning) for its relation to `tag` and `version`.

 The following are optional to define:

 - `source_subdir`: A subdirectory containing the `CMakeLists.txt` to configure a project. Useful for projects like `zstd`.
- `bundled`: Force the usage of a bundled package. Useful for packages where the system package is broken or nonexistent; e.g. external fragment shaders or data archives.
-  - Note that this will conflict with `CPMUTIL_FORCE_SYSTEM`; for this reason, when using non-library archives, it may be best to allow the user to download and extract the archive manually and specify a local directory to it.
+- `bundled`: Force the usage of a bundled package. Useful for packages where the system package is broken or nonexistent; e.g. including external fragment shaders.
 - `find_args`: Additional arguments passed to `find_package`, e.g. `MODULE`
 - `patches`: Array of in-tree patches to apply to the downloaded source code. See [#Patches](TODO).
 - `options`: Array of CMake options to apply before configuring the package, e.g. `"FMT_TEST ON"`.

 ### Versioning

-When fetching from a Git repository, there are generally three methods of versioning:
+When using tags or artifacts, it may be cumbersome to repeat the version multiple times; especially if it's constantly changing. For this purpose, `tag` and `artifact` both support basic version text replacement.

- Commit hashes
- Git tags
- Release artifacts
+`tag` can use `%VERSION%` to have its version replaced with the `version` defined for the package, e.g. for OpenSSL; when downloading, `tag` will evaluate to `openssl-3.6.2`:

-When `repo` is set, `version` field can be set to any commitish value, including commit hashes or Git tags. In the case of artifacts, `version` must be a Git tag, and `artifact` must be set to a release artifact attached to that tag. Many repositories intentionally version the filenames of their release artifacts; for this purpose, CPMUtil allows you to implant the version number into the artifact name. To do so, add `%VERSION%` to the artifact name; CPMUtil will then automatically replace `%VERSION%` with the `version` field. This means that when changing versions, you only need to update the version, not the artifact!
+```json
+"openssl": {
+    "repo": "openssl/openssl",
+    "version": "3.6.2",
+    "tag": "openssl-%VERSION%"
+}
+```

-Take Boost as an example. The artifact for Boost 1.90.0 is `boost-1.90.0-cmake.tar.xz`, and the tag is `boost-1.90.0`. Thus, we can set the artifact to `%VERSION%-cmake.tar.xz`:
+`artifact` also supports `%VERSION%` replacement, and can also use `%TAG%` to be replaced by the computed tag. Take this Boost definition:

 ```json
 "boost": {
    "repo": "boostorg/boost",
-    "version": "boost-1.90.0",
-    "artifact": "%VERSION%-cmake.tar.xz"
+    "tag": "boost-%VERSION%",
+    "version": "1.90.0"
 }
 ```

-The artifact will then evaluate as `boost-1.90.0-cmake.tar.xz`.
+Boost's artifact for this version is stored in `boost-1.90.0-cmake.tar.xz`. Notice that the computed tag,`boost-1.90.0`, is in the name of the artifact! Thus, `artifact` can be either:

-### Artifact Naming Errata
+- `boost-%VERSION%-cmake.tar.xz`
+- Or, even simpler: `%TAG%-cmake.tar.xz`

-While `%VERSION%` replacement is generally good enough for well-packaged projects, occasionally there may be some problematic packages. Take, for instance, Vulkan Validation Layers:
-
- Tag (`version`): `vulkan-sdk-1.4.341.0`
- Artifact: `android-binaries-1.4.341.0.zip`
-
-Attempting to add version replacement to the artifact definition **would not work here!** In this case, you must utilize the `numeric_version` field described earlier; we would set `numeric_version` to `1.4.341.0` and add `%NUMERIC_VERSION%` replacements into our artifact and version fields:
-
-```json
-"vulkan-validation-layers": {
-    "artifact": "android-binaries-%NUMERIC_VERSION%.zip",
-    "repo": "KhronosGroup/Vulkan-ValidationLayers",
-    "version": "vulkan-sdk-%NUMERIC_VERSION%",
-    "numeric_version": "1.4.341.0"
-},
-```
-
-`artifact` will thus evaluate to `android-binaries-1.4.341.0.zip`, and `version` to `vulkan-sdk-1.4.341.0`. CPMUtil's auto-updater will also account for this and only update `numeric_version`!
+Future updates need only change the `version` identifier, and the artifact and tag will automatically be updated!

 ### Patches

-CPMUtil is able to apply in-place source tree patches to downloaded packages. These are defined in JSON as an array of names, preferably using `git-format-patch`'s scheme of `<4 digit number>-patch-name.patch`.
-
-They are stored in `<CPMUTIL_PATCH_DIR>/<json-key>` (remember that `CPMUTIL_PATCH_DIR` defaults to `$ROOT/.patch`); e.g. `boost` patches would be in `.patch/boost`. Let's say we've made three patches and want to add them; in the Boost JSON definition, we would add:
+CPMUtil is able to apply in-place source tree patches to downloaded packages. These are defined in JSON as an array of names, preferably using `git-format-patch`'s scheme of `<4 digit number>-patch-name.patch`. These are stored in `<CPMUTIL_PATCH_DIR>/<json-key>` (remember that `CPMUTIL_PATCH_DIR` defaults to `$ROOT/.patch`); e.g. `boost` patches would be in `.patch/boost`. Let's say we've made three patches and want to add them; in the Boost JSON definition, we would add:

 ```json
 "patches": [
@@ -179,7 +151,7 @@ They are stored in `<CPMUTIL_PATCH_DIR>/<json-key>` (remember that `CPMUTIL_PATC
 ]
 ```

-Then, when Boost is downloaded, it will apply these patches to the source tree in the order they are defined (compound/dependent patches are okay!). Note that when you add, remove, or modify patches, CPMUtil will invalidate your downloaded cache and re-fetch the source.
+Then, when Boost is downloaded, it will apply these patches in order to the source tree.

 To learn how to make patches, see [Addendum: Making Patches](#addendum-making-patches).

@@ -227,9 +199,12 @@ If you're only concerned with basic usage, you can stop reading. For more advanc

 CPMUtil stores downloaded packages within `.cache/cpm` by default (see `CPM_SOURCE_CACHE`). Subdirectories stored within are lowercase representations of the `find_package` name for the package; for instance, a `vulkan-headers` definition with `package: "VulkanHeaders"` would be stored in `.cache/cpm/vulkanheaders`.

-Within these subdirectories, additional directories are created for each individual version, corresponding directly to their `version` field. CI packages use `<platform>-<architecture>-<version>` unconditionally.
+Within these subdirectories, additional directories are created for each individual version:

-To see the cache directory for a given package, use `tools/cpmutil.sh package dir <JSON key>`.
+- A four-character shorthand of `sha`, if defined
+- If `sha` is not defined, the fully qualified `version` is used
+
+CI packages use `<platform>-<architecture>-<version>` unconditionally.

 ## Addendum: Making Patches

@@ -267,7 +242,7 @@ If you are packaging a project that uses CPMUtil, read this!

 For sandboxed environments (e.g. Gentoo, nixOS) you must install all dependencies to the system beforehand and set `-DCPMUTIL_FORCE_SYSTEM=ON`. If a dependency is missing, get creating!

-Alternatively, if CPMUtil pulls in a package that has no suitable way to install or use a system version, download it separately and pass `-D<PackageName>_CUSTOM_DIR=/path/to/downloaded/dir`.
+Alternatively, if CPMUtil pulls in a package that has no suitable way to install or use a system version, download it separately and pass `-DPackageName_DIR=/path/to/downloaded/dir` (e.g. shaders)

 ### Unsandboxed

@@ -288,12 +263,14 @@ Using the prior Vulkan example:
    "repo": "KhronosGroup/Vulkan-Headers",
    "package": "VulkanHeaders",
    "min_version": "1.4.317",
-    "version": "v1.4.342"
+    "version": "1.4.342",
+    "tag": "v%VERSION%"
 },
 "vulkan-utility-libraries": {
    "repo": "KhronosGroup/Vulkan-Utility-Libraries",
    "package": "VulkanUtilityLibraries",
-    "version": "v1.4.342"
+    "version": "1.4.342",
+    "tag": "v%VERSION%"
 }
 ```

@@ -341,32 +318,3 @@ AddQt(QDash-CI/Qt 6.11.1)
 ```

 Then, call `find_package(Qt6 ...)` and it will pull Qt from your downloaded source.
-
-## Addendum: Package-Specific Overrides
-
-There are three variables that CPMUtil defines for each package; these can be overriden by the user or in your CMake. `package` refers either to the `package` value in the JSON, or the package's JSON key if unset (see `package` in [Common Properties](#common-properties)):
-
- `<package>_FORCE_BUNDLED`: Forcefully bundle the package. This has the same effect as `CPMUTIL_FORCE_BUNDLED`, but only for this package.
- `<package>_FORCE_BUNDLED`: Forcefully use the system package, failing if it can't be found. This has the same effect as `SYSTEM`, but only for this package.
- `<package>_CUSTOM_DIR`: Path to an extracted copy of the package. CPMUtil will not attempt to download the package and will instead use the custom directory.
-  - For an example, see [CPMUtil's test case](https://git.crueter.xyz/CMake/CPMUtil/src/branch/master/tests/dir/CMakeLists.txt)
-
-Additionally, in CMake, you can add `FORCE_BUNDLED_PACKAGE ON` to your `AddJsonPackage` command--note that you will have to use the `NAME <key>` syntax as described in [Module Path Packages](#addendum-module-path-packages). This will overrule *all* other overrides, including `CPMUTIL_FORCE_SYSTEM` and `<package>_FORCE_SYSTEM`--use with caution!
-
-## Addendum: Supply-Chain Security
-
-Many package managers suffer from the issue of supply chain security, specifically in regards to silent overwrites of existing packages or archives, e.g. tag sliding and artifact overwriting. CPMUtil has three methods to protect against this.
-
-### Checksumming
-
-CPMUtil *requires* SHA512 checksums for standard packages, and soon will for CI packages as well. If an attacker or compromised account slides a tag, overwrites a release artifact, or otherwise attempts to compromise anything that CPMUtil may fetch, **CPMUtil will not allow the download to continue!** This means that consumers of your build system can **only** download an artifact if the contents of the artifact are *exactly* indentical to what it was when it was configured--any changes at all will be rejected by CPMUtil.
-
-### Caching
-
-CPMUtil uses a mutable cache system, stored by default in `.cache/cpm`. Dependencies are downloaded and extracted here, and can be reused infinitely. This means that, for instance, if a package is compromised but you already have a cached local copy, you won't have to worry at all!
-
-### Immutable Commit Hashes
-
-CPMUtil is capable of using immutable Git commit hashes for its artifacts. These are (barring SHA1 collisions) completely immune to supply chain attacks--that is, unless the entire root server gets compromised to serve infected artifacts/source code; at which point there are much larger issues to worry about. This means that once you set a package to use a Git commit hash for its version, **it will stay the same forever**. This is useful if you want to ensure that consumers are never faced with download failures stemming from hash mismatches in case of compromised artifacts.
-
-Do note, however, that this will render the package incompatible with CPMUtil's built-in auto-updater, so you will have to manually update the package.
@@ -12,6 +12,10 @@
 - [NetBSD](#netbsd)
 - [MSYS2](#msys2)
 - [RedoxOS](#redoxos)
+- [Windows](#windows)
+  - [Windows 7, Windows 8 and Windows 8.1](#windows-7-windows-8-and-windows-81)
+  - [Windows Vista and below](#windows-vista-and-below)
+  - [Windows on ARM](#windows-on-arm)
 <!-- /TOC -->

 ## Arch Linux
@@ -67,7 +71,7 @@ export LIBGL_ALWAYS_SOFTWARE=1

 Install `developer/gcc14` on OmniOS using pkgsrc.

-Since so many dependencies are missing on `OmniOS`, you may wish to use `-DCPMUTIL_FORCE_BUNDLED=ON` and `-DYUZU_USE_BUNDLED_OPENSSL=OFF`.
+Since so many dependencies are missing on `OmniOS`, you may wish to use `-DCPMUTIL_FORCE_BUNDLED=ON`

 For OmniOS you are required to build glslang yourself:
 ```sh
@@ -86,9 +90,7 @@ Using `--parallel` on CMake incorrectly passes `dmake ... -jn` instead of `dmake

 You may also need to install `gmake` in order to properly build FFmpeg, this is provided by the `build-essential` package.

-If it wasn't obvious already, you require a X11 server to properly run the emulator within OmniOS, [this guide](https://web.archive.org/web/20260424200928/https://geekblood.wordpress.com/2017/10/26/installing-x11-and-a-desktop-environment-on-omnios/) is a great starting point for that, the links to pkgsrc are outdated so follow [this exemplar](https://pkgsrc.smartos.org/install-on-illumos/) as well.
-
-For Solaris based OSes, `${CMAKE_SYSTEM_NAME}` isn't properly set on CMake (it's set to i686 on AMD64), you may find issues when building OpenSSL from `openssl-cmake`.
+If it wasn't obvious already, you require a X11 server to properly run the emulator within OmniOS, [this guide](https://web.archive.org/web/20260424200928/https://geekblood.wordpress.com/2017/10/26/installing-x11-and-a-desktop-environment-on-omnios/) is a great starting point for that, the links to pkgsrc are outdated so follow [this exemplar](https://pkgsrc.smartos.org/install-on-illumos/) as well:

 ## HaikuOS

@@ -242,3 +244,19 @@ find ./*/ -name "*.dll" | while read -r dll; do deps "$dll"; done
 The package install may randomly hang at times, in which case it has to be restarted. ALWAYS do a `sudo pkg update` or the chances of it hanging will be close to 90%. If "multiple" installs fail at once, try installing 1 by 1 the packages.

 When CMake invokes certain file syscalls - it may sometimes cause crashes or corruptions on the (kernel?) address space - so reboot the system if there is a "hang" in CMake.
+
+## Windows
+
+### Windows 7, Windows 8 and Windows 8.1
+
+DirectX 12 is not available - simply copy and paste a random DLL and name it `d3d12.dll`.
+
+Install [Qt6 compatibility libraries](github.com/ANightly/qt6windows7) specifically Qt 6.9.5.
+
+### Windows Vista and below
+
+No support for Windows Vista (or below) is present at the moment. Check back later.
+
+### Windows on ARM
+
+If you're using Snapdragon X or 8CX, use the [the Vulkan translation layer](https://apps.microsoft.com/detail/9nqpsl29bfff?hl=en-us&gl=USE) only if the stock drivers do not work. And of course always keep your system up-to-date.
@@ -6,7 +6,7 @@ When reporting issues or finding bugs, we often need backtraces, debug logs, or

 ### Graphics Debugging

-If your bug is related to a graphical issue -- e.g. mismatched colors, vertex explosions, flickering, etc. -- then you are required to include graphical debugging logs in your issue reports.
+If your bug is related to a graphical issue--e.g. mismatched colors, vertex explosions, flickering, etc.--then you are required to include graphical debugging logs in your issue reports.

 Graphics Debugging is found in General -> Debug on desktop, and Advanced Settings -> Debug on Android. Android users are all set; however, desktop users may need to install the Vulkan Validation Layers:

@@ -17,7 +17,7 @@ Once Graphics Debugging is enabled, run the problematic game again and continue.

 ### Debug Logs

-Debug logs can be found in `General -> Debug -> Open Log Location` on desktop, and `Share Debug Logs` on Android. This MUST be included in all bug reports, except for certain UI bugs -- but we still highly recommend them even for UI bugs.
+Debug logs can be found in General -> Debug -> Open Log Location on desktop, and Share Debug Logs on Android. This MUST be included in all bug reports, except for certain UI bugs--but we still highly recommend them even for UI bugs.

 ## Debugging (host code)

@@ -38,7 +38,7 @@ You must have GDB installed for aarch64 to debug the target. Install it through
  - `sudo emerge --ask crossdev`
  - `sudo crossdev -t aarch64-unknown-linux-gnu --ex-gdb`

-Run `./build/bin/eden-cli -c <path to your config file (see logs where you run Eden normally to see where it is)> -d -g <path to game>`, or `Enable GDB Stub` at General > Debug, then hook up an aarch64-gdb:
+Run `./build/bin/eden-cli -c <path to your config file (see logs where you run eden normally to see where it is)> -d -g <path to game>`, or `Enable GDB Stub` at General > Debug, then hook up an aarch64-gdb:

 - `target remote localhost:6543`

@@ -69,55 +69,6 @@ Expressions can be `variable_names` or `1234` (numbers) or `*var` (dereference o

 For more information type `info gdb` and read [the man page](https://man7.org/linux/man-pages/man1/gdb.1.html).

-# RenderDoc
+# RenderDoc (Graphic Debugging Tool)

-RenderDoc is a free, cross platform, multi-graphics API debugger. It is an invaluable tool for diagnosing issues with graphics applications, and includes support for Vulkan. Get it from [renderdoc.org](https://renderdoc.org).
-
-RenderDoc can capture Eden's Vulkan output when its Vulkan layer is loaded before Eden creates the Vulkan device. Before using RenderDoc to diagnose issues, it's always good to make sure there are no validation errors. Any errors means the behavior of the application is undefined. That said, RenderDoc can help debug validation errors if you do have them.
-
-## Usage on Windows 
-
-You can either use RenderDoc UI to launch Eden, or you can make Eden attach it internally:
-
-On Windows PowerShell:
-```powershell
-$env:ENABLE_VULKAN_RENDERDOC_CAPTURE='1'
-.\eden.exe
-```
-When RenderDoc is attached, Eden logs the default Windows capture folder:
-```text
-%LOCALAPPDATA%\Temp\RenderDoc
-```
-
-Press RenderDoc's capture hotkey, usually `F12`, to capture a frame. To stop using RenderDoc, close Eden and launch it again without `ENABLE_VULKAN_RENDERDOC_CAPTURE`.
-
-## Eden Hotkey
-
-Eden also has a separate `Toggle Renderdoc Capture` hotkey behind the debug setting `renderdoc_hotkey`.
-That hotkey does not load or unload RenderDoc. It only toggles Eden's own manual capture through RenderDoc's API:
-
- First press: Starts a capture
- Second press: Ends that capture
-
-## Simple checklist for debugging black screens using Renderdoc
-
-When debugging a black screen, there are many ways the application could have setup Vulkan wrong.
-Here is a short checklist of items to look at to make sure are appropriate:
-
- Draw call counts are correct (aka not zero, or if rendering many triangles, not 3)
- Vertex buffers are bound
- vertex attributes are correct - Make sure the size & offset of each attribute matches what should it should be
- Any bound push constants and descriptors have the right data - including:
-  - Matrices have correct values - double check the model, view, & projection matrices are uploaded correctly
- Pipeline state is correct
-  - viewport range is correct - x,y are 0,0; width & height are screen dimensions, minDepth is 0, maxDepth is 1, NDCDepthRange is 0,1
-  - Fill mode matches expected - usually solid
-  - Culling mode makes sense - commonly back or none
-  - The winding direction is correct - typically CCW (counter clockwise)
-  - Scissor region is correct - usually same as viewport's x,y,width, &height
- Blend state is correct
- Depth state is correct - typically enabled with Function set to Less than or Equal
- Swapchain images are bound when rendering to the swapchain
- Image being rendered to is the same as the one being presented when rendering to the swapchain
-
-Alternatively, a [RenderDoc Extension](https://github.com/baldurk/renderdoc-contrib/tree/main/baldurk/whereismydraw) ([Archive](https://web.archive.org/web/20250000000000*/https://github.com/baldurk/renderdoc-contrib/tree/main/baldurk/whereismydraw)) exists which automates doing a lot of these manual steps.
+Guidelines for graphical debugging using RenderDoc: **[RenderDoc usage](./RenderDoc.md)**
@@ -260,10 +260,7 @@ brew install molten-vk
 <details>
 <summary>FreeBSD</summary>

-As root run:
-```sh
-pkg install devel/cmake devel/sdl3 devel/boost-libs devel/catch2 devel/libfmt devel/nlohmann-json devel/ninja devel/nasm devel/autoconf devel/pkgconf devel/qt6-base x11-toolkits/qt6-charts devel/simpleini net/enet multimedia/ffnvcodec-headers multimedia/ffmpeg audio/opus archivers/liblz4 lang/gcc12 graphics/glslang graphics/vulkan-utility-libraries graphics/spirv-tools www/cpp-httplib devel/unordered-dense vulkan-headers quazip-qt6
-```
+As root run: `pkg install devel/cmake sdl3 devel/boost-libs devel/catch2 devel/libfmt devel/nlohmann-json devel/ninja devel/nasm devel/autoconf devel/pkgconf devel/qt6-base devel/qt6-charts devel/simpleini net/enet multimedia/ffnvcodec-headers multimedia/ffmpeg audio/opus archivers/liblz4 lang/gcc12 graphics/glslang graphics/vulkan-utility-libraries graphics/spirv-tools www/cpp-httplib devel/unordered-dense vulkan-headers quazip-qt6`

 If using FreeBSD 12 or prior, use `devel/pkg-config` instead.

@@ -276,7 +273,7 @@ If using FreeBSD 12 or prior, use `devel/pkg-config` instead.
 For NetBSD +10.1:

 ```sh
-pkgin install git cmake boost fmtlib SDL3 catch2 libjwt spirv-headers spirv-tools ffmpeg7 libva nlohmann-json jq libopus qt6-qtbase qt6-qtcharts qt6-qtmultimedia qt6-qttools cpp-httplib lz4 vulkan-headers nasm autoconf enet pkg-config libusb1 libcxx frozen
+pkgin install git cmake boost fmtlib SDL3 catch2 libjwt spirv-headers spirv-tools ffmpeg7 libva nlohmann-json jq libopus qt6 cpp-httplib lz4 vulkan-headers nasm autoconf enet pkg-config libusb1 libcxx frozen
 ```

 [Caveats](./Caveats.md#netbsd).
@@ -1,47 +0,0 @@
-# Design Overview
-
-Modern game consoles require heavy power to be emulated appropriately. This is why the emulator uses an approach known as HLE (High-Level-Emulation), in a nutshell: Instead of accurately emulating every subsystem that forms part of a component, emulate the resulting visible I/O interface instead.
-
-For example, take a disk write, instead of emulating a proper SD card we instead use the C++ standard library for I/O. Additionally we use the abstractions provided by the `fs` service to "lie" to programs about certain SD card properties. Notably this includes making up sizes for the fake SD card, giving "realistic" values or expected outputs for a given card, and so on. And instead of writing to an actual SD card, the emulator simply writes to a file.
-
-This also means grand part of the emulator consists of just re-implementing firmware but using HLE primitives; for example audio doesn't go to an emulated audio device, but rather gets processed on the fly by a dedicated service and then passed to SDL3/cubeb/etc.
-
-As such, many of the systems implemented are not 100% accurate to the original software, but they're "good enough" to pass as being so. While we do strive to maintain high compatibility (especially with homebrew), there are realistic limitations to these approaches.
-
-No formal fuzzing or formal verification has been done on the emulator as a whole, this means there may be hundreds of bugs hiding in each subsystem. As such, output may also not correctly match due to those aforementioned issues.
-
-## src/android/
-
-Entire Android frontend, written mostly in Kotlin and generally having asinine hacks (thanks Android) due to the particularly horrific (and particular way) to do things.
-
-## src/audio_core/
-
-Handles everything related to audio, this is where most of the filtering and processing occurs (CPU intensive task!).
-
-## src/common/
-
-The [common](../src/common) folder contains just your basic polyfills for whatever missing functionality. We heavily encourage new PRs to make use of one of the dependencies, or the standard C++ library. Minimizing the amount of things we reinvent the wheel for is always a good thing.
-
-## src/core/
-
-The [core folder](../src/core) is the main heart of the emulator, while we don't officially support having other frontends out of the box (RetroArch, for example); any prospective developer can reuse this library (compiled as one by CMake) to stitch up their own RetroArch core, for example.
-
-## src/dynarmic/
-
-See [Dynarmic](./dynarmic).
-
-## src/hid_core/
-
-Input, joysticks, controllers and everything related to input devices.
-
-## src/shader_recompiler/
-
-Dedicated shader recompiler to translate Maxwell assembly code to either SPIR-V, GLSL or GLASM.
-
-## src/video_core/
-
-Most of the things here have their own dedicated section. In short this is basically the entire Tegra NVIDIA Maxwell GPU emulation. Additionally it includes some [extra effects](../src/video_core/host_shaders/opengl_smaa.glsl) to emulate MSAA, D24 copies or as polyfill.
-
-Available backends are: Null, Vulkan, and OpenGL.
-
-See [NVIDIA GPU](./NvidiaGpu.md).
@@ -91,7 +91,7 @@ You may additionally need the `Qt Extension Pack` extension if building Qt.

 # Build speedup

-If you have an HDD, use ramdisk (build in RAM), approximately you need 4GB for a full build with debug symbols:
+If you have an HDD, use ramdisk (build in RAM), approximatedly you need 4GB for a full build with debug symbols:

 ```sh
 mkdir /tmp/ramdisk
@@ -110,7 +110,7 @@ A general rule of thumb, before uploading files:
 - PNG files: Use [optipng](https://web.archive.org/web/20240325055059/https://optipng.sourceforge.net/).
 - SVG files: Use [svgo](https://github.com/svg/svgo).

-May not be used but worth mentioning nonetheless:
+May not be used but worth mentioning nonethless:

 - OGG files: Use [OptiVorbis](https://github.com/OptiVorbis/OptiVorbis).
 - Video files: Use ffmpeg, preferably re-encode as AV1.
@@ -46,8 +46,6 @@ These options control dependencies.
 - `YUZU_INSTALL_UDEV_RULES` (OFF) Install udev rules to enable hidraw access
  - Needed for gyroscopes
  - Only available on Linux
- `ENABLE_DEBUG_TOOLS` (OFF) Enables debugging and development tools, see [tools](../tools/README.md).
- `ENABLE_WERROR` (ON) Enables warnings as errors (-Werror).

 ### Flavors

@@ -2,7 +2,7 @@

 Are you just a casual user? Take a look at our [User Handbook](./user) then!

-If you want to register/signup as a contributor, take a gander at the [signup guide](https://git.eden-emu.dev/crueter/signup/src/branch/main/README.md).
+If you want to register/signup as a contributor, take a gander at the [signup guide](./SIGNUP.md).

 This contains documentation created by developers. This contains build instructions, guidelines, instructions/layouts for [cool stuff we made](./CPMUtil), and more.

@@ -12,25 +12,26 @@ This contains documentation created by developers. This contains build instructi
 - **[Development Guidelines](./Development.md)**
 - **[Dependencies](./Deps.md)**
 - **[Debug Guidelines](./Debug.md)**
-  - **[RenderDoc](./Debug.md#renderdoc)**
- **[CPM - CMake Package Manager](./CPMUtil.md)**
+- **[RenderDoc usage](./RenderDoc.md)**
+- **[CPM - CMake Package Manager](./CPMUtil)**
 - **[Platform-Specific Caveats](./Caveats.md)**
 - **[The NVIDIA SM86 (Maxwell) GPU](./NvidiaGpu.md)**
+- **[Cross compilation](./CrossCompile.md)**
 - **[Driver Bugs](./DriverBugs.md)**
 - **[Building Older Commits](./build/OlderCommits.md)**
 - Subsystems:
-  - **[Design Overview](./DesignOverview.md)**
-  - **[Dynarmic](./dynarmic/README.md)**
-  - **[HOS Kernel](./HosKernel.md)**
-  - **[Settings](./Settings.md)**
+    - **[Dynarmic](./dynarmic/README.md)**
+    - **[HOS Kernel](./HosKernel.md)**
+    - **[Settings](./Settings.md)**

 ## Policies

 Policies and information on development.

 - **[AI and LLM Usage](./policies/AI.md)**
+- **[Release Policy](./policies/Release.md)**
 - **[Coding guidelines](./policies/Coding.md)**
- **[Contributing](../CONTRIBUTING.md)**
+- **[Coding Style guidelines](./policies/CodingStyle.md)**

 ## Externals

@@ -0,0 +1,52 @@
+# RenderDoc
+
+Renderdoc is a free, cross platform, multi-graphics API debugger. It is an invaluable tool for diagnosing issues with graphics applications, and includes support for Vulkan. Get it at [renderdoc.org](https://renderdoc.org).
+
+RenderDoc can capture Eden's Vulkan output when its Vulkan layer is loaded before Eden creates the Vulkan device. Before using renderdoc to diagnose issues, it is always good to make sure there are no validation errors. Any errors means the behavior of the application is undefined. That said, renderdoc can help debug validation errors if you do have them.
+
+## Usage on Windows 
+
+You can either use RenderDoc UI to launch eden, or you can make eden attach it internally:
+
+On Windows PowerShell:
+```powershell
+$env:ENABLE_VULKAN_RENDERDOC_CAPTURE='1'
+.\eden.exe
+```
+When RenderDoc is attached, Eden logs the default Windows capture folder:
+```text
+%LOCALAPPDATA%\Temp\RenderDoc
+```
+
+Press RenderDoc's capture hotkey, usually `F12`, to capture a frame. To stop using RenderDoc, close Eden and launch it again without `ENABLE_VULKAN_RENDERDOC_CAPTURE`.
+
+## Eden Hotkey
+
+Eden also has a separate `Toggle Renderdoc Capture` hotkey behind the debug setting `renderdoc_hotkey`.
+That hotkey does not load or unload RenderDoc. It only toggles Eden's own manual capture through RenderDoc's API:
+
+- first press: starts a capture
+- second press: ends that capture
+
+## Simple checklist for debugging black screens using Renderdoc
+
+When debugging a black screen, there are many ways the application could have setup Vulkan wrong.
+Here is a short checklist of items to look at to make sure are appropriate:
+
+- Draw call counts are correct (aka not zero, or if rendering many triangles, not 3)
+- Vertex buffers are bound
+- vertex attributes are correct - Make sure the size & offset of each attribute matches what should it should be
+- Any bound push constants and descriptors have the right data - including:
+  - Matrices have correct values - double check the model, view, & projection matrices are uploaded correctly
+- Pipeline state is correct
+  - viewport range is correct - x,y are 0,0; width & height are screen dimensions, minDepth is 0, maxDepth is 1, NDCDepthRange is 0,1
+  - Fill mode matches expected - usually solid
+  - Culling mode makes sense - commonly back or none
+  - The winding direction is correct - typically CCW (counter clockwise)
+  - Scissor region is correct - usually same as viewport's x,y,width, &height
+- Blend state is correct
+- Depth state is correct - typically enabled with Function set to Less than or Equal
+- Swapchain images are bound when rendering to the swapchain
+- Image being rendered to is the same as the one being presented when rendering to the swapchain
+
+Alternatively, a [RenderDoc Extension](https://github.com/baldurk/renderdoc-contrib/tree/main/baldurk/whereismydraw) ([Archive](https://web.archive.org/web/20250000000000*/https://github.com/baldurk/renderdoc-contrib/tree/main/baldurk/whereismydraw)) exists which automates doing a lot of these manual steps.
@@ -0,0 +1,76 @@
+# Signup
+
+To prevent spam and reduce bandwidth usage, registration is closed, and will likely remain this way.
+
+## Valid Reasons
+
+First of all, you MUST have a valid reason to sign up for our Git. Valid reasons include (but are not limited to):
+
+- I want to add feature XYZ...
+- I want to improve the macOS version...
+- I want to improve the Vulkan backend...
+- I want to fix bug XYZ...
+- I have experience in XYZ...
+- I can provide insight on XYZ...
+
+## Invalid Reasons
+
+The following are not valid reasons to sign up:
+
+- I want to contribute to Eden.
+  * Be at least somewhat specific! We always welcome contributors and developers, but generic "I want to contribute" messages don't give us enough information.
+- I want to support Eden.
+  * If you wish to support us through development, be more specific; otherwise, to support us, check out our [donations page](https://eden-emu.dev/donations).
+- I want to report issues.
+  * Most of our issue tracking is handled on [GitHub](https://github.com/eden-emulator/Issue-Reports) for the time being. This is subject to change.
+- I want to play/use Eden.
+  * To download and use Eden, see our [Releases page](https://github.com/eden-emulator/Releases/releases)!
+- I want to see the source code.
+  * To see Eden's source code, go [here](https://git.eden-emu.dev/eden-emu/eden).
+
+## Other Information
+
+Requests that appear suspicious, automated, OR blank will generally be automatically filtered. In cases of suspicion, or any of the invalid reasons listed above, you may receive an email back asking for clarification.
+
+You MUST use the following format:
+
+```
+Subject: [Eden Git] Registration Request
+Username: <Your Desired Username>
+Email: <Your Desired Email>
+I wish to sign up because... <your reason here>
+```
+
+Email notifications are disabled for the time being, so you don't have to use a real email. If you wish to remain anonymous, either send a separate email asking for access to a shared anonymous account, *or* create a fake username and email. Do note that the email you sign up with is used to accredit commits on the web UI, and *must* match your configured GPG key.
+
+## Patches
+
+In general, PRs are the preferred method of tracking patches, as they allow us to go through our standard triage, CI, and testing process without having to deal with the minutiae of incremental patches. However, we also understand that many people prefer to use raw patches, and that's totally okay! While we currently don't have a mailing list, we do accept email patches. To do so:
+
+1. Make your changes on a clean copy of the master branch
+2. Commit your changes with a descriptive, well-formed message (see the [commit message docs](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/Development.md#pull-requests)), and a proper description thoroughly explaining your changes.
+  * Note that we don't need to know all the individual details about your code. A description explaining the motivation and general implementation of your changes is enough, alongside caveats and any potential blockers.
+3. Format your patch with `git format-patch -1 HEAD`.
+4. Email us with the subject `[Eden] [PATCH] <brief patch description...>`, with a brief description of your patch, and the previously-formatted patch file as an attachment.
+  * If you don't include the first two bracketed parts, your email may be lost!
+
+The following emails are currently set up to receive and process patches:
+
+- [eden@eden-emu.dev](mailto:eden@eden-emu.dev]
+- [crueter@eden-emu.dev](mailto:eden@eden-emu.dev)
+
+## Instructions
+
+If you have read everything above and affirm that you will not abuse your access, click the summary below to get the email to send your request to.
+
+<details>
+<summary>I affirm that I have read ALL of the information above, and will not abuse my access to Eden, nor will I send unnecessary spam to the following email.</summary>
+
+Email [crueter@crueter.xyz](mailto:crueter@crueter.xyz) with the format above.
+
+Once your request is processed, you should receive a confirmation email from crueter with your password alongside a link to a repository containing instructions on SSH, etc. Note that you are required to change your password. If your request is rejected, you will receive a notice as such, asking for clarification if needed. If you do not receive a response in 48 hours, you may send another email.
+
+> [!WARNING]
+> Some email providers may place the response email in your spam/junk folder; notable offenders include Gmail and Outlook. *Always* ensure to check your Spam/Junk folder, until Google/Microsoft finally end their vendetta against the great evil of my `.xyz` domain.
+
+</details>
@@ -1,11 +1,11 @@
 # Settings

 > [!WARNING]
-> This guide is intended for developers ONLY. If you're looking for configuring the emulator itself, read **[the user handbook](./user/README.md)**.
+> This guide is intended for developers ONLY. If you're looking for configuring the emulator itself, please read **[the user handbook](./user/README.md)**.

 Settings on the emulator are very important, toggles and such can be used to guard and/or add branches to paths where some games may crash while others won't, and viceversa.

-However, this process can be tedious for those unfamiliar; this document serves as an outline/documentation for the settings subsystem.
+However, this process can be tedious for those unfamiliar; this document serves as a outline/documentation for the settings subsystem.

 ## Index

@@ -78,7 +78,7 @@ INSERT(Settings,

 #### Make sure to:

-* Keep display naming consistent
+* Keep display naming consistant
 * Put detailed info in the description
 * Use `\n` for line breaks in descriptions

@@ -184,7 +184,7 @@ The setting ranges from 0 to 65535 (0x0000 to 0xFFFF), where each bit represents

 ### Advantages

-The main advantage is to avoid deploying new disposable toggles (those made only for testing stage, and are disposed once new feature gets good to merge). This empowers devs to be free of all frontend bureaucracy and hassle of new toggles.
+The main advantage is to avoid deploying new disposable toggles (those made only for testing stage, and are disposed once new feature gets good to merge). This empowers devs to be free of all frontend burocracy and hassle of new toggles.

 Common advantages recap:

@@ -1,44 +1,44 @@
 # Dynarmic Design Documentation

-Dynarmic is a dynamic recompiler for the ARMv6K architecture. Future plans for Dynarmic include
+Dynarmic is a dynamic recompiler for the ARMv6K architecture. Future plans for dynarmic include
 support for other versions of the ARM architecture, having a interpreter mode, and adding support
 for other architectures.

 Users of this library interact with it primarily through the interface provided in
-[`src/dynarmic/interface`](../../src/dynarmic/src/dynarmic/interface). Users specify how Dynarmic's CPU core interacts with
+[`src/dynarmic/interface`](../src/dynarmic/interface). Users specify how dynarmic's CPU core interacts with
 the rest of their system providing an implementation of the relevant `UserCallbacks` interface.
 Users setup the CPU state using member functions of `Jit`, then call `Jit::Execute` to start CPU
 execution. The callbacks defined on `UserCallbacks` may be called from dynamically generated code,
 so users of the library should not depend on the stack being in a walkable state for unwinding.

-* A32: [`Jit`](../../src/dynarmic/src/dynarmic/interface/A32/a32.h), [`UserCallbacks`](../../src/dynarmic/src/dynarmic/interface/A32/config.h)
-* A64: [`Jit`](../../src/dynarmic/src/dynarmic/interface/A64/a64.h), [`UserCallbacks`](../../src/dynarmic/src/dynarmic/interface/A64/config.h)
+* A32: [`Jit`](../src/dynarmic/interface/A32/a32.h), [`UserCallbacks`](../src/dynarmic/interface/A32/config.h)
+* A64: [`Jit`](../src/dynarmic/interface/A64/a64.h), [`UserCallbacks`](../src/dynarmic/interface/A64/config.h)

 Dynarmic reads instructions from memory by calling `UserCallbacks::MemoryReadCode`. These
 instructions then pass through several stages:

 1. Decoding (Identifying what type of instruction it is and breaking it up into fields)
 2. Translation (Generation of high-level IR from the instruction)
-3. Optimization (Elimination of redundant microinstructions, other speed improvements)
+3. Optimization (Eliminiation of redundant microinstructions, other speed improvements)
 4. Emission (Generation of host-executable code into memory)
 5. Execution (Host CPU jumps to the start of emitted code and runs it)

 Using the A32 frontend with the x64 backend as an example:

 * Decoding is done by [double dispatch](https://en.wikipedia.org/wiki/Visitor_pattern) in
-  [`src/frontend/A32/decoder/{arm.h,thumb16.h,thumb32.h}`](../../src/dynarmic/src/dynarmic/frontend/A32/decoder/).
-* Translation is done by the visitors in [`src/dynarmic/frontend/A32/translate/translate_{arm,thumb}.cpp`](../../src/dynarmic/src/dynarmic/frontend/A32/translate/).
-  The function [`Translate`](../../src/dynarmic/src/dynarmic/frontend/A32/translate/a32_translate.cpp) takes a starting memory location,
+  [`src/frontend/A32/decoder/{arm.h,thumb16.h,thumb32.h}`](../src/dynarmic/frontend/A32/decoder/).
+* Translation is done by the visitors in [`src/dynarmic/frontend/A32/translate/translate_{arm,thumb}.cpp`](../src/dynarmic/frontend/A32/translate/).
+  The function [`Translate`](../src/dynarmic/frontend/A32/translate/translate.h) takes a starting memory location,
  some CPU state, and memory reader callback and returns a basic block of IR.
-* The IR can be found under [`src/frontend/ir/`](../../src/dynarmic/src/dynarmic/ir/).
-* Optimizations can be found under [`src/ir/opt_passes.cpp`](../../src/dynarmic/src/dynarmic/ir/opt_passes.cpp).
-* Emission is done by `EmitX64` which can be found in [`src/dynarmic/backend/x64/emit_x64.{h,cpp}`](../../src/dynarmic/src/dynarmic/backend/x64/).
-* Execution is performed by calling `BlockOfCode::RunCode` in [`src/dynarmic/backend/x64/block_of_code.{h,cpp}`](../../src/dynarmic/src/dynarmic/backend/x64/).
+* The IR can be found under [`src/frontend/ir/`](../src/dynarmic/ir/).
+* Optimizations can be found under [`src/ir_opt/`](../src/dynarmic/ir/opt/).
+* Emission is done by `EmitX64` which can be found in [`src/dynarmic/backend/x64/emit_x64.{h,cpp}`](../src/dynarmic/backend/x64/).
+* Execution is performed by calling `BlockOfCode::RunCode` in [`src/dynarmic/backend/x64/block_of_code.{h,cpp}`](../src/dynarmic/backend/x64/).

 ## Decoder

 The decoder is a double dispatch decoder. Each instruction is represented by a line in the relevant
-instruction table. Here is an example line from [`arm.h`](../../src/dynarmic/src/dynarmic/frontend/A32/decoder/arm.h):
+instruction table. Here is an example line from [`arm.h`](../src/dynarmic/frontend/A32/decoder/arm.h):

    INST(&V::arm_ADC_imm,     "ADC (imm)",           "cccc0010101Snnnnddddrrrrvvvvvvvv")

@@ -61,7 +61,7 @@ error results.
 ## Translator

 The translator is a visitor that uses the decoder to decode instructions. The translator generates IR code with the
-help of the [`IREmitter` class](../../src/dynarmic/src/dynarmic/ir/ir_emitter.h). An example of a translation function follows:
+help of the [`IREmitter` class](../src/dynarmic/ir/ir_emitter.h). An example of a translation function follows:

    bool ArmTranslatorVisitor::arm_ADC_imm(Cond cond, bool S, Reg n, Reg d, int rotate, Imm8 imm8) {
        u32 imm32 = ArmExpandImm(rotate, imm8);
@@ -107,7 +107,7 @@ function analyser in the medium-term future.
 Dynarmic's intermediate representation is typed. Each microinstruction may take zero or more arguments and may
 return zero or more arguments. A subset of the microinstructions available is documented below.

-A complete list of microinstructions can be found in [src/dynarmic/ir/opcodes.inc](../../src/dynarmic/src/dynarmic/ir/opcodes.inc).
+A complete list of microinstructions can be found in [src/dynarmic/ir/opcodes.inc](../src/dynarmic/ir/opcodes.inc).

 The below lists some commonly used microinstructions.

@@ -273,7 +273,7 @@ Exclusive OR (i.e.: XOR)

 ### Callback: {Read,Write}Memory{8,16,32,64}

-```cpp
+```c++
 <u8> ReadMemory8(<u32> vaddr)
 <u8> ReadMemory16(<u32> vaddr)
 <u8> ReadMemory32(<u32> vaddr)
@@ -288,7 +288,7 @@ Memory access.

 ### Terminal: ReturnToDispatch

-```cpp
+```c++
 SetTerm(IR::Term::ReturnToDispatch{})
 ```

@@ -297,7 +297,7 @@ The dispatcher will use the value in R15 to determine what comes next.

 ### Terminal: LinkBlock

-```cpp
+```c++
 SetTerm(IR::Term::LinkBlock{next})
 ```

@@ -307,7 +307,7 @@ dispatcher, which will return control to the host.

 ### Terminal: LinkBlockFast

-```cpp
+```c++
 SetTerm(IR::Term::LinkBlockFast{next})
 ```

@@ -316,7 +316,7 @@ This promises guarantees that must be held at runtime - i.e that the program won

 ### Terminal: PopRSBHint

-```cpp
+```c++
 SetTerm(IR::Term::PopRSBHint{})
 ```

@@ -328,7 +328,7 @@ this optimization or doesn't have a RSB may choose to implement this exactly as

 ### Terminal: If

-```cpp
+```c++
 SetTerm(IR::Term::If{cond, term_then, term_else})
 ```

@@ -366,7 +366,7 @@ Do NEVER modify `%r15`, we must make it clear that this register is "immutable"

 ### `Scratch`

-```cpp
+```c++
 Xbyak::Reg64 ScratchGpr(HostLocList desired_locations = any_gpr);
 Xbyak::Xmm ScratchXmm(HostLocList desired_locations = any_xmm);
 ```
@@ -375,7 +375,7 @@ At runtime, allocate one of the registers in `desired_locations`. You are free t

 ### Pure `Use`

-```cpp
+```c++
 Xbyak::Reg64 UseGpr(Argument& arg);
 Xbyak::Xmm UseXmm(Argument& arg);
 OpArg UseOpArg(Argument& arg);
@@ -391,7 +391,7 @@ This register **must not** have it's value changed.

 ### `UseScratch`

-```cpp
+```c++
 Xbyak::Reg64 UseScratchGpr(Argument& arg);
 Xbyak::Xmm UseScratchXmm(Argument& arg);
 void UseScratch(Argument& arg, HostLoc host_loc);
@@ -409,7 +409,7 @@ You are free to modify the value in the register. The register is discarded at t

 A `Define` is the defintion of a value. This is the only time when a value may be set.

-```cpp
+```c++
 void DefineValue(IR::Inst* inst, const Xbyak::Reg& reg);
 ```

@@ -420,7 +420,7 @@ value to the specified register `reg`.

 Adding a `Define` to an existing value.

-```cpp
+```c++
 void DefineValue(IR::Inst* inst, Argument& arg);
 ```

@@ -458,7 +458,7 @@ One complication dynarmic has is that a compiled block is not uniquely identifia
 the PC alone, but bits in the FPSCR and CPSR are also relevant. We resolve this by
 computing a 64-bit `UniqueHash` that is guaranteed to uniquely identify a block.

-```cpp
+```c++
 u64 LocationDescriptor::UniqueHash() const {
    // This value MUST BE UNIQUE.
    // This calculation has to match up with EmitX64::EmitTerminalPopRSBHint
@@ -482,18 +482,18 @@ point. Each element in `rsb_location_descriptors` is a `UniqueHash` and they
 each correspond to an element in `rsb_codeptrs`. `rsb_codeptrs` contains the
 host addresses for the corresponding the compiled blocks.

-`RSB_SIZE` was chosen by performance testing. Note that this is bigger than the
+`RSBSize` was chosen by performance testing. Note that this is bigger than the
 size of the real RSB in hardware (which has 3 entries). Larger RSBs than 8
 showed degraded performance.

-```cpp
+```c++
 struct JitState {
    // ...

-    static constexpr size_t RSB_SIZE = 8; // MUST be a power of 2.
+    static constexpr size_t RSBSize = 8; // MUST be a power of 2.
    u32 rsb_ptr = 0;
-    std::array<u64, RSB_SIZE> rsb_location_descriptors;
-    std::array<u64, RSB_SIZE> rsb_codeptrs;
+    std::array<u64, RSBSize> rsb_location_descriptors;
+    std::array<u64, RSBSize> rsb_codeptrs;
    void ResetRSB();

    // ...
@@ -505,7 +505,7 @@ struct JitState {
 We insert our prediction at the insertion point iff the RSB doesn't already
 contain a prediction with the same `UniqueHash`.

-```cpp
+```c++
 void EmitX64::EmitPushRSB(IR::Block&, IR::Inst* inst) {
    using namespace Xbyak::util;

@@ -521,7 +521,7 @@ void EmitX64::EmitPushRSB(IR::Block&, IR::Inst* inst) {

    code->mov(index_reg, dword[code.ABI_JIT_PTR + offsetof(JitState, rsb_ptr)]);
    code->add(index_reg, 1);
-    code->and_(index_reg, u32(JitState::RSB_SIZE - 1));
+    code->and_(index_reg, u32(JitState::RSBSize - 1));

    code->mov(loc_desc_reg, u64(imm64));
    CodePtr patch_location = code->getCurr<CodePtr>();
@@ -530,7 +530,7 @@ void EmitX64::EmitPushRSB(IR::Block&, IR::Inst* inst) {
    code->EnsurePatchLocationSize(patch_location, 10);

    Xbyak::Label label;
-    for (size_t i = 0; i < JitState::RSB_SIZE; ++i) {
+    for (size_t i = 0; i < JitState::RSBSize; ++i) {
        code->cmp(loc_desc_reg, qword[code.ABI_JIT_PTR + offsetof(JitState, rsb_location_descriptors) + i * sizeof(u64)]);
        code->je(label, code->T_SHORT);
    }
@@ -544,12 +544,12 @@ void EmitX64::EmitPushRSB(IR::Block&, IR::Inst* inst) {

 In pseudocode:

-```cpp
-    for (i := 0 .. RSB_SIZE-1)
+```c++
+    for (i := 0 .. RSBSize-1)
        if (rsb_location_descriptors[i] == imm64)
        goto label;
    rsb_ptr++;
-    rsb_ptr %= RSB_SIZE;
+    rsb_ptr %= RSBSize;
    rsb_location_desciptors[rsb_ptr] = imm64; //< The UniqueHash
    rsb_codeptr[rsb_ptr] = /* codeptr corresponding to the UniqueHash */;
 label:
@@ -559,7 +559,7 @@ label:

 To check if a predicition is in the RSB, we linearly scan the RSB.

-```cpp
+```c++
 void EmitX64::EmitTerminalPopRSBHint(IR::Term::PopRSBHint, IR::LocationDescriptor initial_location) {
    using namespace Xbyak::util;

@@ -571,7 +571,7 @@ void EmitX64::EmitTerminalPopRSBHint(IR::Term::PopRSBHint, IR::LocationDescripto
    code->or_(rbx, rcx);

    code->mov(rax, u64(code->GetReturnFromRunCodeAddress()));
-    for (size_t i = 0; i < JitState::RSB_SIZE; ++i) {
+    for (size_t i = 0; i < JitState::RSBSize; ++i) {
        code->cmp(rbx, qword[code.ABI_JIT_PTR + offsetof(JitState, rsb_location_descriptors) + i * sizeof(u64)]);
        code->cmove(rax, qword[code.ABI_JIT_PTR + offsetof(JitState, rsb_codeptrs) + i * sizeof(u64)]);
    }
@@ -582,10 +582,10 @@ void EmitX64::EmitTerminalPopRSBHint(IR::Term::PopRSBHint, IR::LocationDescripto

 In pseudocode:

-```cpp
+```c++
 rbx := ComputeUniqueHash()
 rax := ReturnToDispatch
-for (i := 0 .. RSB_SIZE-1)
+for (i := 0 .. RSBSize-1)
    if (rbx == rsb_location_descriptors[i])
        rax = rsb_codeptrs[i]
 goto rax
@@ -3,20 +3,175 @@ Dynarmic

 A dynamic recompiler for ARM.

-*Note that an adversarial guest program [can determine if it's being ran under Dynarmic](#disadvantages-of-dynarmic). Preventing this is not a goal of this project.*
+Highlight features:

-Cortex-A57 (32 and 64 bit) is the emulated guest target. See [ArchVersion](../../src/dynarmic/src/dynarmic/interface/A32/arch_version.h).
+- Fast dynamic binary translation via Just-in-Time compilation
+- Clean API
+- Implemented in modern C++20
+- Hooks exposed for easy code instrumentation
+- Code injection support for very fine-grained instrumentation
+- Support for unusual address space setups (bring-your-own memory system)
+- Native support for most popular operating systems (Windows, macOS, Linux, FreeBSD, OpenBSD, NetBSD, Android)

-The only supported host architectures are x86-64, and AArch64. There are no plans to support any 32-bit architectures.
+*Please note that an adversarial guest program [can determine if it is being run under dynarmic](#disadvantages-of-dynarmic). Preventing this is not a goal of this project.*

-See [an example usage](../../src/dynarmic/tests/print_info.cpp).
+### Supported guest architectures
+
+* v3
+* v4
+* v4T
+* v5TE
+* v6K
+* v6T2
+* v7A
+* 32-bit v8
+* 64-bit v8
+
+You can specify the specific guest version using [ArchVersion](src/dynarmic/interface/A32/arch_version.h).
+
+There are no plans to support v1 or v2.
+
+### Supported host architectures
+
+* x86-64
+* AArch64
+
+There are no plans to support any 32-bit architecture.
+
+Important API Changes in v6.x Series
+------------------------------------
+
+* **v6.7.0**
+  * To support use cases where one wants to have the guest to have the same address space as the host, `nullptr` is now a valid value for `fastmem_pointer`.
+    **This change is not backwards-compatible.** If you were previously using `nullptr` to represent an invalid fastmem arena, you will now have to use `std::nullopt`.
+
+
+Documentation
+-------------

 Design documentation can be found at [./Design.md](./Design.md).

+
+Usage Example
+-------------
+
+The below is a minimal example. Bring-your-own memory system.
+
+```cpp
+#include <array>
+#include <cstdint>
+#include <cstdio>
+#include <exception>
+
+#include "dynarmic/interface/A32/a32.h"
+#include "dynarmic/interface/A32/config.h"
+
+using u8 = std::uint8_t;
+using u16 = std::uint16_t;
+using u32 = std::uint32_t;
+using u64 = std::uint64_t;
+
+class MyEnvironment final : public Dynarmic::A32::UserCallbacks {
+public:
+    u64 ticks_left = 0;
+    std::array<u8, 2048> memory{};
+
+    u8 MemoryRead8(u32 vaddr) override {
+        if (vaddr >= memory.size()) {
+            return 0;
+        }
+        return memory[vaddr];
+    }
+
+    u16 MemoryRead16(u32 vaddr) override {
+        return u16(MemoryRead8(vaddr)) | u16(MemoryRead8(vaddr + 1)) << 8;
+    }
+
+    u32 MemoryRead32(u32 vaddr) override {
+        return u32(MemoryRead16(vaddr)) | u32(MemoryRead16(vaddr + 2)) << 16;
+    }
+
+    u64 MemoryRead64(u32 vaddr) override {
+        return u64(MemoryRead32(vaddr)) | u64(MemoryRead32(vaddr + 4)) << 32;
+    }
+
+    void MemoryWrite8(u32 vaddr, u8 value) override {
+        if (vaddr >= memory.size()) {
+            return;
+        }
+        memory[vaddr] = value;
+    }
+
+    void MemoryWrite16(u32 vaddr, u16 value) override {
+        MemoryWrite8(vaddr, u8(value));
+        MemoryWrite8(vaddr + 1, u8(value >> 8));
+    }
+
+    void MemoryWrite32(u32 vaddr, u32 value) override {
+        MemoryWrite16(vaddr, u16(value));
+        MemoryWrite16(vaddr + 2, u16(value >> 16));
+    }
+
+    void MemoryWrite64(u32 vaddr, u64 value) override {
+        MemoryWrite32(vaddr, u32(value));
+        MemoryWrite32(vaddr + 4, u32(value >> 32));
+    }
+
+    void CallSVC(u32 swi) override {
+        // Do something.
+    }
+
+    void ExceptionRaised(u32 pc, Dynarmic::A32::Exception exception) override {
+        // Do something.
+    }
+
+    void AddTicks(u64 ticks) override {
+        if (ticks > ticks_left) {
+            ticks_left = 0;
+            return;
+        }
+        ticks_left -= ticks;
+    }
+
+    u64 GetTicksRemaining() override {
+        return ticks_left;
+    }
+};
+
+int main(int argc, char** argv) {
+    MyEnvironment env;
+    Dynarmic::A32::UserConfig user_config;
+    user_config.callbacks = &env;
+    Dynarmic::A32::Jit cpu{user_config};
+
+    // Execute at least 1 instruction.
+    // (Note: More than one instruction may be executed.)
+    env.ticks_left = 1;
+
+    // Write some code to memory.
+    env.MemoryWrite16(0, 0x0088); // lsls r0, r1, #2
+    env.MemoryWrite16(2, 0xE7FE); // b +#0 (infinite loop)
+
+    // Setup registers.
+    cpu.Regs()[0] = 1;
+    cpu.Regs()[1] = 2;
+    cpu.Regs()[15] = 0; // PC = 0
+    cpu.SetCpsr(0x00000030); // Thumb mode
+
+    // Execute!
+    cpu.Run();
+
+    // Here we would expect cpu.Regs()[0] == 8
+    printf("R0: %u\n", cpu.Regs()[0]);
+
+    return 0;
+}
+```
+
 Alternatives to Dynarmic
 ------------------------

-Here are some projects with the same goals as Dynarmic:
+Here are some projects with the same goals as dynarmic:

 * [Unicorn](https://www.unicorn-engine.org/) - Recompiling multi-architecture CPU emulator, based on QEMU
 * [SkyEye](http://skyeye.sourceforge.net) - Cached interpreter for ARM
@@ -34,8 +189,8 @@ More general alternatives:
 Disadvantages of Dynarmic
 -------------------------

-In the pursuit of speed, some behavior not commonly depended upon is elided. Hence this emulator doesn't match spec.
-Note that this would mean that a guest application can easily determine if it's being ran under instrumentation.
+In the pursuit of speed, some behavior not commonly depended upon is elided. Therefore this emulator does not match spec.
+Please note that this would mean that a guest application can easily determine if it is being run under instrumentation.

 Known examples:

@@ -50,6 +205,182 @@ Use this code base at your own risk.
 Legal
 -----

-Dynarmic is under a GPLv3 license, check the relevant file headers for more information.
+dynarmic is under a 0BSD license. See LICENSE.txt for more details.

-Dynarmic uses several open-source libraries, whose licenses are included inside thereof.
+dynarmic uses several other libraries, whose licenses are included below:
+
+### biscuit
+
+```
+Copyright 2021 Lioncash/Lioncache
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
+```
+
+### catch
+
+```
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+```
+
+### fmt
+
+```
+Copyright (c) 2012 - 2016, Victor Zverovich
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
+
+### mcl & oaknut
+
+```
+MIT License
+
+Copyright (c) 2022 merryhime <https://mary.rs>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+### unordered_dense
+
+```
+MIT License
+
+Copyright (c) 2022 Martin Leitner-Ankerl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+### xbyak
+
+```
+Copyright (c) 2007 MITSUNARI Shigeo
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+Neither the name of the copyright owner nor the names of its contributors may
+be used to endorse or promote products derived from this software without
+specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+THE POSSIBILITY OF SUCH DAMAGE.
+-----------------------------------------------------------------------------
+ソースコード形式かバイナリ形式か、変更するかしないかを問わず、以下の条件を満た
+す場合に限り、再頒布および使用が許可されます。
+
+ソースコードを再頒布する場合、上記の著作権表示、本条件一覧、および下記免責条項
+を含めること。
+バイナリ形式で再頒布する場合、頒布物に付属のドキュメント等の資料に、上記の著作
+権表示、本条件一覧、および下記免責条項を含めること。
+書面による特別の許可なしに、本ソフトウェアから派生した製品の宣伝または販売促進
+に、著作権者の名前またはコントリビューターの名前を使用してはならない。
+本ソフトウェアは、著作権者およびコントリビューターによって「現状のまま」提供さ
+れており、明示黙示を問わず、商業的な使用可能性、および特定の目的に対する適合性
+に関する暗黙の保証も含め、またそれに限定されない、いかなる保証もありません。
+著作権者もコントリビューターも、事由のいかんを問わず、 損害発生の原因いかんを
+問わず、かつ責任の根拠が契約であるか厳格責任であるか（過失その他の）不法行為で
+あるかを問わず、仮にそのような損害が発生する可能性を知らされていたとしても、
+本ソフトウェアの使用によって発生した（代替品または代用サービスの調達、使用の
+喪失、データの喪失、利益の喪失、業務の中断も含め、またそれに限定されない）直接
+損害、間接損害、偶発的な損害、特別損害、懲罰的損害、または結果損害について、
+一切責任を負わないものとします。
+```
@@ -1,65 +1,59 @@
 # AI Policy

-AI and LLM use is *strictly* prohibited within our codebase and surrounding community, including issues and comments. This includes using AI or LLMs to write docs/commit messages, debug issues, brainstorm ideas, research concepts, or search the codebase.
+Use at your peril.

- [AI Policy](#ai-policy)
-  - [Low-quality code](#low-quality-code)
-  - [Licensing concerns](#licensing-concerns)
-  - [Vibe-coding](#vibe-coding)
-  - [Commit messages](#commit-messages)
-  - [Miscellaneous concerns](#miscellaneous-concerns)
-  - [Unacceptable Use Examples](#unacceptable-use-examples)
-  - [Addendum: Commit Messages](#addendum-commit-messages)
+AI is a *tool*, not a replacement or catch-all solution. It is generally okay at a few *very specific* use cases:

-## Low-quality code
+- Automation of tedious changes where you have already made the pattern clear and done the necessary groundwork.
+- Conversion of code from one paradigm to another.

-AI is notorious for producing low-quality code; be it:
+For everything else, AI is subpar at best, and actively harmful at worst. In general, you are **heavily** encouraged to not use AI at all.

- nonfunctional,
- verbose/inefficient,
- breaking other parts of the codebase,
- or writing/architecting in a completely different style
+## Why?

-All code, AI or not, is held under a **strict standard of excellence**. AI/LLM-generated code will fail this test 10 times out of 10.
+AI is notorious for hallucinating facts out of thin air and sometimes outright lying to users. Additionally, code written by LLMs is often needlessly verbose and horrifically inefficient (not to mention the rather ridiculous level of over-commenting). The end result is often one of three things:

-## Licensing concerns
+- Completely nonfunctional code
+- Code that works, but is extraordinarily verbose or not nearly as efficient as it can be
+- Code that works well and is written well, but solves a different problem than was intended, or solves the same problem but in a completely incorrect way that will break other things horribly.

-This is an area of ongoing litigation, and as such is still very iffy. For the time being, know that allowing AI to ingest the codebase may end up with its copyleft code regurgitated into incompatibly-licensed proprietary or permissive software. For you, this means to **not** feed code into LLMs.
+Human-written code will, without exception, always be of infinitely higher quality when properly researched and implemented by someone familiar with *both* the surrounding code and the programming language in use. LLMs may produce a "good enough" result, but this result is often subpar.

-AI models may have also ingested AGPLv3 code, which is license-incompatible with our codebase.
+**All code is held under a STRICT STANDARD OF EXCELLENCE**. AI code is no different, and since it often produces subpar or outright terrible code, it will often fail to meet this excellence standard.

-## Vibe-coding
+On a lesser-known note, LLM outputs often contain unicode symbols such as emojis or the arrow symbol. Please don't put Unicode symbols in your code. It messes with many an IDE, and the three people viewing your code on Lynx will be very unhappy.

-Just don't. If you're not going to put the effort in to understand every line of code you wrote, neither will we, and your patch or pull request will be ignored.
+**Learn to code**. It's worth it, we promise!

-## Commit messages
+## Acceptable Use

-AI-generated commit messages are absolutely terrible, and your pull request or patch will immediately be rejected if you choose to do this. They are, quite simply, actively detrimental to our understanding of your changes, and if you're not willing to summarize the intent behind your changes, then we're not going to bother reading the code you wrote.
+As stated previously, AI is good in a few *very specific* cases. In these cases, it's usually fine to use AI, as long as you **explicitly provide notice that it was used**.

-Write concise, simple, and descriptive commit messages that actually convey the proper intent behind what your change is trying to do.
+- Anything directly outside of the realm of the code written in your PR or patch is none of our business.
+  - This primarily covers research.
+  - However, we *still* strongly discourage this for the reasons mentioned above.
+- Assistance with cleanups, and minor nitpicks/optimizations.
+  - This is still discouraged, but it's okay to occasionally use LLMs to catch any minor mistakes you made in your code.
+- Debugging
+  - In general, LLMs are not good at debugging, but if you solve a bug you're facing with help from an AI, and said fix **works properly**, then that's fine.

-See the [Addendum](#addendum-commit-messages) for an instance of how bad AI models are at commit messages.
+## Unacceptable Use

-## Miscellaneous concerns
-
- While many environmental concerns about AI are typically blown out of proportion, it *is* a legitimate issue, and should be taken into account.
- Many people have significant concerns over the ethics of AI usage due to inhumane and predatory behavior by large AI companies, particularly Anthropic and OpenAI. This can technically be avoided through the usage of local LLMs.
- LLMs have a tendency to add unicode characters (such as the arrow → and the em-dash — symbols) to their output, which can make viewing code or documents harder on command-line editors and viewers.
- Dedicated coding models--namely Claude--also like to add a lot of comments to overexplain every individual line of code it produces. This actually makes it *harder* to understand the code!
-
-## Unacceptable Use Examples
-
-Here are a few examples of unacceptable use:
+Well, everything else. But here are a few examples:

+- Commit messages
+  - LLMs are absolutely horrible at this. They are needlessly verbose, almost never catch the actual intent of the commit, and will almost always hallucinate false information about said changes.
+  - See the addendum for an example
 - Solving problems
  - Slapping a few files and a "please fix bug XYZ" into an LLM is a recipe for disaster that will pretty much never work.
- Fully AI-generated code, aka "vibecoding"
+- Fully AI-generated code
+  - This shouldn't need explaining. Do not do this under any circumstance, especially if you don't actually understand what's going on.
 - Writing code based on pseudo-instructions
  - If you don't know how to write code, don't. If you've figured out the root cause (preferably without feeding random files into an LLM) and actively know what's going on, provide information to other developers or friends of yours who have knowledge of the language and/or the codebase.

 ## Addendum: Commit Messages

-The patchset for pull request [#3422](https://git.eden-emu.dev/eden-emu/eden/pulls/3422) was fed into several LLMs to generate a commit message. One LLM produced the following:
+The patchset for pull request [#3422](https://git.eden-emu.dev/eden-emu/eden/pulls/3422) was fed into several LLMs to generate a commit message. All of them sucked, and not a single one caught on to what the commit actually did. For example:

 ```txt
 profile_manager: Refactor user deletion to use index instead of UUID
@@ -93,10 +87,10 @@ This is:

 - Needlessly verbose (nobody cares about most of these details)
 - Doesn't address the actual purpose of the PR (fixing a double-deletion bug in the profile manager)
- Has unicode arrows (this is bad for command-line editors)
- Uses corporate and word-salad language
+- Has unicode arrows
+- Uses overly corporate and, well, robotic language

-Another (code-oriented) LLM output the following:
+As another example:

 ```txt
 profile(manager/ui): switch to index-based deletion and unify removal logic
@@ -114,3 +108,5 @@ This consolidates profile removal behavior, fixes potential race conditions in t
 This has all of the same problems as the other one. Needlessly verbose, doesn't address *what* it actually fixes ("consolidates profile removal behavior"... okay, why? What does it fix?), etc. It even has the bonus of totally hallucinating the addition of a method!

 On a more "philosophical" note, LLMs tend to be geared towards *corporate language*, as that's what they're trained on. This is why AI-generated commit messages feel like "word salad", and typically pad out the commit message to make it *look* like a lot of things were changed (trust me, it's like that in the corporate world). They typically also drift towards unneeded buzzwords and useless implementation details.
+
+**Don't use AI for commit messages**.
@@ -2,42 +2,45 @@

 These are **not** stylistic guidelines, they're, for the most part, suggestions on how to architecture new systems or improve upon the existing codebase.

-## Foreword
+# Foreword

-Keep your code simple, efficient, and readable.
+Don't try to micro-optimize out of the get go, while yes, most of the code is pretty, subpar, most of these are aftertoughts and details that can be glossed over **generally**.

-## C++ guidelines
+Architectural issues are more important, for example an API returning a `std::string` is not as efficient as one that operates on `std::string_view` directly (cost of constructing an `std::string` w/o small-string optimization and all of that).
+
+Regardless of the details, try to keep things simple. As a general rule of thumb.
+
+# C++ guidelines

 Everyone has their own way of viewing good/bad C++ practices, my general outline:

 - At your disposal you may use `boost::container::static_vector<>` (beware it has a ctor/initialization cost which goes up the more elements you add).
-  - Or you may use `boost::container::small_vector<>` (which has an initialization cost as well, and will use extra book-keeping for heap, try to keep a balance).
+    - Or you may use `boost::container::small_vector<>` (which has an initialization cost as well, and will use extra book-keeping for heap, try to keep a balance).
 - Don't use `[[likely]]` or `[[unlikely]]`; PGO builds exist for that.
 - Don't use inline assembly to try to outsmart the compiler unless you're 100% sure the assembly you're writing is actually good.
-  - And if so, try to restructure your C++ code so the compiler vectorizes it/makes it better
-  - Or if that fails, use intrinsics instead of raw `asm volatile`.
+    - And if so, try to restructure your C++ code so the compiler vectorizes it/makes it better, right?
+    - Or if that fails, use intrinsics instead of raw `asm volatile`.
 - Use `std::optional<>` instead of `std::unique_ptr<>` if possible.
-  - `std::unique_ptr<>` carries indirection cost due to it being memory allocated on the heap.
-  - It isn't often that objects that contain `std::unique_ptr<>`, are allocated on the heap themselves, allocating even more things on the heap seems redundant.
+    - `std::unique_ptr<>` carries indirection cost due to it being memory allocated on the heap.
+    - It isn't often that objects that contain `std::unique_ptr<>`, are allocated on the heap themselves, allocating even more things on the heap seems redundant.
 - Avoid `std::recursive_mutex` at all costs.
-  - It's basically implemented as a linked list most of the time and has HEAVY performance penalties.
+    - It's basically implemented as a linked list most of the time and has HEAVY performance penalties.
 - Exploit the fact `std::atomic<uint32_t>/std::atomic<int32_t>` is basically free on most arches that matter.
-  - In x86_64, an atomic `uint32_t` is basically `mov [m32], r32`, which is essentially free/cheap.
+    - In x86_64, an atomic `uint32_t` is basically `mov [m32], r32`, which is essentially free/cheap.
 - Avoid template parameters unless you really need them.
-  - For small inline-able functions this is fine, for more complex ones, consider the generated assembly.
- Don't make your own memcpy/memset/strcpy/strncpy/etc.
-  - Seriously DON'T DO THIS. You will NOT beat the compiler.
-  - Nor 30 years of writing optimized `mem*`.
-  - If your code is slow, don't blame `mem*`, blame your code.
+    - For small inlineable functions this is fine, for more complex ones, please consider the generated assembly.
+- Dont make your own memcpy/memset/strcpy/strncpy/etc.
+    - Seriously DON'T DO THIS. You will NOT beat the compiler.
+    - Nor 30 years of writing optimized `mem*`.
+    - If your code is slow, don't blame `mem*`, blame your code.
 - Try to avoid using `virtual` since vtable indirection has a cost
 - Avoid `dynamic_cast` and `typeid` at all costs.
-  - The reason is because the project has `-fno-rtti` disabled by default, due to the costs of dynamic polymorphism.
+    - The reason is because the project has `-fno-rtti` disabled by default, due to the costs of dynamic polymorphism.
 - Always copy-on-value for objects with `sizeof(void *) >= sizeof(T) * 2`, i.e objects sized as 2 pointers or less, for bigger objects you can use ref/pointer as usual.
 - Try using move semantics instead of references, whenever possible.
- Function parameters are cheap. Don't be afraid to use as many as needed (API usability permitting).
+- Remember function parameters are extremelly cheap as fuck, don't be afraid to place upto 8 parameters on a given function.
 - Don't save a reference in structures of a parent object, i.e:
-
-    ```cpp
+    ```c++
    struct Child {
        Parent& parent;
        void Mehod() {
@@ -45,27 +48,23 @@ Everyone has their own way of viewing good/bad C++ practices, my general outline
        }
    };
    ```
-
-  - Instead you can do the following:
-
-    ```cpp
+    - Instead you can do the following:
+    ```c++
    struct Child {
        void Mehod(Parent& parent) {
            parent.Something();
        }
    };
    ```
+    - This reduces the amount of pointers you have lying around, and also works better because of the aforementioned cheapness of parameter functions.

-  - This reduces the amount of pointers you have lying around, and also works better because of the aforementioned cheapness of parameter functions.
+# Engineering guidelines

-## Engineering guidelines
+Coding isn't also writing stuff but architecturing stuff, consider the following:

-Programming, alongside the physical act of writing code, also consists of architecting the code you write into a coherent, maintainable system.
-
- Try to reduce your usage of dependencies
-  - Dependencies that are legitimately useful to have are few and far between.
-  - At the same time, NIHing your own implementations of widely adopted algorithms or standards can be quite subpar.
-  - For dependencies that are very large but contain something you need, consider cherry-picking the individual files it needs (or writing a smaller version of it)
- Try to rely less on indirection for architecting systems
-  - If the underlying HLE kernel emulation requires it, try making a solution that keeps things local
-    - For example, there isn't a need for file descriptors to each be a pointer, when they could be a fixed table size with elements that may be emplaced at will.
+- Try to reduce dependency on... dependencies
+    - While some dependencies are useful `boost::container` and `fmt` to name a few, remember each dependency added incurs a cost.
+    - It may also be subpar with a hand rolled implementation, biggest exemplar of this is `spirv-tools` providing subpar SPIRV optimizations in comparison to the in-house optimizer.
+- Try to rely less on indirection for architecturing systems
+    - If the underlying HLE kernel emulation requires it, try making a solution that keeps things local
+        - For example, there isn't a need for file descriptors to each be a pointer, when they could be a fixed table size with elements that may be emplaced at will.
@@ -0,0 +1,126 @@
+# Coding Style guidelines
+
+These are mostly "suggestions", if you feel like your code is readable, comprehensible to others; and most importantly doesn't result in unreadable spaghetti you're fine to go.
+
+But for new developers you may find that following these guidelines will make everything x10 easier.
+
+## Naming conventions
+
+Simply put, types/classes are named as `PascalCase`, same for methods and functions like `AddElement`. Variables are named `like_this_snake_case` and constants are `IN_SCREAMING_CASE`.
+
+Except for Qt MOC where `functionName` is preferred.
+
+Template typenames prefer short names like `T`, `I`, `U`, if a longer name is required either `Iterator` or `perform_action` are fine as well. Do not use names like `SS` as systems like solaris define it for registers, in general do not use any of the following for short names:
+
+- `SS`, `DS`, `GS`, `FS`: Segment registers, defined by Solaris `<ucontext.h>`
+- `EAX`, `EBX`, `ECX`, `EDX`, `ESI`, `EDI`, `ESP`, `EBP`, `EIP`: Registers, defined by Solaris.
+- `X`: Defined by some utility headers, avoid.
+- `_`: Defined by gettext, avoid.
+- `N`, `M`, `S`: Preferably don't use this for types, use it for numeric constants.
+- `TR`: Used by some weird `<ucontext.h>` whom define the Task Register as a logical register to provide to the user... (Need to remember which OS in specific).
+
+Macros must always be in `SCREAMING_CASE`. Do not use short letter macros as systems like Solaris will conflict with them; a good rule of thumb is >5 characters per macro - i.e `THIS_MACRO_IS_GOOD`, `AND_ALSO_THIS_ONE`.
+
+Try not using hungarian notation, if you're able.
+
+## Formatting
+
+Formatting is extremelly lax, the general rule of thumb is: Don't add new lines just to increase line count. The less lines we have to look at, the better. This means also packing densely your code while not making it a clusterfuck. Strike a balance of "this is a short and comprehensible piece of code" and "my eyes are actually happy to see this!". Don't just drop the entire thing in a single line and call it "dense code", that's just spaghetti posing as code. In general, be mindful of what other devs need to look at.
+
+Do not put if/while/etc braces after lines:
+
+```c++
+// no dont do this
+// this is more lines of code for no good reason (why braces need their separate lines?)
+// and those take space in someone's screen, cumulatively
+if (thing)
+{ //<--
+    some(); // ...
+} //<-- 2 lines of code for basically "opening" and "closing" an statment
+
+// do this
+if (thing) { //<-- [...] and with your brain you can deduce it's this piece of code
+             //    that's being closed
+    some(); // ...
+} //<-- only one line, and it's clearer since you know its closing something [...]
+
+// or this, albeit the extra line isn't needed (at your discretion of course)
+if (thing)
+    some(); // ...
+
+// this is also ok, keeps things in one line and makes it extremely clear
+if (thing) some();
+
+// NOT ok, don't be "clever" and use the comma operator to stash a bunch of statments
+// in a single line, doing this will definitely ruin someone's day - just do the thing below
+// vvv
+if (thing) some(), thing(), a2(a1(), y1(), j1()), do_complex_shit(wa(), wo(), ploo());
+// ... and in general don't use the comma operator for "multiple statments", EXCEPT if you think
+// that it makes the code more readable (the situation may be rare however)
+
+// Wow so much clearer! Now I can actually see what each statment is meant to do!
+if (thing) {
+    some();
+    thing();
+    a2(a1(), y1(), j1());
+    do_complex_shit(wa(), wo(), ploo());
+}
+```
+
+Brace rules are lax, if you can get the point across, do it:
+
+```c++
+// this is fine
+do {
+    if (thing) {
+        return 0;
+    }
+} while (other);
+
+// this is also ok --- albeit a bit more dense
+do if (thing) return 0; while (other);
+
+// ok as well
+do {
+    if (thing) return 0;
+} while (other);
+```
+
+There is no 80-column limit but preferably be mindful of other developer's readability (like don't just put everything onto one line).
+
+```c++
+// someone is going to be mad due to this
+SDL_AudioSpec obtained;
+device_name.empty() ? device = SDL_OpenAudioDevice(nullptr, capture, &spec, &obtained, false) : device = SDL_OpenAudioDevice(device_name.c_str(), capture, &spec, &obtained, false);
+
+// maybe consider this
+SDL_AudioSpec obtained;
+if (device_name.empty()) {
+    device = SDL_OpenAudioDevice(nullptr, capture, &spec, &obtained, false);
+} else {
+    device = SDL_OpenAudioDevice(device_name.c_str(), capture, &spec, &obtained, false);
+}
+
+// or this is fine as well
+SDL_AudioSpec obtained;
+device = SDL_OpenAudioDevice(device_name.empty() ? nullptr : device_name.c_str(), capture, &spec, &obtained, false);
+```
+
+A note about operators: Use them sparingly, yes, the language is lax on them, but some usages can be... tripping to say the least.
+
+```c++
+a, b, c; //<-- NOT OK multiple statments with comma operator is definitely a recipe for disaster
+return c ? a : b; //<-- OK ternaries at end of return statments are clear and fine
+return a, b; //<-- NOT OK return will take value of `b` but also evaluate `a`, just use a separate statment
+void f(int a[]) //<-- OK? if you intend to use the pointer as an array, otherwise just mark it as *
+```
+
+And about templates, use them sparingly, don't just do meta-templating for the sake of it, do it when you actually need it. This isn't a competition to see who can make the most complicated and robust meta-templating system. Just use what works, and preferably stick to the standard libary instead of reinventing the wheel. Additionally:
+
+```c++
+// NOT OK This will create (T * N * C * P) versions of the same function. DO. NOT. DO. THIS.
+template<typename T, size_t N, size_t C, size_t P> inline void what() const noexcept;
+
+// OK use parameters like a normal person, don't be afraid to use them :)
+template<typename T> inline void what(size_t n, size_t c, size_t p) const noexcept;
+```
@@ -0,0 +1,10 @@
+# Release Policy
+
+Release when lots of new changes and fixes. Hotfix if more bugs. Release candidate if lot of things to test. Simple as.
+
+## Checklist
+
+- [ ] Update Transifex
+- [ ] Test for regressions and bugs
+- [ ] Write a changelog
+- [ ] Ensure all platforms work
@@ -2,7 +2,7 @@

 Use this guide whenever you want to modify the Date or Time that Eden reports to games. This can be useful for modifying RNG elements, skipping wait times in games, etc.

-**[See here](https://evilperson1337.notion.site/Setting-a-Custom-Date-Time-in-Eden-2b357c2edaf680acb8d4e63ccc126564) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Setting-a-Custom-Date-Time-in-Eden-2b357c2edaf680acb8d4e63ccc126564) for a version of this guide with images & visual elements.**

 ---

@@ -14,7 +14,7 @@ Use this guide whenever you want to modify the Date or Time that Eden reports to

 ## Steps

-1. Navigate to *Emulation > Configure*.    
+1. Navigate to *Emulation → Configure*.    
 2. Click on the **System** item on the left-hand side navigation, then check the *Custom RTC Date* box.
 3. The Date/Time option now becomes editable. Set it to the value you want and hit **OK**.
 4. GREAT SCOTT! We have time traveled! You can of course go forward or backward in time (as long as it is not before the year 1970) and your game should update accordingly (e.g. certain *Super Mario Odyssey* moons that take time for flowers to grow will now be fully grown.).
@@ -44,7 +44,7 @@ Only Fedora/riscv64 has been tested, but in theory, every riscv64 distribution t

 ## Other

-Other architectures, such as SPARC, MIPS, PowerPC, Loong, and all 32-bit architectures are completely unsupported, as there is no JIT backend or emitter thereof. If you want support for it -- submit patches!
+Other architectures, such as SPARC, MIPS, PowerPC, Loong, and all 32-bit architectures are completely unsupported, as there is no JIT backend or emitter thereof. If you want support for it--submit patches!

 IA-64 (Itanium) support is completely unknown. Existing amd64 packages will not run on IA-64 (assuming you can even find a supported Windows/Linux distribution)

@@ -52,18 +52,18 @@ IA-64 (Itanium) support is completely unknown. Existing amd64 packages will not

 The vast majority of Eden's testing is done on Windows, Linux, and Android. However, first-class support is also provided for:

- FreeBSD (amd64, aarch64)
- HaikuOS (amd64)
- OpenBSD (amd64)
- NetBSD (amd64)
- macOS (aarch64)
- OpenIndiana aka. OpenSolaris (amd64)
+- HaikuOS
+- FreeBSD
+- OpenBSD
+- NetBSD
+- OpenIndiana (Solaris)
+- macOS

 ## Linux

 While all modern Linux distributions are supported (Fedora >40, Ubuntu >24.04, Debian >12, Arch, Gentoo, etc.), the vast majority of testing and development for Linux is on Arch and Gentoo. Most major build system changes are tested on Gentoo first and foremost, so if builds fail on any modern distribution no matter what you do, it's likely a bug and should be reported.

-Intel and NVIDIA GPU support is limited. AMD (RADV) drivers receive first-class testing and are known to provide the most stable Eden experience possible.
+Intel and Nvidia GPU support is limited. AMD (RADV) drivers receive first-class testing and are known to provide the most stable Eden experience possible.

 Wayland is not recommended. Testing has shown significantly worse performance on most Wayland compositors compared to X11, alongside mysterious bugs and compatibility errors. For now, set `QT_QPA_PLATFORM=xcb` when running Eden, or pass `-platform xcb` to the launch arguments.

@@ -73,25 +73,7 @@ Windows 10 and 11 are supported. Support for Windows 8.x is unknown, and Windows

 In order to run Eden, you will probably need to install the [Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).

-Neither AMD/NVIDIA drivers work nearly as well as Linux's RADV drivers. Compatibility is still largely the same, but performance and some hard-to-run games may suffer compared to Linux.
-
-Tacit support for down to XP is provided for interested hobbyists. Read below.
-
-### Windows 7, 8, 8.1
-
-DirectX 12 is not available - simply copy and paste any DLL and name it `d3d12.dll`.
-
-Install [Qt6 compatibility libraries](https://github.com/crystalidea/qt6windows7) specifically Qt 6.9.5.
-
-### Windows XP, Vista
-
-If you haven't already, install appropriate updates using [Legacy Update](https://legacyupdate.net/). We highly recommend to install [One-Core-API](https://github.com/shorthorn-project/One-Core-API-Binaries) as well.
-
-64-bit support is *mandatory*, there are no plans to add 32-bit support (PRs are welcome of course). While AVX2 support is recommended, it isn't a hard requirement. SSE4.1+ is recommended however, while the emulator does run well without (minimum is SSE3), non-SSE4.1 code paths are unmaintained.
-
-### Windows on ARM
-
-If you're using Snapdragon X or 8CX, use the [the Vulkan translation layer](https://apps.microsoft.com/detail/9nqpsl29bfff?hl=en-us&gl=USE) only if the stock drivers do not work. And of course always keep your system up-to-date.
+Neither AMD nor Nvidia drivers work nearly as well as Linux's RADV drivers. Compatibility is still largely the same, but performance and some hard-to-run games may suffer compared to Linux.

 ## Android

@@ -141,13 +123,13 @@ Do note that building the GUI version with Qt versions higher than 6.7.3 will ca

 ## *BSD, Solaris

-BSD and Solaris distributions tend to lag behind Linux in terms of Vulkan and ports. For example, OpenIndiana (Solaris) does not properly package Qt, meaning the recommended method of usage is to use `eden-cli` for now. Solaris also generally works better with OpenGL.
+BSD and Solaris distributions tend to lag behind Linux in terms of Vulkan and other library compatibility. For example, OpenIndiana (Solaris) does not properly package Qt, meaning the recommended method of usage is to use `eden-cli` only for now. Solaris also generally works better with OpenGL.

-AMD GPU support on these platforms is limited or nonexistent, bar for OpenBSD which has a dedicated AMD GPU stack.
+AMD GPU support on these platforms is limited or nonexistent.

 ## HaikuOS

-HaikuOS supports (see below) Vulkan 1.3 and has Mesa 24.0. Because OpenGL ES is used instead of the desktop flavour of OpenGL the OpenGL backend is actually worse than the Vulkan one in terms of stability and system support. OpenGL is highly not recommended due to it being out of tree builds of Mesa and generally unstable ones at that. Users are advised to use Vulkan instead.
+HaikuOS supports (see below) Vulkan 1.3 and has Mesa 24.0. Because OpenGL ES is used instead of the desktop flavour of OpenGL the OpenGL backend is actually worse than the Vulkan one in terms of stability and system support. OpenGL is highly not recommended due to it being: out of tree builds of Mesa and generally unstable ones at that. Users are advised to use Vulkan whenever possible.

 - Additionally system drivers for NVIDIA and Intel iGPUs exist and provide a native Vulkan ICD with the `Xcb` interface as opposed to the native `BView`
 - In order to obtain Vulkan 1.3 support with native `BView` support; Swiftshader can be compiled from source [see this thread](https://discuss.haiku-os.org/t/swiftshader-vulkan-software-renderer-on-haiku/11526/6).
@@ -22,8 +22,8 @@ If your GPU doesn't support or is just behind by a minor version, see Mesa envir
    - RC releases: Release candidate, generally "less stable but still stable" versions.
    - Full release: "The stablest possible you could get".
 - Nightly: Builds done around 2PM UTC (if there are any changes), generally stable, but not recommended for the average user. These contain daily updates and may contain critical fixes for some games.
- Master: Unstable builds, can range from games working exceptionally well to instantly crashing. These contain straight from the oven fixes, don't use them unless you plan to contribute something! They're very experimental! Still 95% of the time they will work just fine.
- PR builds: Highly experimental builds, testers may grab from these. The average user should treat them the same as master builds.
+- Master: Unstable builds, can lead from a game working exceptionally fine to absolute crashing in some systems because someone forgot to check if NixOS or Solaris worked. These contain straight from the oven fixes, please don't use them unless you plan to contribute something! They're very experimental! Still 95% of the time it will work just fine.
+- PR builds: Highly experimental builds, testers may grab from these. The average user should treat them the same as master builds, except sometimes they straight up don't build/work.

 ## User configuration

@@ -36,7 +36,7 @@ Eden will store configuration files in the following directories:
 - **Linux, macOS, FreeBSD, Solaris, OpenBSD**: `$XDG_DATA_HOME`, `$XDG_CACHE_HOME`, `$XDG_CONFIG_HOME`.
 - **HaikuOS**: `/boot/home/config/settings/eden`

-If a `user` directory is present in the current working directory, that will override all global configuration directories and the emulator will use the `user` directory instead.
+If a `user` directory is present in the current working directory, that will override all global configuration directories and the emulator will use that instead.

 ### Environment variables

@@ -64,4 +64,4 @@ Then just running `chmod +x script.sh && source script.sh`.

 ## Compatibility list

-Eden doesn't maintain a compatibility list. However, [EmuReady](https://www.emuready.com/) has a more fine-grained compatibility information for multiple emulators/forks as well.
+Eden doesn't mantain a compatibility list. However, [EmuReady](https://www.emuready.com/) has a more fine-grained compatibility information for multiple emulators/forks as well.
@@ -12,7 +12,7 @@ If they don't run - then that's a bug!

 ## Atmosphere

-Fusee-Galee, the bootloader and other low-level mechanisms are not emulated at the moment.
+Fusee Galee, the bootloader and other low-level mechanisms are not emulated at the moment.

 Having OFW is recommended, but may not be required (untested).

@@ -4,7 +4,7 @@ There are two main applications, an SDL-based app (`eden-cli`) and a Qt based ap

 ## eden

- `./eden <path>`: Running with a single argument and nothing else, will make the emulator look for the given file and load it, this behavior is similar to `eden-cli`; allows dragging and dropping games into the application.
+- `./eden <path>`: Running with a single argument and nothing else, will make the emulator look for the given file and load it, this behaviour is similar to `eden-cli`; allows dragging and dropping games into the application.
 - `-g <path>`: Alternate way to specify what to load, overrides. However let it be noted that arguments that use `-` will be treated as options/ignored, if your game, for some reason, starts with `-`, in order to safely handle it you may need to specify it as an argument.
 - `-f`: Use fullscreen.
 - `-u <number>`: Select the index of the user to load as.
@@ -27,6 +27,3 @@ There are two main applications, an SDL-based app (`eden-cli`) and a Qt based ap
 - `--user/-u`: Specify the user index.
 - `--version/-v`: Display version and quit.
 - `--input-profile/-i`: Specifies input profile name to use (for player #0 only).
- `--null-render/-n`: Forces the usage of the "Null" render backend irrespective of settings.
- `--filter/-x`: Sets the debug log filter irrespective of settings.
- `--singlecore/-s`: Forces single-core regardless of settings.
@@ -1,12 +1,12 @@
 # User Handbook - Controllers

-Most of the controls should work out of the box. If not, use a joystick calibrator to ensure it's not an issue with your own controller, for example:
+Most of the controls should work out of the box. If not, please use a joystick calibrator to ensure it's not an issue with your own controller, for example:

 - https://github.com/dkosmari/calibrate-joystick

 ## Using external controllers on the Steamdeck

-In desktop mode ignore your Pro controller/XBOX controller external controller and use **Steam Virtual Gamepad 0 as Player 1**. If you have multiple external controllers set **Player 2 to Steam Virtual Gamepad 1**. Steam app must not be closed on desktop mode.
+In desktop mode ignore your pro controller/xbox contoller external controller and use **Steam Virtual Gamepad 0 as Player 1**. If you have multiple external controllers set **Player 2 to Steam Virtual Gamepad 1**. Steam app must not be closed on desktop mode.

 Here's the annoying part of it. When waking up the steam deck from sleep try not to touch any button on the Steamdeck and turn on your external controller. Then open the Eden.AppImage. If you're lucky you can get your external controller to be position 0 and also Steam Virtual Gamepad 0 in desktop mode. If not that is ok too unless you need to configure player 1 to have gyro. You might need to repeat this to get your external controller as Steam Virtual Gamepad 0 so you can config Player 1 having gyro. You might be able to config player 1 to have gyro with the Steamdeck itself. Or you can also config player 1, 2, 3, etc, to have gyro somehow. Make sure they are all using Virtual Gamepads though.

@@ -18,7 +18,7 @@ Basically the Steamdeck or the external controller is fighting for position 0 an

 Use this guide for when you want to configure specific controller settings to be reused.

-**[See here](https://evilperson1337.notion.site/Configuring-Controller-Profiles-2be57c2edaf680eabc3ac8c333ec75c4) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Configuring-Controller-Profiles-2be57c2edaf680eabc3ac8c333ec75c4) for a version of this guide with images & visual elements.**

 ---

@@ -30,8 +30,8 @@ Use this guide for when you want to configure specific controller settings to be

 #### Steps
 1. Launch Eden and wait for it to load.
-2. Navigate to `Emulation > Configure...`
-3. Select **Controls** from the left-hand menu and configure your controller for the way you want it to be in-game.
+2. Navigate to *Emulation > Configure…*
+3. Select **Controls** from the left-hand menu and configure your controller for the way you want it to be in game.
 4. Select **New** and enter a name for the profile in the box that appears. Press **OK** to save the profile settings.
 5. Select **OK** to close the settings menu.

@@ -39,7 +39,7 @@ Use this guide for when you want to configure specific controller settings to be

 Use this guide when you want to set up specific controller profiles for specific games. This can be useful for certain games like *Captain Toad Treasure Tracker* where a blue dot appears in the middle of the screen when you have docked mode enabled, but not handheld mode.

-**[See here](https://evilperson1337.notion.site/Setting-Controller-Profiles-By-Game-2b057c2edaf681658a57f0c199cb6083) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Setting-Controller-Profiles-By-Game-2b057c2edaf681658a57f0c199cb6083) for a version of this guide with images & visual elements.**

 ---

@@ -47,6 +47,7 @@ Use this guide when you want to set up specific controller profiles for specific

 - Eden Emulator set up and fully configured
 - Controller Profile Created
+    - See [*Configuring Controller Profiles*](./ControllerProfiles.md) for instructions on how to do this if needed.

 ---

@@ -100,7 +100,7 @@ HaikuOS bundles a Mesa library that doesn't support full core OpenGL 4.6 (requir
 ### Fixes for Windows 10 and above having "Device loss"

 Run the following batch script *inside* the Eden folder:
-```bat
+```cmd
@echo off
 pushd "%~dp0"
 if exist "%temp%\FixFullScreen.reg" (
@@ -1,7 +1,7 @@
 # Getting Gyro/Motion Controls Working on Steam Deck
 Use this guide when you want to use the Steam Deck's native gyro functionality for motion controls in Eden.

-**[See here](https://evilperson1337.notion.site/Getting-Gyro-Motion-Controls-Working-on-Steam-Deck-2b057c2edaf681a1aaade35db6e0fd1b) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Getting-Gyro-Motion-Controls-Working-on-Steam-Deck-2b057c2edaf681a1aaade35db6e0fd1b) for a version of this guide with images & visual elements.**

 ## Steamdeck

@@ -16,14 +16,14 @@ Use this guide when you want to use the Steam Deck's native gyro functionality f
 ### Steps

 1. Go into Steam Deck's Desktop Mode, and use the shortcut to launch EmuDeck.
-2. Install [SteamDeckGyroDSU](https://github.com/kmicki/SteamDeckGyroDSU/releases) by going to *3rd Party Tools > Gyroscope* and clicking **Install.**
+2. Install [SteamDeckGyroDSU](https://github.com/kmicki/SteamDeckGyroDSU/releases) by going to *3rd Party Tools > Gyroscope* and clicking **Install.**
    a. Alternatively you can install [SteamDeckGyroDSU](https://github.com/kmicki/SteamDeckGyroDSU/releases) manually following the GitHub page instructions. 
 3. Upon completion of the installation. You will need to reboot your Steam Deck.  Do so before continuing on.
 4. Go back into the Steam Deck Desktop Mode and open the Dolphin File Explorer.
-5. Navigate to the following directory to see you controller configuration: `/home/deck/.config/Eden`
-6. *Right-Click* the **qt-config.ini** file and open it with ***Kate***
-7. Look for the following line: `player_0_motionleft=[empty]`.
-8. Change the line to now say: `player_0_motionleft="motion:0,pad:0,port:26760,guid:0000000000000000000000007f000001,engine:cemuhookudp"`
+5. Navigate to the following directory to see you controller configuration: `/home/deck/.config/Eden`
+6. *Right-Click* the **qt-config.ini** file and open it with ***Kate***
+7. Look for the following line: `player_0_motionleft=[empty]`.
+8. Change the line to now say: `player_0_motionleft="motion:0,pad:0,port:26760,guid:0000000000000000000000007f000001,engine:cemuhookudp"`
 9. Save the file and open Eden.
-10. Launch a compatible title, like *The Legend of Zelda: Breath of the Wild*.
-11. Test the gyro capabilities, for the above mentioned title, it is accessed by holding down the **R Trigger** and moving the Steam Deck around.
+10. Launch a compatible title, like *The Legend of Zelda: Breath of the Wild*.
+11. Test the gyro capabilities, for the above mentioned title, it is accessed by holding down the **R Trigger** and moving the Steam Deck around.
@@ -2,7 +2,7 @@

 Use this when you need to review the logs to determine an issue or provide them to a member of the Eden team.

-**[See here](https://evilperson1337.notion.site/How-to-Access-Logs-2b057c2edaf68105a281fe1688a332d4) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/How-to-Access-Logs-2b057c2edaf68105a281fe1688a332d4) for a version of this guide with images & visual elements.**

 ---

@@ -2,7 +2,7 @@

 Use this guide when you want to manually import save files for use in the Eden emulator.

-**[See here](https://evilperson1337.notion.site/Importing-Saves-Into-Eden-2b057c2edaf681fe968df8d63821ccae) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Importing-Saves-Into-Eden-2b057c2edaf681fe968df8d63821ccae) for a version of this guide with images & visual elements.**

 ### Pre-Requisites
 - Eden emulator already set up and configured.
@@ -2,7 +2,7 @@

 Use this guide for when you want to install an Atmosphere-based mod for use in Eden.

-**[See here](https://evilperson1337.notion.site/Installing-Atmosphere-Mods-2b057c2edaf681fe8d39cbfc2d0cc799) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Installing-Atmosphere-Mods-2b057c2edaf681fe8d39cbfc2d0cc799) for a version of this guide with images & visual elements.**

 ---

@@ -4,11 +4,11 @@ Use this guide when you want to install Updates or DLC for your games in Eden.

 <aside>

-***NOTE***: This applies to separate Update/DLC files, not "merged" NSP/XCI's which include the base game and Updates/DLC applied on top of them in a single file.  These files work in Eden, but would not require the following steps.
+***NOTE***: This applies to separate Update/DLC files, not “merged” NSP/XCI’s which include the base game and Updates/DLC applied on top of them in a single file.  These files work in Eden, but would not require the following steps.

 </aside>

-**[See here](https://evilperson1337.notion.site/Working-with-Updates-DLC-in-Eden-2b057c2edaf681dfb65dfc4dd96980c0) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Working-with-Updates-DLC-in-Eden-2b057c2edaf681dfb65dfc4dd96980c0) for a version of this guide with images & visual elements.**

 ---

@@ -4,13 +4,13 @@ Use this guide to answer questions regarding and to start using the multiplayer
 ## Multiplayer FAQ
 This FAQ will serve as a general quick question and answer simple questions.

-**[See here](https://evilperson1337.notion.site/Multiplayer-FAQ-2c357c2edaf680fca2e9ce59969a220f) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Multiplayer-FAQ-2c357c2edaf680fca2e9ce59969a220f) for a version of this guide with images & visual elements.**

 ### Can Eden Play Games with a Switch Console?
 No - The only emulator that has this kind of functionality is *Ryujinx* and it's forks.  This solution requires loading a custom module on a modded switch console to work.

 ### Can I Play Online Games?
-No - This would require hijacking requests to Nintendo's official servers to a custom server infrastructure built to emulate that functionality.  This is how services like [*Pretendo*](https://pretendo.network/) operate.  As such, you would not be able to play "Online", you can however play multiplayer games.
+No - This would require hijacking requests to Nintendo's official servers to a custom server infrastructure built to emulate that functionality.  This is how services like [*Pretendo*](https://pretendo.network/) operate.  As such, you would not be able to play “Online”, you can however play multiplayer games.

 ### What's the Difference Between Online and Multiplayer?
 I have chosen the wording carefully here for a reason.  
@@ -21,7 +21,7 @@ I have chosen the wording carefully here for a reason.
 The rule of thumb here is simple: If a game supports the ability to communicate without a server (Local Wireless, LAN, etc.) you will be able to play with other users.  If it requires a server to function - it will not.  You will need to look up if your title support Local Wireless/LAN play as an option.

 ### How Does Multiplayer Work on Eden Exactly?
-Eden's multiplayer works by emulating the Switch's local wireless (LDN) system, then tunneling that traffic over the internet through "rooms" that act like lobbies. Each player runs their own instance of the emulator, and as long as everyone joins the same room and the game supports local wireless multiplayer, the emulated consoles see each other as if they were on the same local network. This design avoids typical one-save netplay issues because every user keeps an independent save and console state while only the in-game wireless packets are forwarded through the room server.  In practice, you pick or host a room, configure your network interface/port forwarding if needed, then launch any LDN-capable game; from the game's perspective it is just doing standard local wireless, while the emulator handles discovery and communication over the internet or LAN.
+Eden's multiplayer works by emulating the Switch's local wireless (LDN) system, then tunneling that traffic over the internet through “rooms” that act like lobbies. Each player runs their own instance of the emulator, and as long as everyone joins the same room and the game supports local wireless multiplayer, the emulated consoles see each other as if they were on the same local network. This design avoids typical one-save netplay issues because every user keeps an independent save and console state while only the in-game wireless packets are forwarded through the room server.  In practice, you pick or host a room, configure your network interface/port forwarding if needed, then launch any LDN-capable game; from the game's perspective it is just doing standard local wireless, while the emulator handles discovery and communication over the internet or LAN.

 ### What Do I Need to Do?
 That depends entirely on what your goal is and your level of technical ability, you have a 2 options on how to proceed.  
@@ -40,7 +40,7 @@ While it would be nice if everything always worked perfectly - that is not reali
 1. Emulator Version Mismatches
    1. Occasionally updates to the emulator of choice alter how the LDN functionality is handled.  In these situations, unexpected behavior can occur when trying to establish LDN connections.  This is a good first step to check if you are having issues playing a game together, but can join the same lobby without issue.
 2. Game Version Mismatches
-    1. It is best practice to have the game version be identical to each other in order to ensure that there is no difference in how the programs are handling the LDN logic.  Games are black boxes that the dev team can't see into to ensure the logic handling operates the same way.  For this reason, it is highly advised that the game versions match across all the players.  This would be a good 2nd step to check if you are having issues playing a game together, but can join the same lobby without issue.
+    1. It is best practice to have the game version be identical to each other in order to ensure that there is no difference in how the programs are handling the LDN logic.  Games are black boxes that the dev team cannot see into to ensure the logic handling operates the same way.  For this reason, it is highly advised that the game versions match across all the players.  This would be a good 2nd step to check if you are having issues playing a game together, but can join the same lobby without issue.
 3. Latency
    1. Because this implementation is emulating a LAN/Local Wireless connection - it is extremely sensitive to network latency and drops.  Eden has done a good job of trying to account for this and not immediately drop users out - but it is not infallible.  If latency is a concern or becomes an issue - consider hosting a room.

@@ -49,7 +49,7 @@ While it would be nice if everything always worked perfectly - that is not reali
 ## Joining a Multiplayer Room
 Use this when you need to connect to a multiplayer room for LDN functionality inside of Eden.  This does not cover how to host a room, only joining existing ones.

-**[See here](https://evilperson1337.notion.site/Access-Your-Multiplayer-Room-Externally-2c357c2edaf681c0ab2ce2ee624d809d) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Access-Your-Multiplayer-Room-Externally-2c357c2edaf681c0ab2ce2ee624d809d) for a version of this guide with images & visual elements.**

 ### Pre-Requisites
 - Eden set up and functioning
@@ -66,12 +66,12 @@ There are 2 primary methods that you can use to connect to an existing room, dep

 <aside>

-***NOTE:*** Just because a lobby appears on the public lobby list, does not mean that the host has properly configured the necessary port forwarding/firewall rules to allow a connection.  If you can't connect to a lobby, move onto another entry as the issue is probably not on your end.  Start looking at your environment if you are unable to connect to multiple/any lobbies.
+***NOTE:*** Just because a lobby appears on the public lobby list, does not mean that the hoster has properly configured the necessary port forwarding/firewall rules to allow a connection.  If you cannot connect to a lobby, move onto another entry as the issue is probably not on your end.  Start looking at your environment if you are unable to connect to multiple/any lobbies.

 </aside>

 ## Joining a Public Lobby
-1. Open Eden and navigate to *Multiplayer > Browse Public Game Lobby*.
+1. Open Eden and navigate to *Multiplayer → Browse Public Game Lobby*.
 2. The **Public Room Browser** will now open and display a list of publicly accessible rooms.  Find one you want to connect to and double click it.
    
    <aside>
@@ -82,10 +82,10 @@ There are 2 primary methods that you can use to connect to an existing room, dep
 3. You will now see a window showing everyone on the lobby, or an error message.

 ### Direct Connecting to a Room
-If the host has not made the lobby public, or you don't want to find it in the public game browser - use this option to connect.
+If the hoster has not made the lobby public, or you don't want to find it in the public game browser - use this option to connect.

-1. Open Eden and navigate to *Multiplayer > Direct Connect*.
-2. Enter the *Server Address, Port*, *Nickname* (what your user will be called in the room), and a *Password* (if the host set one, otherwise leave it blank) and hit **Connect.**
+1. Open Eden and navigate to *Multiplayer → Direct Connect*.
+2. Enter the *Server Address, Port*, *Nickname* (what your user will be called in the room), and a *Password* (if the hoster set one, otherwise leave it blank) and hit **Connect.**
 3. You will now see a window showing everyone on the lobby, or an error message.

 ---
@@ -93,7 +93,7 @@ If the host has not made the lobby public, or you don't want to find it in the p
 ## Hosting a Multiplayer Room
 Use this guide for when you want to host a multiplayer lobby to play with others in Eden.  In order to have someone access the room from outside your local network, see the *Access Your Multiplayer Room Externally* section for next steps.

-**[See here](https://evilperson1337.notion.site/Hosting-a-Multiplayer-Room-2c357c2edaf6819481dbe8a99926cea2) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Hosting-a-Multiplayer-Room-2c357c2edaf6819481dbe8a99926cea2) for a version of this guide with images & visual elements.**

 ### Pre-Requisites
 - Eden set up and Functioning
@@ -101,7 +101,7 @@ Use this guide for when you want to host a multiplayer lobby to play with others
 - Ability to allow programs through the firewall on your device.

 ### Steps
-1. Open Eden and navigate to *Emulation > Multiplayer > Create Room.*    
+1. Open Eden and navigate to *Emulation → Multiplayer → Create Room.*    
 2. Fill out the following information in the popup dialog box.
    
    
@@ -123,7 +123,7 @@ Use this guide for when you want to host a multiplayer lobby to play with others
 ## Access Your Multiplayer Room Externally
 Quite often the person with whom you want to play is located off of your internal network (LAN).  If you want to host a room and play with them you will need to get your devices to communicate with each other.  This guide will go over your options on how to do this so that you can play together.

-**[See here](https://evilperson1337.notion.site/Access-Your-Multiplayer-Room-Externally-2c357c2edaf681c0ab2ce2ee624d809d) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Access-Your-Multiplayer-Room-Externally-2c357c2edaf681c0ab2ce2ee624d809d) for a version of this guide with images & visual elements.**

 ### Pre-Requisites
 - Eden set up and Functioning
@@ -137,14 +137,14 @@ Quite often the person with whom you want to play is located off of your interna
    
    <aside>
    
-    Use this option if you want the greatest performance/lowest latency, don't want to install any software, and have the ability to modify your networking equipment's configuration (most notably - your router). Avoid this option if you can't modify your router's configuration or are uncomfortable with looking up things on your own.
+    Use this option if you want the greatest performance/lowest latency, don't want to install any software, and have the ability to modify your networking equipment's configuration (most notably - your router).  Avoid this option if you cannot modify your router's configuration or are uncomfortable with looking up things on your own.
    
    </aside>
    

 Port forwarding is a networking technique that directs incoming traffic arriving at a specific port on a router or firewall to a designated device and port inside a private local network. When an external client contacts the public IP address of the router on that port, the router rewrites the packet's destination information (IP address and sometimes port number) and forwards it to the internal host that is listening on the corresponding service. This allows services such as web servers, game servers, or remote desktop sessions hosted behind NAT (Network Address Translation) to be reachable from the wider Internet despite the devices themselves having non-routable private addresses.

-The process works by creating a static mapping-often called a "port-forward rule"-in the router's configuration. The rule specifies three pieces of data: the external (public) port, the internal (private) IP address of the target machine, and the internal port on which that machine expects the traffic. When a packet arrives, the router checks its NAT table, matches the external port to a rule, and then translates the packet's destination to the internal address before sending it onward. Responses from the internal host are similarly rewritten so they appear to come from the router's public IP, completing the bidirectional communication loop. This mechanism enables seamless access to services inside a protected LAN without exposing the entire network. 
+The process works by creating a static mapping—often called a “port-forward rule”—in the router's configuration. The rule specifies three pieces of data: the external (public) port, the internal (private) IP address of the target machine, and the internal port on which that machine expects the traffic. When a packet arrives, the router checks its NAT table, matches the external port to a rule, and then translates the packet's destination to the internal address before sending it onward. Responses from the internal host are similarly rewritten so they appear to come from the router's public IP, completing the bidirectional communication loop. This mechanism enables seamless access to services inside a protected LAN without exposing the entire network. 

 For our purposes we would pick the port we want to expose (*e.g. 24872*) and we would access our router's configuration and create a port-forward rule to send the traffic from an external connection to your local machine over our specified port (*24872)*.  The exact way to do so, varies greatly by router manufacturer - and sometimes require contacting your ISP to do so depending on your agreement.  You can look up your router on [*portforward.com*](https://portforward.com/router.htm) which may have instructions on how to do so for your specific equipment.  If it is not there, you will have to use Google/ChatGPT to determine the steps for your equipment.

@@ -155,12 +155,12 @@ Remember you can't have one port open for multiple devices at the same time - yo
    
    <aside>
    
-    Use this option if you don't want to have to worry about other users machine/configuration settings, but also can't do port forwarding. This will still require that you as the host install a program and sign up for an account - but will prevent you from having to deal with port forwards or networking equipment. Avoid this option if there is not a close relay and you are getting issues with latency.
+    Use this option if you don't want to have to worry about other users machine/configuration settings, but also cannot do port forwarding.  This will still require that you as the hoster install a program and sign up for an account - but will prevent you from having to deal with port forwards or networking equipment. Avoid this option if there is not a close relay and you are getting issues with latency.
    
    </aside>
    

-Using a Tunnelling service may be the solution to avoid port forward, but also avoid worrying about your users setup. A tunnelling service works by having a lightweight client run on the machine that hosts the game server. That client immediately opens an **outbound** encrypted connection (typically over TLS/QUIC) to a relay node operated by the tunnel provider's cloud infrastructure. Because outbound traffic is almost always allowed through NAT routers and ISP firewalls, the tunnel can be established even when the host sits behind carrier-grade NAT or a strict firewall. The tunnel provider then assigns a public address (e.g., `mygame.playit.gg:12345`). When a remote player connects to that address, the traffic reaches the the tunnel provider relay, which forwards it through the already-established tunnel back to the client on the private network, and finally onto the local game server's port. In effect, the server appears to the Internet as if it were listening on the public address, while the host never needs to configure port-forwarding rules or expose its own IP directly.
+Using a Tunnelling service may be the solution to avoid port forward, but also avoid worrying about your users setup. A tunnelling service works by having a lightweight client run on the machine that hosts the game server. That client immediately opens an **outbound** encrypted connection (typically over TLS/QUIC) to a relay node operated by the tunnel provider's cloud infrastructure. Because outbound traffic is almost always allowed through NAT routers and ISP firewalls, the tunnel can be established even when the host sits behind carrier-grade NAT or a strict firewall. The tunnel provider then assigns a public address (e.g., `mygame.playit.gg:12345`). When a remote player connects to that address, the traffic reaches the the tunnel provider relay, which forwards it through the already-established tunnel back to the client on the private network, and finally onto the local game server's port. In effect, the server appears to the Internet as if it were listening on the public address, while the host never needs to configure port-forwarding rules or expose its own IP directly.

 For our purposes we would spawn the listener for the port that way chose when hosting our room.  The user would connect to our assigned public address/port combination, and it would be routed to our machine.  The tunnel must remain active for as long as you want the connection to remain open.  Closing the terminal will kill the tunnel and disconnect the users.

@@ -193,7 +193,7 @@ The VPN solution is a good compromise between the tunnelling solution and port f
 ## Finding the Server Information for a Multiplayer Room
 Use this guide when you need to determine the connection information for the Public Multiplayer Lobby you are connected to.

-**[See here](https://evilperson1337.notion.site/Finding-the-Server-Information-for-a-Multiplayer-Room-2c557c2edaf6809e94e8ed3429b9eb26) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Finding-the-Server-Information-for-a-Multiplayer-Room-2c557c2edaf6809e94e8ed3429b9eb26) for a version of this guide with images & visual elements.**

 ### Pre-Requisites
 - Eden set up and configured
@@ -204,7 +204,7 @@ Use this guide when you need to determine the connection information for the Pub
 ### Method 1: Grabbing the Address from the Log File
 1. Open Eden and Connect to the room you want to identify.
    1. See the *Joining a Multiplayer Room* section for instructions on how to do so if you need them.
-2. Go to *File > Open Eden Folder*, then open the **config** folder.
+2. Go to *File → Open Eden Folder*, then open the **config** folder.
 3. Open the the **qt-config.ini** file in a text editor.
 4. Search for the following keys: 
    1. `Multiplayer\ip=` 
@@ -256,7 +256,7 @@ Use this guide when you need to determine the connection information for the Pub
 ## Multiplayer for Local Co-Op Games
 Use this guide when you want to play with a friend on a different system for games that only support local co-op.

-**[See here](https://evilperson1337.notion.site/Multiplayer-for-Local-Co-Op-Games-2c657c2edaf680c59975ec6b52022a2d) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Multiplayer-for-Local-Co-Op-Games-2c657c2edaf680c59975ec6b52022a2d) for a version of this guide with images & visual elements.**

 Occasionally you will want to play a game with a friend on a game that does not support LDN multiplayer, and only offer local co-op (multiple controllers connected to a single console), such as with *New Super Mario Bros. U Deluxe.*  Emulation solutions have developed 2 primary methods for handling these cases.

@@ -286,7 +286,7 @@ This guide will assume you are the one hosting the game and go over things *Pars
    2. If you are joining a game, you will have to send a connection request the host will have to accept.
 3. Verify that the remote player can see the screen and that there is no issues with the connection.
 4. Launch Eden.
-5. Navigate to *Emulation > Configure*.
+5. Navigate to *Emulation → Configure*.
 6. Select the **Controls** tab.
 7. Set up your controller, if necessary.
 8. Select the **Player 2** tab and select the **Connect Controller** checkbox.  This enables inputs from another device to be seen as a second controller.
@@ -1,9 +1,9 @@
 # User Handbook - Native Application Development

-Debugging on physical hardware can get tedious and time consuming. Users are empowered with the debugging capabilities of the emulator to ensure their applications run as-is on the system. To the greatest extent possible at least.
+Debugging on physical hardware can get tedious and time consuming. Users are empowered with the debugging capabilities of the emulator to ensure their applications run as-is on the system. To the greatest extent possible atleast.

 ## Debugging

 **Standard key prefix**: Allows to redirect the key manager to a file other than `prod.keys` (for example `other` would redirect to `other.keys`). This is useful for testing multiple keysets. Default is `prod`.

-**Changing serial**: Very basic way to set debug values for the serial (and battery number). Developers do not need to write the full serial as only the first digits (excluding the last) will be accounted for. Region settings will affect the generated serial. The serial corresponds to a non-OLED/Lite console.
+**Changing serial**: Very basic way to set debug values for the serial (and battery number). Developers do not need to write the full serial as only the first digits (excluding the last) will be accoutned for. Region settings will affect the generated serial. The serial corresponds to a non-OLED/Lite console.
@@ -2,7 +2,7 @@

 Use this guide to get starting using the Eden emulator.

-**[See here](https://evilperson1337.notion.site/Eden-Quick-Start-2b057c2edaf6817b9859d8bcdb474017) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Eden-Quick-Start-2b057c2edaf6817b9859d8bcdb474017) for a version of this guide with images & visual elements.**

 ## Windows

@@ -33,12 +33,12 @@ Use this guide to get starting using the Eden emulator.
    
    <aside>

-    ***INFO***: You may get a "*Windows protected your PC"* SmartScreen message that appears.  This is just Windows Defender saying it did not recognize the application and did not run it - Eden is completely safe.  Click **More info** and then **Run anyway** to dismiss this message.
+    ***INFO***: You may get a “*Windows protected your PC”* SmartScreen message that appears.  This is just Windows Defender saying it did not recognize the application and did not run it - Eden is completely safe.  Click **More info** and then **Run anyway** to dismiss this message.
    
    </aside>
 4. Eden will now launch and notify you about missing Decryption keys. Close the dialog box by hitting **OK**.
-5. Navigate to **Tools > Install Decryption Keys**, navigate to the folder containing your key files and select the file, you should only be able to select one.
-6. Navigate to **Tools > Install Firmware**, *Select **From Folder*** or ***From ZIP*** - depending on how your firmware is stored, navigate to where it is stored and select it.    
+5. Navigate to **Tools → Install Decryption Keys**, navigate to the folder containing your key files and select the file, you should only be able to select one.
+6. Navigate to **Tools → Install Firmware**, *Select **From Folder*** or ***From ZIP*** - depending on how your firmware is stored, navigate to where it is stored and select it.    
 7. Double-Click the main window to add the folder containing your games.
 8. Go to *Emulation > Configure > Input* and set up your controller of choice. Click **OK** to close the dialog window.
 9. Double-Click a game to run it.
@@ -72,46 +72,8 @@ Use this guide to get starting using the Eden emulator.
    
 4. If you have had a different Switch emulator installed, it will detect and ask if you want to import those settings.  Make your selection to close the screen.
 5. Eden will now launch and notify you about missing Encryption keys. Close the dialog box by hitting **OK**.
-6. Navigate to **Tools > Install Decryption Keys**, navigate to the folder containing your ***prod.keys*** file and select the file and hit **Open**.
-7. Navigate to **Tools > Install Firmware >** *Select **From Folder*** or ***From ZIP*** - depending on how your firmware is stored, navigate to where it is stored and select it.
+6. Navigate to **Tools → Install Decryption Keys**, navigate to the folder containing your ***prod.keys*** file and select the file and hit **Open**.
+7. Navigate to **Tools → Install Firmware →** *Select **From Folder*** or ***From ZIP*** - depending on how your firmware is stored, navigate to where it is stored and select it.
 8. Double-Click the main window to add the folder containing your games.
 9. Go to *Emulation > Configure > Input* and set up your controller. Click **OK** to close the dialog window.
 10. Double-Click a game to run it.
-
-## macOS
-
-Current macOS support is still experimental and very reliant on MoltenVK developments, plans have shifted to properly provide support for KosmicKrisp and similar new GPU endeavors, but macOS users still are bound to MoltenVK itself.
-
-Users of macOS may wish to use [Asahi Linux](https://wiki.gentoo.org/wiki/Project:Asahi/Guide) for the rising KosmicKrisp support.
-
-As of writing, neither macOS nor Asahi has support for NCE; additionally Asahi has extraneous paging bugs with fastmem.
-
-### Allowing Eden to Run on MacOS
-
-Use this guide when you need to allow Eden to run on a Mac system, but are being blocked by Apple Security policy.
-
-**[See here](https://evilperson1337.notion.site/Allowing-Eden-to-Run-on-MacOS-2b057c2edaf681fea63dc81027efeffd) for an illustrated guide.**
-
---
-
-##### Pre-Requisites
-
- Permissions to modify settings in MacOS
-
---
-
-#### Why am I Seeing This?
-
-Recent versions of MacOS (Catalina & newer) introduced the **Gatekeeper** security functionality, requiring software to be signed by Apple or a trusted (aka - paying) developer.  If the signature isn't on the list of trusted ones, it will stop the program from executing and display the message above.
-
---
-
-#### Steps
-
-1. Open the *System Settings* panel.
-2. Navigate to *Privacy & Security*.
-3. Scroll down and observe the following message under the **Security** settings.
-4. Select **Open Anyway** to tell your Mac that you trust the application.
-5. You will now get another window appearing to verify you want to open Eden.  Select **Open Anyway**.
-6. You will be prompted for your password to authorize the request.  Enter the credentials of an account that has permission to modify settings and press **OK**.
-7. Eden will now open and any subsequent launches of the program will not prompt this.
@@ -10,15 +10,13 @@ A copy of this handbook is [available online](https://git.eden-emu.dev/eden-emu/

 - **[The Basics](Basics.md)**
 - **[Quickstart](./QuickStart.md)**
-    - **[Windows](./QuickStart.md#windows)**
-    - **[Steamdeck](./QuickStart.md#steamdeck)**
-    - **[macOS](./QuickStart.md#macos)**
 - **[Settings](./Settings.md)**
 - **[Controllers](./Controllers.md)**
    - **[Controller profiles](./Controllers.md#configuring-controller-profiles)**
 - **[Audio](Audio.md)**
 - **[Graphics](Graphics.md)**
 - **[Installing Mods](./Mods.md)**
+- **[Run On macOS](./RunOnMacOS.md)**
 - **[Data, Savefiles and Storage](Storage.md)**
 - **[Orphaned Profiles](Orphaned.md)**
 - **[Troubleshooting](./Troubleshoot.md)**
@@ -49,4 +47,6 @@ A copy of this handbook is [available online](https://git.eden-emu.dev/eden-emu/
 - **[Gyro Controls](./GyroControls.md)**
 - **[Platforms and Architectures](./Architectures.md)**
 - **[Native Application Development](./Native.md)**
+- **[Adding Boolean Settings Toggles](./AddingBooleanToggles.md)**
+- **[Adding Debug Knobs](./AddingDebugKnobs.md)**
 - **[Testing](./Testing.md)**
@@ -0,0 +1,37 @@
+# User Handbook - Run on macOS
+
+Current macOS support is still experimental and very reliant on MoltenVK developments, plans have shifted to properly provide support for KosmicKrisp and similar new GPU endeavours, but macOS users still are bound to MoltenVK itself.
+
+Users of macOS may wish to use [Asahi Linux](https://wiki.gentoo.org/wiki/Project:Asahi/Guide) for the rising KosmicKrisp support.
+
+As of writing, neither macOS nor Asahi has support for NCE; additionally Asahi has extraneous paging bugs with fastmem.
+
+## Allowing Eden to Run on MacOS
+
+Use this guide when you need to allow Eden to run on a Mac system, but are being blocked by Apple Security policy.
+
+**Click [Here](https://evilperson1337.notion.site/Allowing-Eden-to-Run-on-MacOS-2b057c2edaf681fea63dc81027efeffd) for a version of this guide with images & visual elements.**
+
+---
+
+#### Pre-Requisites
+
+- Permissions to modify settings in MacOS
+
+---
+
+### Why am I Seeing This?
+
+Recent versions of MacOS (Catalina & newer) introduced the **Gatekeeper** security functionality, requiring software to be signed by Apple or a trusted (aka - paying) developer.  If the signature isn’t on the list of trusted ones, it will stop the program from executing and display the message above.
+
+---
+
+### Steps
+
+1. Open the *System Settings* panel.
+2. Navigate to *Privacy & Security*.
+3. Scroll down and observe the following message under the **Security** settings.
+4. Select **Open Anyway** to tell your Mac that you trust the application.
+5. You will now get another window appearing to verify you want to open Eden.  Select **Open Anyway**.
+6. You will be prompted for your password to authorize the request.  Enter the credentials of an account that has permission to modify settings and press **OK**.
+7. Eden will now open and any subsequent launches of the program will not prompt this.
@@ -11,7 +11,7 @@ This guide explains how to set up a public/private self hosted Eden server/lobby
 - Next, under Server OS Images, select Ubuntu 24.04 LTS. Configure CPU/RAM/specs as desired for your server. Complete the creation process.

 - Enable the Kamatera firewall and set default policy: IN: DROP, OUT: ACCEPT.
- - After setting the default policy, add the three following rules: #1: SSH Access - Direction: IN, Interface: net0, Macro: SSH - Secure Shell Traffic, Source: ANY, Port: Blank/Auto (Handled by SSH), Destination: Blank/Auto (Handled by SSH), Policy: ACCEPT, leave a comment: SSH access.
+ - After setting the default policy, add the three following rules: #1: SSH Access - Direction: IN, Interface: net0, Macro: SSH - Secure Shell Traffic, Source: ANY, Port: Blank/Auto (Handeld by SSH), Destination: Blank/Auto (Handeld by SSH), Policy: ACCEPT, leave a comment: SSH access.
 - Then, after creating the first rule, add TCP & UDP Ports for Eden - Direction: IN, Interface: net0, Protocol: TCP or UDP (for respective rule), Source: ANY, Destination Port: 24872, Policy: ACCEPT, leave a comment: Eden server port.
 - Note: Only UDP is required for Eden; opening TCP is optional.

@@ -6,11 +6,11 @@ Most of the development adds new settings that enhance performance/compatibility

 As such, this guide will NOT mention those kind of settings, we'd rather mention settings which have a long shelf time (i.e won't get removed in future releases) and are likely to be unchanged.

-Some of the options are self explanatory, and they do exactly what they say they do (i.e "Pause when not in focus"); such options will be also skipped due to triviality.
+Some of the options are self explainatory, and they do exactly what they say they do (i.e "Pause when not in focus"); such options will be also skipped due to triviality.

 ## Foreword

-Before touching the settings, see the game boots with stock options. We try our best to ensure users can boot any game using the default settings. If they don't work, then you may try fiddling with options - but please, first use stock options.
+Before touching the settings, please see the game boots with stock options. We try our best to ensure users can boot any game using the default settings. If they don't work, then you may try fiddling with options - but please, first use stock options.

 ## General

@@ -25,15 +25,15 @@ Before touching the settings, see the game boots with stock options. We try our

 ## System

- `System/RNG Seed`: Set to 0 (and uncheck) to disable ASLR system-wide (this makes mods like CTGP to stop working); by default it enables ASLR to replicate console behavior.
+- `System/RNG Seed`: Set to 0 (and uncheck) to disable ASLR systemwide (this makes mods like CTGP to stop working); by default it enables ASLR to replicate console behaviour.
 - `Network/Enable Airplane Mode`: Enable this if a game is crashing before loading AND the logs mention anything related to "web" or "internet" services.

 ## CPU

 - `Fastmem`, aka. `CPU/Enable Host MMU`: Enables "fastmem"; a detailed description of fastmem can be found [here](../dynarmic/Design.md#fast-memory-fastmem).
- `CPU/Unsafe FMA`: Enables deliberate inaccurate FMA behavior which may affect how FMA returns any given operation - this may introduce tiny floating point errors which can cascade in sensitive code (i.e FFmpeg).
+- `CPU/Unsafe FMA`: Enables deliberate innacurate FMA behaviour which may affect how FMA returns any given operation - this may introduce tiny floating point errors which can cascade in sensitive code (i.e FFmpeg).
 - `CPU/Faster FRSQRTE and FRECPE`: Introduces accuracy errors on square root and reciprocals in exchange for less checks - this introduces inaccuracies with some cases but it's mostly safe.
- `CPU/Faster ASIMD Instructions`: Skips rounding mode checks for ARM ASIMD instructions - this means some code depending on these rounding modes may misbehave.
+- `CPU/Faster ASIMD Instructions`: Skips rounding mode checks for ARM ASIMD instructions - this means some code dpeending on these rounding modes may misbehave.
 - `CPU/Disable address space checks`: Before each memory access, the emulator checks the address is in range, if not it faults; this option makes it so the emulator skips the check entirely (which may be expensive for a myriad of reasons). However at the same time this allows the guest program to "break out" of the emulation context by writing to arbitrary addresses.
 - `CPU/Ignore global monitor`: This relies on a quirk present on x86 to avoid the ARM global monitor emulation, this may increase performance in mutex-heavy contexts (i.e games waiting for next frames or such); but also can cause deadlocks and fun to debug issues.

@@ -4,7 +4,7 @@

 Use this when you want to import the Eden AppImage into your Steam Library along with artwork using *Steam ROM Manager.*

-**[See here](https://evilperson1337.notion.site/Importing-Eden-into-Steam-with-Steam-Rom-Manager-2b757c2edaf68054851bc287b6382cb5) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Importing-Eden-into-Steam-with-Steam-Rom-Manager-2b757c2edaf68054851bc287b6382cb5) for a version of this guide with images & visual elements.**

 ---

@@ -20,7 +20,7 @@ Use this when you want to import the Eden AppImage into your Steam Library along

 #### Initial Setup

-1. Press the **STEAM** button and then go to *Power > Switch to Desktop* to enter the Desktop mode.
+1. Press the **STEAM** button and then go to *Power → Switch to Desktop* to enter the Desktop mode.

 2. Install ***Steam ROM Manager*** (if needed), there are 2 ways you can accomplish this, either manually or through [*EmuDeck*](https://www.emudeck.com/#downloads).

@@ -53,8 +53,8 @@ Use this when you want to import the Eden AppImage into your Steam Library along

 EmuDeck will automatically create an *Emulators - Emulators* parser for ***Steam ROM Manager*** that uses shell scripts to launch them.  We will follow this convention.

-1. In the file explorer go to your **EmuDeck installation folder > tools > launchers**
-2. Right-Click some empty space and hit **Create New > Text File,** call this new file ***eden.sh*** instead of ***Text File.txt***
+1. In the file explorer go to your **EmuDeck installation folder → tools → launchers**
+2. Right-Click some empty space and hit **Create New → Text File,** call this new file ***eden.sh*** instead of ***Text File.txt***
 3. Right-Click the ***eden.sh*** file you created and hit ***Open with Kate***.
 4. Paste the following code into the contents of the file, save and close the file.
    
@@ -103,7 +103,7 @@ We will need to create a new parser for the Emulators.  Unlike with the EmuDeck
    
    <aside>
        
-    ***TIP***: You may need to go to **Settings > Theme** and set it to *Classic* to view this option.
+    ***TIP***: You may need to go to **Settings → Theme** and set it to *Classic* to view this option.
    
    </aside>

@@ -114,12 +114,12 @@ We will need to create a new parser for the Emulators.  Unlike with the EmuDeck
        2. **Parser Title**: *Emulators - Emulators*
        3. **Steam Directory**: *${steamdirglobal}*
        4. **User Accounts**: *Global*
-        5. **ROMs Directory**: <path to directory containing Eden AppImage>
+        5. **ROMs Directory**: <path to directory containing eden AppImage>
        6. **Steam Collections**: *Emulation* (OPTIONAL)
    2. Parser Specific Configuration
        1. **Search Glob**: *${title}@(.AppImage|.APPIMAGE|.appimage)*
    3. Executable Configuration
-        1. **Executable Modifier**: *"${exePath}"*
+        1. **Executable Modifier**: *"${exePath}”*
    4. Title Modification Configuration
        1. **Title Modifier**: *${fuzzyTitle}*
    
@@ -167,7 +167,7 @@ Now that we have the parser or shell script created, we can actually add it to S

 Use this when you want to import your games inside Eden into Steam to launch with artwork from Steam Game Mode without needing to launch Eden first.

-**[See here](https://evilperson1337.notion.site/Importing-Games-into-Steam-with-Steam-Rom-Manager-2b757c2edaf680d7a491c92b138f1fcc) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Importing-Games-into-Steam-with-Steam-Rom-Manager-2b757c2edaf680d7a491c92b138f1fcc) for a version of this guide with images & visual elements.**

 ---

@@ -181,7 +181,7 @@ Use this when you want to import your games inside Eden into Steam to launch wit

 ### Steps

-1. Press the **STEAM** button and then go to *Power > Switch to Desktop* to enter the Desktop mode.
+1. Press the **STEAM** button and then go to *Power → Switch to Desktop* to enter the Desktop mode.

 1. Install ***Steam ROM Manager***, there are 2 ways you can accomplish this, either manually or through [*EmuDeck*](https://www.emudeck.com/#downloads).

@@ -215,7 +215,7 @@ Use this when you want to import your games inside Eden into Steam to launch wit
    
    <aside>
    
-    ***TIP***: Your layout may look different depending on how you installed *Steam ROM Manager*.  You may need to go to **Settings > Theme** and change it to *Classic* to follow along.
+    ***TIP***: Your layout may look different depending on how you installed *Steam ROM Manager*.  You may need to go to **Settings → Theme** and change it to *Classic* to follow along.
    
    </aside>
    
@@ -229,13 +229,13 @@ Use this when you want to import your games inside Eden into Steam to launch wit
    2. Change the **Parser title** from *Nintendo Switch - Yuzu* to *Nintendo Switch - Eden.*
    3. Hit the **Browse** option under the *ROMs directory* section.  Select the directory containing your Switch ROMs.
    4. Under *Steam collections*, you can add a Steam category name.  This just organizes the games under a common category in your Steam Library, this is optional but recommended.
-    5. Scroll down slightly to the **Executable Configuration > Executable**, select **Browse** and select the Eden AppImage.
+    5. Scroll down slightly to the **Executable Configuration → Executable**, select **Browse** and select the Eden AppImage.
    6. Leave everything else the same and hit **Save** to save the parser.
    ---
    
 4. Click the Eden parser to view the options on the right, select **Test** at the bottom of the screen to ensure that *Steam ROM Manager* detects your games correctly.
 1. *Steam ROM Manager* will start to scan the specified ROMs directory and match them to games.  Look over the results to ensure they are accurate.  If you do not see any entries - check your parsers ROMs directory field.
-1. When you are happy with the results, click the **Add Games** > **Parse** to start the actual Parsing.
+1. When you are happy with the results, click the **Add Games** → **Parse** to start the actual Parsing.
 1. The program will now identify the games and pull artwork from [*SteamGridDB*](https://www.steamgriddb.com/).
 2. Review the game matches and ensure everything is there.
    
@@ -2,7 +2,7 @@

 Use this guide for when you want to configure automated backup/syncing of your Eden save files using [*Syncthing*](https://syncthing.net/).

-**[See here](https://evilperson1337.notion.site/Backing-Up-Syncing-Eden-Game-Saves-2b357c2edaf68000b40cfab2c2c3dc0a) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Backing-Up-Syncing-Eden-Game-Saves-2b357c2edaf68000b40cfab2c2c3dc0a) for a version of this guide with images & visual elements.**

 ### Pre-Requisites

@@ -30,15 +30,15 @@ Use this guide for when you want to configure automated backup/syncing of your E

 ## Overview

-Rather than giving a breakdown of all the platforms and configurations, those will be in the platform's specific guides - this will serve as a general overview of Syncthing.
+Rather than giving a breakdown of all the platforms and configurations, those will be in the platform’s specific guides - this will serve as a general overview of Syncthing.

 ### What is Syncthing Anyway?

-Syncthing is a continuous file synchronization program (in the layman's - make sure 2 or more systems with the same files are always up to date).  This is perfect for game saves where we would want to play on 1 device, save our game, and then continue playing it on another device.  This technology is what Epic/Steam/etc. use to allow you to do this on games run through their respective services.  Syncthing is an open source implementation of this technology that you control, rather than relying on a 3rd party.  This has a few key benefits, most notably - better security, privacy, and speed (when on your LAN).
+Syncthing is a continuous file synchronization program (in the layman’s - make sure 2 or more systems with the same files are always up to date).  This is perfect for game saves where we would want to play on 1 device, save our game, and then continue playing it on another device.  This technology is what Epic/Steam/etc. use to allow you to do this on games run through their respective services.  Syncthing is an open source implementation of this technology that you control, rather than relying on a 3rd party.  This has a few key benefits, most notably - better security, privacy, and speed (when on your LAN).

 ### What are some common issues?

-Syncthing is fairly robust and doesn't have many issues luckily, but there are some things you should watch out for (almost all of them a user issue).
+Syncthing is fairly robust and doesn’t have many issues luckily, but there are some things you should watch out for (almost all of them a user issue).

 - Sync conflicts
    - If for whatever reason you update the same file on 2 different machines, the system does not know which updated file is considered the one to sync across.  This results in a ***sync conflict*** where it may not sync the files as you would expect.  Worst case scenario, this can result in your save progress being lost if you are not careful.  When one of these occurs, it will create a copy of the file and store it with a specific name, like this example, *Paper Mario.sync-conflict-20251102-072925-TZBBN6S.srm.* To resolve this, you must remove the other files and remove the *.sync-conflict-<TIMESTAMP>-<Syncthing Device ID>* from the file name of the file you want to keep.
@@ -86,7 +86,7 @@ Use this when you want to set this machine as the initial source of truth (push

 1. Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing.**
 2. You will now have a browser window open up to a web GUI to configure *Syncthing*.  You will get a pop up about allowing anonymous usage and setting a password, make your selections to close them.
-3. We'll start by adding the folder with our save files that we want to sync by Pressing **+ Add Folder**.
+3. We’ll start by adding the folder with our save files that we want to sync by Pressing **+ Add Folder**.
 4. A pop-up window will appear, fill in the Folder label field with whatever you want to call it, like Switch Saves.
 5. Enter the Full folder path to where your save files are stored on this machine.
    
@@ -105,7 +105,7 @@ Use this when you want to set this machine as the initial source of truth (push

 Use this when you want to set this machine up as a child (pull files from the other devices).  Afterwards they will all be equal partners, not a parent/child relationship, this just helps with initial setup.

-1. Install Syncthing Tray on the client device following the section above.  Copy the child's ID and store it so it is accessible to the Parent.
+1. Install Syncthing Tray on the client device following the section above.  Copy the child’s ID and store it so it is accessible to the Parent.
 2. ***ON THE PARENT***: Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing** if it is not open already**.**
 3. You will now have a browser window open up to a web GUI to configure *Syncthing*.  You will get a pop up about allowing anonymous usage and setting a password, make your selections to close them.
 4. Navigate down to **+ Add Remote Device**, we are going to add our Child device, so I hope you have its ID handy.  If not, go back and get it.
@@ -126,7 +126,7 @@ Use this when you want to set this machine up as a child (pull files from the ot
    
    </aside>

-13. *Syncthing* will now pull all the files from the Parent and store them in your local save directory.  At this point the files are in sync and alterations to one will affect the other and both can be considered "*Parents*" for other devices you want to add.  Repeat these steps for as many devices you want.
+13. *Syncthing* will now pull all the files from the Parent and store them in your local save directory.  At this point the files are in sync and alterations to one will affect the other and both can be considered “*Parents*” for other devices you want to add.  Repeat these steps for as many devices you want.

 ## Linux

@@ -166,9 +166,9 @@ Use this when you want to set this machine up as a child (pull files from the ot
 Use this when you want to set this machine as the initial source of truth (push files out to all the other devices).  Afterwards they will all be equal partners, not a parent/child relationship, this just helps with initial setup.

 1. Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing.** 
-    1. If you don't have a taskbar in your distro, you can also reach it directly by opening a web browser to: *http://127.0.0.1:8384/.*    
+    1. If you don’t have a taskbar in your distro, you can also reach it directly by opening a web browser to: *http://127.0.0.1:8384/.*    
 2. You will now have a browser window open up to a web GUI to configure *Syncthing*.  You will get a pop up about allowing anonymous usage and setting a password, make your selections to close them.
-3. We'll start by adding the folder with our save files that we want to sync by Pressing **+ Add Folder**.
+3. We’ll start by adding the folder with our save files that we want to sync by Pressing **+ Add Folder**.
 4. A pop-up window will appear, fill in the Folder label field with whatever you want to call it, like Switch Saves.
 5. Enter the Full folder path to where your save files are stored on this machine.
    
@@ -187,7 +187,7 @@ Use this when you want to set this machine as the initial source of truth (push

 Use this when you want to set this machine up as a child (pull files from the other devices).  Afterwards they will all be equal partners, not a parent/child relationship, this just helps with initial setup.

-1. Install Syncthing Tray on the client device following the section above.  Copy the child's ID and store it so it is accessible to the Parent.
+1. Install Syncthing Tray on the client device following the section above.  Copy the child’s ID and store it so it is accessible to the Parent.
 2. ***ON THE PARENT***: Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing** if it is not open already**.** 
 3. You will now have a browser window open up to a web GUI to configure *Syncthing*.  You will get a pop up about allowing anonymous usage and setting a password, make your selections to close them.
 4. Navigate down to **+ Add Remote Device**, we are going to add our Child device, so I hope you have its ID handy.  If not, go back and get it.
@@ -208,4 +208,4 @@ Use this when you want to set this machine up as a child (pull files from the ot
    
    </aside>
    
-13. *Syncthing* will now pull all the files from the Parent and store them in your local save directory.  At this point the files are in sync and alterations to one will affect the other and both can be considered "*Parents*" for other devices you want to add.  Repeat these steps for as many devices you want.
+13. *Syncthing* will now pull all the files from the Parent and store them in your local save directory.  At this point the files are in sync and alterations to one will affect the other and both can be considered “*Parents*” for other devices you want to add.  Repeat these steps for as many devices you want.
@@ -41,7 +41,7 @@ For regressions/bugs from PRs or commits:
        - [ ] Bisected PR? (if it has commits)
        - [ ] Found bisected commit?

-If an issue sporadically appears, try to do multiple runs, try if possible, to count the number of times it has failed and the number of times it has "worked just fine"; say it worked 3 times but failed 1. then there is a 1/4th chance every run that the issue is replicated - so every bisect step would require 4 runs to ensure there is at least a chance of triggering the bug.
+If an issue sporadically appears, try to do multiple runs, try if possible, to count the number of times it has failed and the number of times it has "worked just fine"; say it worked 3 times but failed 1. then there is a 1/4th chance every run that the issue is replicated - so every bisect step would require 4 runs to ensure there is atleast a chance of triggering the bug.

 ## What to do when something seems off

@@ -96,4 +96,4 @@ The faulty commit then, is 6th of Jan. This is called bisection https://git-scm.
 - PR's marked with **WIP** do NOT need to be tested unless explicitly asked (check the git in case)
 - Sometimes license checks may fail, hover over the build icon to see if builds did succeed, as the CI will push builds even if license checks fail.
 - All open PRs can be viewed [here](https://git.eden-emu.dev/eden-emu/eden/pulls/).
- If site is down use one of the [mirrors](./ThirdParty.md#mirrors).
+- If site is down use one of the [mirrors](./user/ThirdParty.md#mirrors).
@@ -1,30 +1,30 @@
 # User Handbook - Third party tools and extras

-The Eden emulator by itself lacks some functionality - or otherwise requires external files (such as packaging) to operate correctly in a given OS. Addendum to that some repositories provide nightly or specialized builds of the emulator.
+The Eden emulator by itself lacks some functionality - or otherwise requires external files (such as packaging) to operate correctly in a given OS. Addendum to that some repositories provide nightly or specialised builds of the emulator.

-While most of the links mentioned in this guide are relatively "safe"; we urge users to use their due diligence and appropriately verify the integrity of all files downloaded and ensure they're not compromised.
+While most of the links mentioned in this guide are relatively "safe"; we urge users to use their due diligence and appropriatedly verify the integrity of all files downloaded and ensure they're not compromised.

 - [NixOS Eden Flake](https://github.com/Grantimatter/eden-flake)
 - [ES-DE Frontend Support](https://github.com/GlazedBelmont/es-de-android-custom-systems)

 ## Mirrors

-The main origin repository is always at <https://git.eden-emu.dev/eden-emu/eden>.
+The main origin repository is always at https://git.eden-emu.dev/eden-emu/eden.

- <https://github.com/eden-emulator/mirror>
- <https://git.crueter.xyz/mirror/eden>
- <https://codeberg.org/eden-emu/eden>
- <https://collective.taymaerz.de/eden/eden>
+- https://github.com/eden-emulator/mirror
+- https://git.crueter.xyz/mirror/eden
+- https://codeberg.org/eden-emu/eden
+- https://collective.taymaerz.de/eden/eden

 Other mirrors obviously exist on the internet, but we can't guarantee their reliability and/or availability.

-If you're someone wanting to make a mirror, simply setup Forgejo and automatically mirror from the origin repository. Or you could mirror a mirror to save us bandwidth... your choice!
+If you're someone wanting to make a mirror, simply setup forgejo and automatically mirror from the origin repository. Or you could mirror a mirror to save us bandwidth... your choice!

 ## Configuring Obtainium

 Very nice handy app, here's a quick rundown how to configure:

-1. Copy the URL: <https://git.eden-emu.dev/eden-emu/eden/> (or one of your favorite mirrors)
+1. Copy the URL: https://git.eden-emu.dev/eden-emu/eden/ (or one of your favourite mirrors)
 2. Open Obtainium and tap `Add App`.
 3. Paste the URL into the `App Source URL` field.
 4. Override Source: Look for the `Override Source` dropdown menu and select `Forgejo (Codeberg)`.
@@ -36,7 +36,7 @@ Note: Even though the site isn't Codeberg, it uses the same Forgejo/Gitea backen

 ### Method 1

-1. Download the ZIP from [GitHub](https://github.com/GlazedBelmont/es-de-android-custom-systems)
+1. Download ZIP from [here](https://github.com/GlazedBelmont/es-de-android-custom-systems)
 2. Unzip the file and extract `es_systems.xml` and `es_find_rules.xml` to `\Odin2\Internal shared storage\ES-DE\custom_systems`.
 3. Press `Start -> Other Settings -> Alternative Emulators` and set it to Eden (Standalone).

@@ -61,7 +61,7 @@ Note: Even though the site isn't Codeberg, it uses the same Forgejo/Gitea backen
 </emulator>
 ```

-1. Add this line of text to your `es_systems.xml` underneath where the rest of your switch system entries are:
+3. Add this line of text to your `es_systems.xml` underneath where the rest of your switch system entries are:

 ```xml
 <command label="Eden (Standalone)">%EMULATOR_EDEN% %ACTION%=android.nfc.action.TECH_DISCOVERED %DATA%=%ROMPROVIDER%</command>
@@ -14,7 +14,7 @@

 ## Eden Fails to Launch and Does Not Leave Any Logs

-**[See here](https://evilperson1337.notion.site/Windows-Eden-Fails-to-Launch-and-Does-Not-Leave-Any-Logs-2b057c2edaf68156b640cf1ac549870a) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Windows-Eden-Fails-to-Launch-and-Does-Not-Leave-Any-Logs-2b057c2edaf68156b640cf1ac549870a) for a version of this guide with images & visual elements.**

 ### Error Details

@@ -24,11 +24,11 @@

 **Error Log Entries:** 

-```text
+```
 None
 ```
 **Example Error Message Entry in Windows Event Viewer**
-```text
+```
 Faulting application name: eden.exe, version: 0.0.0.0, time stamp: 0x6795dc3c
 Faulting module name: ntdll.dll, version: 10.0.26100.3037, time stamp: 0x95e6c489
 Exception code: 0xc0000005
@@ -68,12 +68,12 @@ Faulting package-relative application ID:
 2. Confirm there are no logs created in the log directory.
    1. See the [How to Access Logs](./HowToAccessLogs.md) page for the log location if you need it.
    2. If there are any entries in here since you tried step 1, this is likely not your issue.
-3. Navigate to your *Windows Event Viewer* (Start Menu > **eventvwr.msc)**. 
+3. Navigate to your *Windows Event Viewer* (Start Menu → **eventvwr.msc)**. 
 4. Expand **Windows Logs** and select **Application.**
    
 5. Look for an entry with the Level of Error, and look for a message similar to the following
    
-    ```text
+    ```
    Faulting application name: Eden.exe, version: 0.0.0.0, time stamp: 0x6795dc3c
    Faulting module name: ntdll.dll, version: 10.0.26100.3037, time stamp: 0x95e6c489
    Exception code: 0xc0000005
@@ -90,7 +90,7 @@ Faulting package-relative application ID:
 6. Run a Command Prompt terminal Window as Administrator.
 7. Enter the following command and wait for it to complete.  It will take a while, just be patient and do other things while it completes.
    
-    ```bat
+    ```
    DISM /Online /Cleanup-Image /RestoreHealth
    ```
    
@@ -2,7 +2,7 @@

 Use this guide when you want to load Amiibo into your games for use with the Eden emulator.

-**[See here](https://evilperson1337.notion.site/Using-Amiibo-with-Eden-2b057c2edaf681b1b28ec6be600c6d3e) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Using-Amiibo-with-Eden-2b057c2edaf681b1b28ec6be600c6d3e) for a version of this guide with images & visual elements.**

 ## Android

@@ -17,7 +17,7 @@ TBD

    <aside>

-    ***NOTE***: Eden only supports the *.bin* Amiibo format, ***NOT*** the *.nfc* format.
+    ***NOTE***: Eden only supports the *.bin* amiibo format, ***NOT*** the *.nfc* format.

    </aside> 

@@ -30,14 +30,14 @@ TBD

    </aside>

-1. Navigate to the Amiibo section of the game.  The method for initiating the scanning varies from game to game, for *Captain Toad's Treasure Tracker*, you need to go to the press the **+** button when on the level select.  You will need to look up how to do so with your specific game.
+1. Navigate to the Amiibo section of the game.  The method for initiating the scanning varies from game to game, for *Captain Toad’s Treasure Tracker*, you need to go to the press the **+** button when on the level select.  You will need to look up how to do so with your specific game.
 2. Upon activating the Amiibo scan functionality, you should get a Scan page.  Eden is now looking for an Amiibo file to be loaded, which emulates scanning an Amiibo on actual hardware.
-3. Navigate to **File > Load/Remove Amiibo...**, or press the hotkey to do the same (**F2** on keyboard by default).
+3. Navigate to **File > Load/Remove Amiibo…**, or press the hotkey to do the same (**F2** on keyboard by default).
 4. In the file explorer that opens, navigate to the amiibo file you want to use.

    <aside>

-    ***NOTE***: It seems the scanning functionality is spotty and will sometimes throw a "*The current game is not looking for Amiibos*" message, even though it is.  Usually you just need to try loading it again or restarting the scanning from the game.  In some situations it was only resolved by restarting the game.
+    ***NOTE***: It seems the scanning functionality is spotty and will sometimes throw a "*The current game is not looking for amiibos*” message, even though it is.  Usually you just need to try loading it again or restarting the scanning from the game.  In some situations it was only resolved by restarting the game.

    </aside>

@@ -2,7 +2,7 @@

 Use this guide when you want to add cheats into a game to alter gameplay for use with the Eden emulator.

-**[See here](https://evilperson1337.notion.site/Using-Cheats-with-Eden-2b057c2edaf6818fab66c276e2304bb4) for an illustrated guide.**
+**Click [Here](https://evilperson1337.notion.site/Using-Cheats-with-Eden-2b057c2edaf6818fab66c276e2304bb4) for a version of this guide with images & visual elements.**

 ## Android

@@ -58,24 +58,24 @@ Community Member [Ninjistix](https://github.com/Ninjistix) created a utility (Wi
 ```
 [Super Mario Bros. Wonder - Various] <- Optional

-[# 1. Always Star Power]
+[♯ 1. Always Star Power]
 040E0000 00880580 52800035

-[# 2. Star Power + Bubble Mode (Invincible)]
+[♯ 2. Star Power + Bubble Mode (Invincible)]
 040E0000 00880580 52800075

-[# 3. Can Fast Travel to Any Course and World]
+[♯ 3. Can Fast Travel to Any Course and World]
 040E0000 00935E10 52800036
 040E0000 0048A528 52800028
 040E0000 005D9F58 52800028

-[# 4. Got All Top of Flag Poles]
+[♯ 4. Got All Top of Flag Poles]
 040E0000 0048A818 52800028
 ```

 ### Step 3: Enabling/Disabling Cheats

-Cheats are enabled by default, but can be disabled so they don't affect gameplay fairly easily using the game properties.
+Cheats are enabled by default, but can be disabled so they don’t affect gameplay fairly easily using the game properties.

 1. Open Eden and press and hold the game you want to apply the cheat to.
 2. Scroll down on the properties until you see **Add-ons**, select this option.
@@ -130,24 +130,24 @@ Community Member [Ninjistix](https://github.com/Ninjistix) created a utility (Wi
 ```
 [Super Mario Bros. Wonder - Various] <- Optional

-[# 1. Always Star Power]
+[♯ 1. Always Star Power]
 040E0000 00880580 52800035

-[# 2. Star Power + Bubble Mode (Invincible)]
+[♯ 2. Star Power + Bubble Mode (Invincible)]
 040E0000 00880580 52800075

-[# 3. Can Fast Travel to Any Course and World]
+[♯ 3. Can Fast Travel to Any Course and World]
 040E0000 00935E10 52800036
 040E0000 0048A528 52800028
 040E0000 005D9F58 52800028

-[# 4. Got All Top of Flag Poles]
+[♯ 4. Got All Top of Flag Poles]
 040E0000 0048A818 52800028
 ```

 ### Step 3: Enabling/Disabling Cheats

-Cheats are enabled by default, but can be disabled so they don't affect gameplay fairly easily using the game properties.
+Cheats are enabled by default, but can be disabled so they don’t affect gameplay fairly easily using the game properties.

 1. *Right-Click* the game and select *Configure Game*.
 2. In the **Add-Ons** section, locate the cheat you wish to enable.
--- a/Show More
+++ b/Show More
				`@@ -1 +0,0 @@`
				`AI and LLM use is strictly prohibited within our codebase and surrounding community, including issues and comments. This includes using AI or LLMs to write docs/commit messages, debug issues, brainstorm ideas, research concepts, or search the codebase.`