more docs
All checks were successful
eden-license / license-header (pull_request) Successful in 29s

Signed-off-by: lizzie <lizzie@eden-emu.dev>
This commit is contained in:
lizzie 2025-09-30 18:19:08 +00:00
parent 84ac6983c7
commit e2f340dcf9
Signed by: Lizzie
GPG key ID: 00287378CADCAB13
4 changed files with 42 additions and 1 deletions

View file

@ -3,4 +3,5 @@
This handbook is primarily aimed at the end-user - baking useful knowledge for enhancing their emulation experience. This handbook is primarily aimed at the end-user - baking useful knowledge for enhancing their emulation experience.
- **[The Basics](docs/Basics.md)** - **[The Basics](docs/Basics.md)**
- **[Audio](user/Audio.md)**
- **[Graphics](user/Graphics.md)** - **[Graphics](user/Graphics.md)**

3
docs/user/Audio.md Normal file
View file

@ -0,0 +1,3 @@
# User Handbook - Audio
`PULSE_SERVER=none` forces cubeb to use ALSA.

View file

@ -6,6 +6,26 @@ Eden is a very complicated piece of software, and as such there are many knobs a
This handbook primarily describes such knobs and toggles. Normal configuration options are described within the emulator itself and will not be covered in detail. 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.
### Minimum
- **CPU**: Intel i3-650 / AMD FX-8350 / Qualcomm Snapdragon 460.
- **GPU**: NVIDIA GT 640 / AMD Radeon HD 7330M.
- **RAM**: 8GB with dedicated GPU, 12GB with iGPU
### Recommended
- **CPU**: Intel i7-4790 / AMD Ryzen 3 3200U / Qualcomm Snapdragon 865.
- **GPU**: NVIDIA GT 1030 / AMD Radeon HD 7970M X2.
- **RAM**: 12GB with dedicated GPU, 16GB with iGPU.
The CPU must support FMA for an optimal gameplay experience. GPU needs to support OpenGL 4.6, see [OpenGL compatibility list](https://opengl.gpuinfo.org/), or Vulkan 1.1, see [Vulkan compatibility list](https://vulkan.gpuinfo.org/).
If your GPU doesn't support or is just behind by a minor version, see Mesa environment variables below (*nix only).
## User configuration ## User configuration
### Configuration directories ### Configuration directories

View file

@ -15,20 +15,37 @@ Enhancements aimed at removing jagged lines/sharp edges and/or masking artifacts
Various graphical filters exist - each of them aimed at a specific target/image quality preset. Various graphical filters exist - each of them aimed at a specific target/image quality preset.
- **Nearest**: Provides no filtering - useful for debugging. - **Nearest**: Provides no filtering - useful for debugging.
- **Pros**: Fast, works in any hardware.
- **Cons**: Less image quality.
- **Bilinear**: Provides the hardware default filtering of the Tegra X1. - **Bilinear**: Provides the hardware default filtering of the Tegra X1.
- **Pros**: Fast with acceptable image quality.
- **Bicubic**: Provides a bicubic interpolation using a Catmull-Rom (or hardware-accelerated) implementation. - **Bicubic**: Provides a bicubic interpolation using a Catmull-Rom (or hardware-accelerated) implementation.
- **Pros**: Better image quality with more rounded edges.
- **Zero-Tangent, B-Spline, Mitchell**: Provides bicubic interpolation using the respective matrix weights. They're normally not hardware accelerated unless the device supports the `VK_QCOM_filter_cubic_weights` extension. The matrix weights are those matching [the specification itself](https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VkSamplerCubicWeightsCreateInfoQCOM). - **Zero-Tangent, B-Spline, Mitchell**: Provides bicubic interpolation using the respective matrix weights. They're normally not hardware accelerated unless the device supports the `VK_QCOM_filter_cubic_weights` extension. The matrix weights are those matching [the specification itself](https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VkSamplerCubicWeightsCreateInfoQCOM).
- **Pros/Cons**: Each of them is a variation of the Bicubic interpolation model with different weights, they offer different methods to fix some artifacts present in Catmull-Rom.
- **Spline-1**: Bicubic interpolation (similar to Mitchell) but with a faster texel fetch method. Generally less blurry than bicubic. - **Spline-1**: Bicubic interpolation (similar to Mitchell) but with a faster texel fetch method. Generally less blurry than bicubic.
- **Pros**: Faster than bicubic even without hardware accelerated bicubic.
- **Gaussian**: Whole-area blur, an applied gaussian blur is done to the entire frame. - **Gaussian**: Whole-area blur, an applied gaussian blur is done to the entire frame.
- **Pros**: Less edge artifacts.
- **Cons**: Slow and has blurrier image.
- **Lanczos**: An implementation using `a = 3` (49 texel fetches). Provides sharper edges but blurrier artifacts. - **Lanczos**: An implementation using `a = 3` (49 texel fetches). Provides sharper edges but blurrier artifacts.
- **Pros**: Less edge artifacts and less blurry than gaussian.
- **Cons**: Slow but with less blurriness.
- **ScaleForce**: Experimental texture upscale method, see [ScaleFish](https://github.com/BreadFish64/ScaleFish). - **ScaleForce**: Experimental texture upscale method, see [ScaleFish](https://github.com/BreadFish64/ScaleFish).
- **Pros**: Relatively fast.
- **FSR**: Uses AMD FidelityFX Super Resolution to enhance image quality. - **FSR**: Uses AMD FidelityFX Super Resolution to enhance image quality.
- **Pros**: Great for upscaling, and offers more sharp visual quality.
- **Cons**: Costly and slow.
- **Area**: Area interpolation (high kernel count). - **Area**: Area interpolation (high kernel count).
- **Pros**: Decent for downscaling.
- **Cons**: Costly and slow.
- **MMPX**: Nearest-neighbour filter aimed at providing higher pixel-art quality. - **MMPX**: Nearest-neighbour filter aimed at providing higher pixel-art quality.
- **Pros**: Offers decent pixel-art upscaling.
- **Cons**: Only works for pixel-art.
### External ### External
While stock shaders offer a basic subset of options for most users, programs such as [ReShade](https://github.com/crosire/reshade) offer a more flexible experience. While stock shaders offer a basic subset of options for most users, programs such as [ReShade](https://github.com/crosire/reshade) offer a more flexible experience. In addition to that users can also seek out modifications (mods) for enhancing visual experience (60 FPS mods, HDR, etc).
## Driver specifics ## Driver specifics