diff --git a/README.md b/README.md index 156ebc094a..7d3fe5572e 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@
-

Eden is a free and opensource (FOSS) Switch 1 emulator started by developer Camille LaVey. +

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.

diff --git a/dist/dev.eden_emu.eden.metainfo.xml b/dist/dev.eden_emu.eden.metainfo.xml index 83398eed3b..ce5cc9a905 100644 --- a/dist/dev.eden_emu.eden.metainfo.xml +++ b/dist/dev.eden_emu.eden.metainfo.xml @@ -11,12 +11,12 @@ SPDX-License-Identifier: CC0-1.0 --> - org.eden_emu.eden + dev.eden_emu.eden CC0-1.0 eden Nintendo Switch emulator -

Multiplatform FOSS Switch 1 emulator written in C++, derived from Yuzu and Sudachi

+

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.

 Game @@ -28,14 +28,14 @@ SPDX-License-Identifier: CC0-1.0 https://eden-emu.dev/ https://git.eden-emu.dev/eden-emu/eden/issues - https://eden-emu.dev/docs - https://eden-emu.dev/docs - https://eden-emu.dev/donations + https://eden-emu.dev/about + https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/user/README.md + https://liberapay.com/crueter https://explore.transifex.com/edenemu/eden-emulator - https://discord.gg/edenemu + https://discord.gg/HstXbPch7X https://git.eden-emu.dev https://git.eden-emu.dev/eden-emu/eden - org.eden_emu.eden.desktop + dev.eden_emu.eden.desktop yuzu yuzu-cmd @@ -44,6 +44,7 @@ SPDX-License-Identifier: CC0-1.0 pointing keyboard gamepad + offline-only 8192 diff --git a/dist/dev.eden_emu.eden.xml b/dist/dev.eden_emu.eden.xml index 922ebf7ff3..22acd30595 100644 --- a/dist/dev.eden_emu.eden.xml +++ b/dist/dev.eden_emu.eden.xml @@ -14,7 +14,7 @@ SPDX-License-Identifier: GPL-2.0-or-later Nintendo Switch homebrew executable NRO - + @@ -22,7 +22,7 @@ SPDX-License-Identifier: GPL-2.0-or-later Nintendo Switch homebrew executable NSO - + @@ -30,7 +30,7 @@ SPDX-License-Identifier: GPL-2.0-or-later Nintendo Switch Package NSP - + @@ -38,7 +38,7 @@ SPDX-License-Identifier: GPL-2.0-or-later Nintendo Switch Card Image XCI - + diff --git a/dist/english_plurals/README.md b/dist/english_plurals/README.md index a4954f6a68..4645d47ba4 100644 --- a/dist/english_plurals/README.md +++ b/dist/english_plurals/README.md @@ -2,6 +2,7 @@ Qt has "Translation Rules for Plurals", small example +```cpp // Take a source line like tr("Building: %n shader(s)", "", i) @@ -9,8 +10,9 @@ 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. diff --git a/dist/languages/README.md b/dist/languages/README.md index 3a7f4c9efb..7adfa7615e 100644 --- a/dist/languages/README.md +++ b/dist/languages/README.md @@ -1,6 +1,6 @@ # 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` in the root of this repository. If you want to contribute to the translation, please go the Transifex link and submit your translation there. When creating/improving translations, please keep in mind: diff --git a/docs/Build.md b/docs/Build.md index ec99b20558..84a3784fc0 100644 --- a/docs/Build.md +++ b/docs/Build.md @@ -5,6 +5,15 @@ This is a full-fledged guide to build Eden on all supported platforms. +If you already have a development environment set up: + +```sh +cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -G Ninja +cmake --build build +``` + +On Linux, macOS, and MinGW/MSYS2, make sure to read the [dependencies guide](Deps.md). On Android, read its [dedicated page](build/Android.md). + ## Dependencies First, you must [install some dependencies](Deps.md). @@ -125,13 +134,13 @@ cmake -S . -B build -G "" -DCMAKE_C_COMPILER=clang-cl -DCMAKE_CXX_COM -- 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 -- 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. @@ -153,7 +162,7 @@ If your initial configure failed: - *Carefully* re-read the [dependencies guide](Deps.md) - Clear the CPM cache (`.cache/cpm`) and CMake cache (`/CMakeCache.txt`) - Evaluate the error and find any related settings -- See the [CPM docs](CPM.md) to see if you may need to forcefully bundle any packages +- See the [CPM docs](CPMUtil.md) to see if you may need to forcefully bundle any packages Otherwise, feel free to ask for help in Stoat or Discord. diff --git a/docs/Caveats.md b/docs/Caveats.md index c5b925f4cd..b86edf4d75 100644 --- a/docs/Caveats.md +++ b/docs/Caveats.md @@ -12,10 +12,6 @@ - [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) ## Arch Linux @@ -71,7 +67,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` +Since so many dependencies are missing on `OmniOS`, you may wish to use `-DCPMUTIL_FORCE_BUNDLED=ON` and `-DYUZU_USE_BUNDLED_OPENSSL=OFF`. For OmniOS you are required to build glslang yourself: ```sh @@ -86,11 +82,13 @@ cmake --install build It may be tempting to specify `-t glslang`, but this will cause installation to fail. So don't. -Using `--parallel` on CMake incorrectly passes `dmake ... -jn` instead of `dmake ... -j n`, this is a bug with OmniOS's CMake, and as such it's recommended to not use this option until it's fixed. +Using `--parallel` on CMake incorrectly passes `dmake ... -jn` instead of `dmake ... -j n`, this is a bug with OmniOS's CMake, it's recommended to not use this option until it's fixed. 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: +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`. ## HaikuOS @@ -244,19 +242,3 @@ 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. diff --git a/docs/Debug.md b/docs/Debug.md index 026e920d9b..ec668d5dfd 100644 --- a/docs/Debug.md +++ b/docs/Debug.md @@ -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 -d -g `, or `Enable GDB Stub` at General > Debug, then hook up an aarch64-gdb: +Run `./build/bin/eden-cli -c -d -g `, or `Enable GDB Stub` at General > Debug, then hook up an aarch64-gdb: - `target remote localhost:6543` @@ -69,6 +69,55 @@ 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 (Graphic Debugging Tool) +# RenderDoc -Guidelines for graphical debugging using RenderDoc: **[RenderDoc usage](./RenderDoc.md)** \ No newline at end of file +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. diff --git a/docs/Deps.md b/docs/Deps.md index ae526b2543..2b73ecb4ac 100644 --- a/docs/Deps.md +++ b/docs/Deps.md @@ -259,7 +259,10 @@ brew install molten-vk
FreeBSD -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 vulkan-headers quazip-qt6` +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 graphics/vulkan-utility-libraries graphics/vulkan-headers graphics/spirv-headers quazip-qt6 +``` If using FreeBSD 12 or prior, use `devel/pkg-config` instead. @@ -272,7 +275,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 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-qtbase qt6-qtcharts qt6-qtmultimedia qt6-qttools cpp-httplib lz4 vulkan-headers nasm autoconf enet pkg-config libusb1 libcxx frozen ``` [Caveats](./Caveats.md#netbsd). diff --git a/docs/DesignOverview.md b/docs/DesignOverview.md index e2af566c54..c6a328cb9c 100644 --- a/docs/DesignOverview.md +++ b/docs/DesignOverview.md @@ -1,6 +1,6 @@ # Design Overview -Modern game consoles require heavy power to be emulated appropriatedly. This is why the emulator uses an approach known as HLE (High-Level-Emulation), in a nuthsell: Instead of accurately emulating every subsystem that forms part of a component, emulate the resulting visible I/O interface instead. +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. @@ -20,7 +20,7 @@ Handles everything related to audio, this is where most of the filtering and pro ## src/common/ -The [common](../src/common) folder contains just your basic pollyfills 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. +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/ @@ -40,7 +40,7 @@ Dedicated shader recompiler to translate Maxwell assembly code to either SPIR-V, ## 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_ahders) to emulate MSAA, D24 copies or as polyfill. +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. diff --git a/docs/Development.md b/docs/Development.md index 0c7543c156..ddffb0cbb4 100644 --- a/docs/Development.md +++ b/docs/Development.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), approximatedly you need 4GB for a full build with debug symbols: +If you have an HDD, use ramdisk (build in RAM), approximately 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 nonethless: +May not be used but worth mentioning nonetheless: - OGG files: Use [OptiVorbis](https://github.com/OptiVorbis/OptiVorbis). - Video files: Use ffmpeg, preferably re-encode as AV1. diff --git a/docs/README.md b/docs/README.md index ac6ac801f0..5bcaf30239 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,9 +2,9 @@ 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](./SIGNUP.md). +If you want to register/signup as a contributor, take a gander at [CONTRIBUTING.md](../CONTRIBUTING.md). -This contains documentation created by developers. This contains build instructions, guidelines, instructions/layouts for [cool stuff we made](./CPMUtil), and more. +This contains documentation created by developers, build instructions, guidelines, instructions/layouts for [cool stuff we made](./CPMUtil.md), and more. - **[General Build Instructions](./Build.md)** - **[CMake Options](./Options.md)** @@ -12,11 +12,10 @@ This contains documentation created by developers. This contains build instructi - **[Development Guidelines](./Development.md)** - **[Dependencies](./Deps.md)** - **[Debug Guidelines](./Debug.md)** -- **[RenderDoc usage](./RenderDoc.md)** -- **[CPM - CMake Package Manager](./CPMUtil)** + - **[RenderDoc](./Debug.md#renderdoc)** +- **[CPM - CMake Package Manager](./CPMUtil.md)** - **[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: diff --git a/docs/RenderDoc.md b/docs/RenderDoc.md deleted file mode 100644 index 3495d18dad..0000000000 --- a/docs/RenderDoc.md +++ /dev/null @@ -1,52 +0,0 @@ -# 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. diff --git a/docs/Settings.md b/docs/Settings.md index b46996ecc1..94fbc7e440 100644 --- a/docs/Settings.md +++ b/docs/Settings.md @@ -1,11 +1,11 @@ # Settings > [!WARNING] -> This guide is intended for developers ONLY. If you're looking for configuring the emulator itself, please read **[the user handbook](./user/README.md)**. +> This guide is intended for developers ONLY. If you're looking for configuring the emulator itself, 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 a outline/documentation for the settings subsystem. +However, this process can be tedious for those unfamiliar; this document serves as an outline/documentation for the settings subsystem. ## Index @@ -80,7 +80,7 @@ INSERT(Settings, #### Make sure to: -* Keep display naming consistant +* Keep display naming consistent * Put detailed info in the description * Use `\n` for line breaks in descriptions @@ -191,7 +191,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 burocracy 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 bureaucracy and hassle of new toggles. Common advantages recap: diff --git a/docs/dynarmic/Design.md b/docs/dynarmic/Design.md index 020cfd65bd..77272e2220 100644 --- a/docs/dynarmic/Design.md +++ b/docs/dynarmic/Design.md @@ -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/interface). Users specify how dynarmic's CPU core interacts with +[`src/dynarmic/interface`](../../src/dynarmic/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/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) +* 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) 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 (Eliminiation of redundant microinstructions, other speed improvements) +3. Optimization (Elimination 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/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, + [`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, 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/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/). +* 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/). ## 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/frontend/A32/decoder/arm.h): +instruction table. Here is an example line from [`arm.h`](../../src/dynarmic/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/ir/ir_emitter.h). An example of a translation function follows: +help of the [`IREmitter` class](../../src/dynarmic/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/ir/opcodes.inc). +A complete list of microinstructions can be found in [src/dynarmic/ir/opcodes.inc](../../src/dynarmic/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} -```c++ +```cpp ReadMemory8( vaddr) ReadMemory16( vaddr) ReadMemory32( vaddr) @@ -288,7 +288,7 @@ Memory access. ### Terminal: ReturnToDispatch -```c++ +```cpp SetTerm(IR::Term::ReturnToDispatch{}) ``` @@ -297,7 +297,7 @@ The dispatcher will use the value in R15 to determine what comes next. ### Terminal: LinkBlock -```c++ +```cpp SetTerm(IR::Term::LinkBlock{next}) ``` @@ -307,7 +307,7 @@ dispatcher, which will return control to the host. ### Terminal: LinkBlockFast -```c++ +```cpp 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 -```c++ +```cpp 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 -```c++ +```cpp 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` -```c++ +```cpp 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` -```c++ +```cpp 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` -```c++ +```cpp 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. -```c++ +```cpp 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. -```c++ +```cpp 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. -```c++ +```cpp 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. -`RSBSize` was chosen by performance testing. Note that this is bigger than the +`RSB_SIZE` 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. -```c++ +```cpp struct JitState { // ... - static constexpr size_t RSBSize = 8; // MUST be a power of 2. + static constexpr size_t RSB_SIZE = 8; // MUST be a power of 2. u32 rsb_ptr = 0; - std::array rsb_location_descriptors; - std::array rsb_codeptrs; + std::array rsb_location_descriptors; + std::array 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`. -```c++ +```cpp 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::RSBSize - 1)); + code->and_(index_reg, u32(JitState::RSB_SIZE - 1)); code->mov(loc_desc_reg, u64(imm64)); CodePtr patch_location = code->getCurr(); @@ -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::RSBSize; ++i) { + for (size_t i = 0; i < JitState::RSB_SIZE; ++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: -```c++ - for (i := 0 .. RSBSize-1) +```cpp + for (i := 0 .. RSB_SIZE-1) if (rsb_location_descriptors[i] == imm64) goto label; rsb_ptr++; - rsb_ptr %= RSBSize; + rsb_ptr %= RSB_SIZE; 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. -```c++ +```cpp 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::RSBSize; ++i) { + for (size_t i = 0; i < JitState::RSB_SIZE; ++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: -```c++ +```cpp rbx := ComputeUniqueHash() rax := ReturnToDispatch -for (i := 0 .. RSBSize-1) +for (i := 0 .. RSB_SIZE-1) if (rbx == rsb_location_descriptors[i]) rax = rsb_codeptrs[i] goto rax diff --git a/docs/dynarmic/README.md b/docs/dynarmic/README.md index 376e1f6b37..0fa893d550 100644 --- a/docs/dynarmic/README.md +++ b/docs/dynarmic/README.md @@ -3,175 +3,20 @@ Dynarmic A dynamic recompiler for ARM. -Highlight features: +*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.* -- 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) +Cortex-A57 (32 and 64 bit) is the emulated guest target. See [ArchVersion](../../src/dynarmic/src/dynarmic/interface/A32/arch_version.h). -*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.* +The only supported host architectures are x86-64, and AArch64. There are no plans to support any 32-bit architectures. -### 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 -------------- +See [an example usage](../../src/dynarmic/tests/print_info.cpp). 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 -#include -#include -#include - -#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 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 @@ -189,8 +34,8 @@ More general alternatives: Disadvantages of Dynarmic ------------------------- -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. +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. Known examples: @@ -205,156 +50,6 @@ Use this code base at your own risk. Legal ----- -dynarmic is under a 0BSD license. See LICENSE.txt for more details. - -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 - -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. ------------------------------------------------------------------------------ -ソースコード形式かバイナリ形式か、変更するかしないかを問わず、以下の条件を満た -す場合に限り、再頒布および使用が許可されます。 +Dynarmic is under a GPLv3 license, check the relevant file headers for more information. -ソースコードを再頒布する場合、上記の著作権表示、本条件一覧、および下記免責条項 -を含めること。 -バイナリ形式で再頒布する場合、頒布物に付属のドキュメント等の資料に、上記の著作 -権表示、本条件一覧、および下記免責条項を含めること。 -書面による特別の許可なしに、本ソフトウェアから派生した製品の宣伝または販売促進 -に、著作権者の名前またはコントリビューターの名前を使用してはならない。 -本ソフトウェアは、著作権者およびコントリビューターによって「現状のまま」提供さ -れており、明示黙示を問わず、商業的な使用可能性、および特定の目的に対する適合性 -に関する暗黙の保証も含め、またそれに限定されない、いかなる保証もありません。 -著作権者もコントリビューターも、事由のいかんを問わず、 損害発生の原因いかんを -問わず、かつ責任の根拠が契約であるか厳格責任であるか（過失その他の）不法行為で -あるかを問わず、仮にそのような損害が発生する可能性を知らされていたとしても、 -本ソフトウェアの使用によって発生した（代替品または代用サービスの調達、使用の -喪失、データの喪失、利益の喪失、業務の中断も含め、またそれに限定されない）直接 -損害、間接損害、偶発的な損害、特別損害、懲罰的損害、または結果損害について、 -一切責任を負わないものとします。 -``` +Dynarmic uses several open-source libraries, whose licenses are included inside thereof. diff --git a/docs/policies/AI.md b/docs/policies/AI.md index d921f47054..554a805331 100644 --- a/docs/policies/AI.md +++ b/docs/policies/AI.md @@ -24,7 +24,7 @@ All code, AI or not, is held under a **strict standard of excellence**. AI/LLM-g ## Licensing concerns -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. +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. AI models may have also ingested AGPLv3 code, which is license-incompatible with our codebase. diff --git a/docs/policies/Coding.md b/docs/policies/Coding.md index a1d3987057..afc195d86c 100644 --- a/docs/policies/Coding.md +++ b/docs/policies/Coding.md @@ -24,8 +24,8 @@ Everyone has their own way of viewing good/bad C++ practices, my general outline - Exploit the fact `std::atomic/std::atomic` 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. - Avoid template parameters unless you really need them. - - 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. + - 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. @@ -37,7 +37,7 @@ Everyone has their own way of viewing good/bad C++ practices, my general outline - Function parameters are cheap. Don't be afraid to use as many as needed (API usability permitting). - Don't save a reference in structures of a parent object, i.e: - ```c++ + ```cpp struct Child { Parent& parent; void Mehod() { @@ -48,7 +48,7 @@ Everyone has their own way of viewing good/bad C++ practices, my general outline - Instead you can do the following: - ```c++ + ```cpp struct Child { void Mehod(Parent& parent) { parent.Something(); @@ -66,6 +66,6 @@ Programming, alongside the physical act of writing code, also consists of archit - 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 architecturing systems +- 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. diff --git a/docs/user/AlterDateTime.md b/docs/user/AlterDateTime.md index 22f989270d..f28df3df54 100644 --- a/docs/user/AlterDateTime.md +++ b/docs/user/AlterDateTime.md @@ -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. -**Click [Here](https://evilperson1337.notion.site/Setting-a-Custom-Date-Time-in-Eden-2b357c2edaf680acb8d4e63ccc126564) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Setting-a-Custom-Date-Time-in-Eden-2b357c2edaf680acb8d4e63ccc126564) for an illustrated guide.** --- diff --git a/docs/user/Architectures.md b/docs/user/Architectures.md index a03dbc0da8..d5f9acd74c 100644 --- a/docs/user/Architectures.md +++ b/docs/user/Architectures.md @@ -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,28 +52,32 @@ 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: -- HaikuOS -- FreeBSD -- OpenBSD -- NetBSD -- OpenIndiana (Solaris) -- macOS +- FreeBSD (amd64, aarch64) +- HaikuOS (amd64) +- OpenBSD (amd64) +- NetBSD (amd64) +- macOS (aarch64) +- OpenIndiana aka. OpenSolaris (amd64) ## 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. ## Windows -Windows 10 and 11 are supported. Support for Windows 8.x is unknown, and Windows 7 support is unlikely to ever be added. +Windows 10 and 11 are supported. Anything below is unsupported. -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). +To run Eden, you'll need to install [Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170). -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. +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. + +### Windows on ARM + +If you're using Snapdragon X or 8CX, install the [Vulkan translation layer](https://apps.microsoft.com/detail/9nqpsl29bfff?hl=en-us&gl=USE) only if the stock drivers don't work. And of course always keep your system up-to-date. ## Android @@ -123,13 +127,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 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. +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. -AMD GPU support on these platforms is limited or nonexistent. +AMD GPU support on these platforms is limited or nonexistent, bar for OpenBSD which has a dedicated AMD GPU stack. ## 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 whenever possible. +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. - 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). diff --git a/docs/user/Basics.md b/docs/user/Basics.md index 794a0935d5..2b7a99c8d0 100644 --- a/docs/user/Basics.md +++ b/docs/user/Basics.md @@ -2,13 +2,13 @@ ## Introduction -Eden is a very complicated piece of software, and as such there are many knobs and toggles that can be configured. Most of these are invisible to normal users, however power users may be able to leverage them to their advantage. +Eden is a very complicated piece of software, there are many knobs and toggles that can be configured. Most of these are invisible to normal users, however, power users may be able to leverage them to their advantage. This handbook primarily describes such knobs and toggles. Normal configuration options are described within the emulator itself and will not be covered in detail. ## Requirements -The emulator is very demanding on hardware, and as such requires a decent mid-range computer/cellphone. +The emulator is very demanding on hardware and requires a decent mid-range computer/cellphone. See [the requirements page](https://archive.is/sv83h) for recommended and minimum specs. @@ -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 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. +- 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. ## 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 that instead. +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. ### Environment variables @@ -64,4 +64,4 @@ Then just running `chmod +x script.sh && source script.sh`. ## Compatibility list -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. +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. diff --git a/docs/user/CFW.md b/docs/user/CFW.md index 8f37672eb1..e9213e5dac 100644 --- a/docs/user/CFW.md +++ b/docs/user/CFW.md @@ -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. +Fusée Gelée, the bootloader and other low-level mechanisms are not emulated at the moment. Having OFW is recommended, but may not be required (untested). diff --git a/docs/user/CommandLine.md b/docs/user/CommandLine.md index 51542115e3..b8d71ac61f 100644 --- a/docs/user/CommandLine.md +++ b/docs/user/CommandLine.md @@ -4,7 +4,7 @@ There are two main applications, an SDL-based app (`eden-cli`) and a Qt based ap ## eden -- `./eden `: 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. +- `./eden `: 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. - `-g `: 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 `: Select the index of the user to load as. diff --git a/docs/user/Controllers.md b/docs/user/Controllers.md index 8696612220..9f9a94878c 100644 --- a/docs/user/Controllers.md +++ b/docs/user/Controllers.md @@ -1,12 +1,12 @@ # User Handbook - Controllers -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: +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: - https://github.com/dkosmari/calibrate-joystick ## Using external controllers on the Steamdeck -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. +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. 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. -**Click [Here](https://evilperson1337.notion.site/Configuring-Controller-Profiles-2be57c2edaf680eabc3ac8c333ec75c4) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Configuring-Controller-Profiles-2be57c2edaf680eabc3ac8c333ec75c4) for an illustrated guide.** --- @@ -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. -**Click [Here](https://evilperson1337.notion.site/Setting-Controller-Profiles-By-Game-2b057c2edaf681658a57f0c199cb6083) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Setting-Controller-Profiles-By-Game-2b057c2edaf681658a57f0c199cb6083) for an illustrated guide.** --- @@ -47,7 +47,6 @@ 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. --- diff --git a/docs/user/Graphics.md b/docs/user/Graphics.md index 4d3b1da3c7..4928eb47ff 100644 --- a/docs/user/Graphics.md +++ b/docs/user/Graphics.md @@ -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: -```cmd +```bat @echo off pushd "%~dp0" if exist "%temp%\FixFullScreen.reg" ( diff --git a/docs/user/GyroControls.md b/docs/user/GyroControls.md index 9ac23f37b0..7d7eee6872 100644 --- a/docs/user/GyroControls.md +++ b/docs/user/GyroControls.md @@ -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. -**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.** +**[See here](https://evilperson1337.notion.site/Getting-Gyro-Motion-Controls-Working-on-Steam-Deck-2b057c2edaf681a1aaade35db6e0fd1b) for an illustrated guide.** ## Steamdeck diff --git a/docs/user/HowToAccessLogs.md b/docs/user/HowToAccessLogs.md index 826ead382c..6019e59bfc 100644 --- a/docs/user/HowToAccessLogs.md +++ b/docs/user/HowToAccessLogs.md @@ -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. -**Click [Here](https://evilperson1337.notion.site/How-to-Access-Logs-2b057c2edaf68105a281fe1688a332d4) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/How-to-Access-Logs-2b057c2edaf68105a281fe1688a332d4) for an illustrated guide.** --- diff --git a/docs/user/ImportingSaves.md b/docs/user/ImportingSaves.md index 428609f69c..b936e2d32b 100644 --- a/docs/user/ImportingSaves.md +++ b/docs/user/ImportingSaves.md @@ -2,7 +2,7 @@ Use this guide when you want to manually import save files for use in the Eden emulator. -**Click [Here](https://evilperson1337.notion.site/Importing-Saves-Into-Eden-2b057c2edaf681fe968df8d63821ccae) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Importing-Saves-Into-Eden-2b057c2edaf681fe968df8d63821ccae) for an illustrated guide.** ### Pre-Requisites - Eden emulator already set up and configured. diff --git a/docs/user/InstallingAtmosphereMods.md b/docs/user/InstallingAtmosphereMods.md index ae8e4b37d2..689ed88e16 100644 --- a/docs/user/InstallingAtmosphereMods.md +++ b/docs/user/InstallingAtmosphereMods.md @@ -2,7 +2,7 @@ Use this guide for when you want to install an Atmosphere-based mod for use in Eden. -**Click [Here](https://evilperson1337.notion.site/Installing-Atmosphere-Mods-2b057c2edaf681fe8d39cbfc2d0cc799) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Installing-Atmosphere-Mods-2b057c2edaf681fe8d39cbfc2d0cc799) for an illustrated guide.** --- diff --git a/docs/user/InstallingUpdatesDLC.md b/docs/user/InstallingUpdatesDLC.md index 70cd821af8..e012a58ca5 100644 --- a/docs/user/InstallingUpdatesDLC.md +++ b/docs/user/InstallingUpdatesDLC.md @@ -8,7 +8,7 @@ Use this guide when you want to install Updates or DLC for your games in Eden. -**Click [Here](https://evilperson1337.notion.site/Working-with-Updates-DLC-in-Eden-2b057c2edaf681dfb65dfc4dd96980c0) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Working-with-Updates-DLC-in-Eden-2b057c2edaf681dfb65dfc4dd96980c0) for an illustrated guide.** --- diff --git a/docs/user/Multiplayer.md b/docs/user/Multiplayer.md index a701ec0409..37581240cf 100644 --- a/docs/user/Multiplayer.md +++ b/docs/user/Multiplayer.md @@ -4,7 +4,7 @@ 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. -**Click [Here](https://evilperson1337.notion.site/Multiplayer-FAQ-2c357c2edaf680fca2e9ce59969a220f) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Multiplayer-FAQ-2c357c2edaf680fca2e9ce59969a220f) for an illustrated guide.** ### 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. @@ -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 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. + 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. 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. -**Click [Here](https://evilperson1337.notion.site/Access-Your-Multiplayer-Room-Externally-2c357c2edaf681c0ab2ce2ee624d809d) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Access-Your-Multiplayer-Room-Externally-2c357c2edaf681c0ab2ce2ee624d809d) for an illustrated guide.** ### Pre-Requisites - Eden set up and functioning @@ -66,7 +66,7 @@ There are 2 primary methods that you can use to connect to an existing room, dep @@ -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 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. +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. 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.** +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.** 3. You will now see a window showing everyone on the lobby, or an error message. --- @@ -93,7 +93,7 @@ If the hoster has not made the lobby public, or you don't want to find it in the ## 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. -**Click [Here](https://evilperson1337.notion.site/Hosting-a-Multiplayer-Room-2c357c2edaf6819481dbe8a99926cea2) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Hosting-a-Multiplayer-Room-2c357c2edaf6819481dbe8a99926cea2) for an illustrated guide.** ### Pre-Requisites - Eden set up and Functioning @@ -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. -**Click [Here](https://evilperson1337.notion.site/Access-Your-Multiplayer-Room-Externally-2c357c2edaf681c0ab2ce2ee624d809d) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Access-Your-Multiplayer-Room-Externally-2c357c2edaf681c0ab2ce2ee624d809d) for an illustrated guide.** ### Pre-Requisites - Eden set up and Functioning @@ -137,7 +137,7 @@ Quite often the person with whom you want to play is located off of your interna @@ -155,7 +155,7 @@ Remember you can't have one port open for multiple devices at the same time - yo @@ -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. -**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.** +**[See here](https://evilperson1337.notion.site/Finding-the-Server-Information-for-a-Multiplayer-Room-2c557c2edaf6809e94e8ed3429b9eb26) for an illustrated guide.** ### Pre-Requisites - Eden set up and configured @@ -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. -**Click [Here](https://evilperson1337.notion.site/Multiplayer-for-Local-Co-Op-Games-2c657c2edaf680c59975ec6b52022a2d) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Multiplayer-for-Local-Co-Op-Games-2c657c2edaf680c59975ec6b52022a2d) for an illustrated guide.** 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. diff --git a/docs/user/Native.md b/docs/user/Native.md index 0d8ee81a7a..1150f825bd 100644 --- a/docs/user/Native.md +++ b/docs/user/Native.md @@ -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 atleast. +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 **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 accoutned 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 accounted for. Region settings will affect the generated serial. The serial corresponds to a non-OLED/Lite console. diff --git a/docs/user/QuickStart.md b/docs/user/QuickStart.md index de644cbb08..4e553d07c9 100644 --- a/docs/user/QuickStart.md +++ b/docs/user/QuickStart.md @@ -2,7 +2,7 @@ Use this guide to get starting using the Eden emulator. -**Click [Here](https://evilperson1337.notion.site/Eden-Quick-Start-2b057c2edaf6817b9859d8bcdb474017) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Eden-Quick-Start-2b057c2edaf6817b9859d8bcdb474017) for an illustrated guide.** ## Windows @@ -80,7 +80,7 @@ Use this guide to get starting using the Eden emulator. ## 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. +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. @@ -90,7 +90,7 @@ As of writing, neither macOS nor Asahi has support for NCE; additionally Asahi h 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.** +**[See here](https://evilperson1337.notion.site/Allowing-Eden-to-Run-on-MacOS-2b057c2edaf681fea63dc81027efeffd) for an illustrated guide.** --- diff --git a/docs/user/README.md b/docs/user/README.md index 48b107958b..a444cfead9 100644 --- a/docs/user/README.md +++ b/docs/user/README.md @@ -49,6 +49,4 @@ 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)** diff --git a/docs/user/ServerHosting.md b/docs/user/ServerHosting.md index bfd85c0bb4..8b31cd61a6 100644 --- a/docs/user/ServerHosting.md +++ b/docs/user/ServerHosting.md @@ -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 (Handeld by SSH), Destination: Blank/Auto (Handeld 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 (Handled by SSH), Destination: Blank/Auto (Handled 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. diff --git a/docs/user/Settings.md b/docs/user/Settings.md index a71972934c..db69bb3b3b 100644 --- a/docs/user/Settings.md +++ b/docs/user/Settings.md @@ -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 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. +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. ## Foreword -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. +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. ## General @@ -25,15 +25,15 @@ Before touching the settings, please see the game boots with stock options. We t ## System -- `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. +- `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. - `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 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/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/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 dpeending on these rounding modes may misbehave. +- `CPU/Faster ASIMD Instructions`: Skips rounding mode checks for ARM ASIMD instructions - this means some code depending 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. diff --git a/docs/user/SteamROM.md b/docs/user/SteamROM.md index 28ad7f7e6e..8942e257c0 100644 --- a/docs/user/SteamROM.md +++ b/docs/user/SteamROM.md @@ -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.* -**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.** +**[See here](https://evilperson1337.notion.site/Importing-Eden-into-Steam-with-Steam-Rom-Manager-2b757c2edaf68054851bc287b6382cb5) for an illustrated guide.** --- @@ -114,7 +114,7 @@ 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**: + 5. **ROMs Directory**: 6. **Steam Collections**: *Emulation* (OPTIONAL) 2. Parser Specific Configuration 1. **Search Glob**: *${title}@(.AppImage|.APPIMAGE|.appimage)* @@ -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. -**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.** +**[See here](https://evilperson1337.notion.site/Importing-Games-into-Steam-with-Steam-Rom-Manager-2b757c2edaf680d7a491c92b138f1fcc) for an illustrated guide.** --- diff --git a/docs/user/SyncthingGuide.md b/docs/user/SyncthingGuide.md index c41682dc6a..bef8a3774c 100644 --- a/docs/user/SyncthingGuide.md +++ b/docs/user/SyncthingGuide.md @@ -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/). -**Click [Here](https://evilperson1337.notion.site/Backing-Up-Syncing-Eden-Game-Saves-2b357c2edaf68000b40cfab2c2c3dc0a) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Backing-Up-Syncing-Eden-Game-Saves-2b357c2edaf68000b40cfab2c2c3dc0a) for an illustrated guide.** ### Pre-Requisites diff --git a/docs/user/Testing.md b/docs/user/Testing.md index eb3beeb37c..b1af94147d 100644 --- a/docs/user/Testing.md +++ b/docs/user/Testing.md @@ -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 atleast 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 at least 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](./user/ThirdParty.md#mirrors). +- If site is down use one of the [mirrors](./ThirdParty.md#mirrors). diff --git a/docs/user/ThirdParty.md b/docs/user/ThirdParty.md index ddef56a681..2e7bc63f6f 100644 --- a/docs/user/ThirdParty.md +++ b/docs/user/ThirdParty.md @@ -1,8 +1,8 @@ # 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 specialised 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 specialized 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 appropriatedly 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 appropriately 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) @@ -18,13 +18,13 @@ The main origin repository is always at 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: (or one of your favourite mirrors) +1. Copy the URL: (or one of your favorite 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)`. diff --git a/docs/user/Troubleshoot.md b/docs/user/Troubleshoot.md index 5553d8d528..76d69e38f9 100644 --- a/docs/user/Troubleshoot.md +++ b/docs/user/Troubleshoot.md @@ -14,7 +14,7 @@ ## Eden Fails to Launch and Does Not Leave Any Logs -**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.** +**[See here](https://evilperson1337.notion.site/Windows-Eden-Fails-to-Launch-and-Does-Not-Leave-Any-Logs-2b057c2edaf68156b640cf1ac549870a) for an illustrated guide.** ### 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 @@ -73,7 +73,7 @@ Faulting package-relative application ID: 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 ``` diff --git a/docs/user/UsingAmiibo.md b/docs/user/UsingAmiibo.md index a587334f45..112693ec79 100644 --- a/docs/user/UsingAmiibo.md +++ b/docs/user/UsingAmiibo.md @@ -2,7 +2,7 @@ Use this guide when you want to load Amiibo into your games for use with the Eden emulator. -**Click [Here](https://evilperson1337.notion.site/Using-Amiibo-with-Eden-2b057c2edaf681b1b28ec6be600c6d3e) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Using-Amiibo-with-Eden-2b057c2edaf681b1b28ec6be600c6d3e) for an illustrated guide.** ## Android @@ -17,7 +17,7 @@ TBD @@ -37,7 +37,7 @@ TBD diff --git a/docs/user/UsingCheats.md b/docs/user/UsingCheats.md index e91cef3c61..d6ad7b634a 100644 --- a/docs/user/UsingCheats.md +++ b/docs/user/UsingCheats.md @@ -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. -**Click [Here](https://evilperson1337.notion.site/Using-Cheats-with-Eden-2b057c2edaf6818fab66c276e2304bb4) for a version of this guide with images & visual elements.** +**[See here](https://evilperson1337.notion.site/Using-Cheats-with-Eden-2b057c2edaf6818fab66c276e2304bb4) for an illustrated guide.** ## Android diff --git a/tools/README.md b/tools/README.md index d4f5aa1baa..cde6a21464 100644 --- a/tools/README.md +++ b/tools/README.md @@ -9,7 +9,7 @@ Tools for Eden and other subprojects. When adding new scripts please use `#!/bin ## Binaries - `maxwell-spirv`: Converts Maxwell shaders (dumped from `.ash` files) into SPIR-V code (emitted into STDOUT). -- `maxwell-disas`: Dumb raw Maxwell dissasembler. +- `maxwell-disas`: Dumb raw Maxwell disassembler. - `maxwell-ir`: Dump generated IR of Maxwell shaders. ## Scripts @@ -32,7 +32,8 @@ Tools for Eden and other subprojects. When adding new scripts please use `#!/bin - `fuzzsettings.cpp`: Fuzz settings files. ## Android -It's recommended to run these scritps after almost any Android change, as they are relatively fast and important both for APK bloat and CI. + +It's recommended to run these scripts after almost any Android change, as they are relatively fast and important both for APK bloat and CI. - `unused-strings.sh`: Finds unused strings in `strings.xml` files. - `stale-translations.sh`: Finds translated strings that aren't present in the source `strings.xml` file.