eden-emu/eden
24
3
Fork 15
Code Issues 138 Pull requests 56 Projects 1 Releases Packages Wiki Activity Actions

[docs] initial user handbook draft #2629

Merged
CamilleLaVey merged 9 commits from user-handbook-1 into master 2025-10-05 20:44:49 +02:00
Conversation 4 Commits 9 Files changed 7 +261 -9
Lizzie commented 2025-09-30 09:08:29 +02:00
Member
Copy link

This is the initial draft of a "User Handbook", or FAQ. Currently contains useful info on the basics, graphics, and architecture/platform info.

Archive.org OR archive.is should be used for linking external websites, especially since their content should not change. And most often than not, in a few years these could change.

Signed-off-by: lizzie lizzie@eden-emu.dev

This is the initial draft of a "User Handbook", or FAQ. Currently contains useful info on the basics, graphics, and architecture/platform info. Archive.org OR archive.is should be used for linking external websites, especially since their content should not change. And most often than not, in a few years these could change. Signed-off-by: lizzie <lizzie@eden-emu.dev>
Lizzie added 1 commit 2025-09-30 09:08:29 +02:00
[docs] initial user handbook draft
All checks were successful
eden-license / license-header (pull_request) Successful in 20s
Details
84ac6983c7 
Signed-off-by: lizzie <lizzie@eden-emu.dev>
requested reviews from CamilleLaVey, Maufeat, crueter, MrPurple666, MaranBr 2025-09-30 09:08:29 +02:00
Lizzie changed title from [docs] initial user handbook draft to WIP: [docs] initial user handbook draft 2025-09-30 18:30:45 +02:00
crueter requested changes 2025-09-30 19:11:26 +02:00
Dismissed
docs/user/Graphics.md Outdated
@ -0,0 +24,4 @@
- **ScaleForce**: Experimental texture upscale method, see [ScaleFish](https://github.com/BreadFish64/ScaleFish).
- **FSR**: Uses AMD FidelityFX Super Resolution to enhance image quality.
- **Area**: Area interpolation (high kernel count).
- **MMPX**: Nearest-neighbour filter aimed at providing higher pixel-art quality.
crueter commented 2025-09-30 19:10:58 +02:00
Owner
Copy link

Each of these should reference cons/pros (e.g. fsr is great at upscaling but a little sharp, area is good at downscaling etc)

Each of these should reference cons/pros (e.g. fsr is great at upscaling but a little sharp, area is good at downscaling etc)
crueter marked this conversation as resolved
docs/user/Graphics.md Outdated
@ -0,0 +28,4 @@
### 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.
crueter commented 2025-09-30 19:11:18 +02:00
Owner
Copy link

OR Mods

OR Mods
crueter marked this conversation as resolved
Lizzie added 1 commit 2025-09-30 20:20:08 +02:00
more docs
All checks were successful
eden-license / license-header (pull_request) Successful in 29s
Details
e2f340dcf9 
Signed-off-by: lizzie <lizzie@eden-emu.dev>
crueter reviewed 2025-09-30 20:33:26 +02:00
docs/user/Basics.md Outdated
@ -0,0 +20,4 @@
- **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.
crueter commented 2025-09-30 20:33:26 +02:00
Owner
Copy link

These are wrong for the most part and should just link to the website

These are wrong for the most part and should just link to the website
Lizzie commented 2025-09-30 20:38:34 +02:00
Author
Member
Copy link

Those are my specs

Those are my specs
crueter commented 2025-09-30 20:41:37 +02:00
Owner
Copy link

Those aren't the "recommended" specs at all and in fact some are the minimum. The website always has more accurate info because I'm constantly updating it, just copy the data from there or link to an archive of it

Those aren't the "recommended" specs at all and in fact some are the minimum. The website always has more accurate info because I'm constantly updating it, just copy the data from there or link to an archive of it
crueter marked this conversation as resolved
Lizzie added 1 commit 2025-09-30 20:41:28 +02:00
link website
All checks were successful
eden-license / license-header (pull_request) Successful in 23s
Details
015c1c5855 
Signed-off-by: lizzie <lizzie@eden-emu.dev>
crueter added 1 commit 2025-10-05 07:01:50 +02:00
architectures/platforms guide
All checks were successful
eden-license / license-header (pull_request) Successful in 21s
Details
9e585930e2 
Signed-off-by: crueter <crueter@eden-emu.dev>
crueter added 1 commit 2025-10-05 07:02:14 +02:00
typo
All checks were successful
eden-license / license-header (pull_request) Successful in 21s
Details
6d2d15d012 
Signed-off-by: crueter <crueter@eden-emu.dev>
crueter added 1 commit 2025-10-05 07:02:33 +02:00
typo2
All checks were successful
eden-license / license-header (pull_request) Successful in 27s
Details
f00b046dc0 
Signed-off-by: crueter <crueter@eden-emu.dev>
crueter added 1 commit 2025-10-05 07:06:48 +02:00
a
All checks were successful
eden-license / license-header (pull_request) Successful in 26s
Details
c1e066f837 
Signed-off-by: crueter <crueter@eden-emu.dev>
crueter added 1 commit 2025-10-05 07:11:29 +02:00
fix some wording
All checks were successful
eden-license / license-header (pull_request) Successful in 22s
Details
50410374af 
Signed-off-by: crueter <crueter@eden-emu.dev>
crueter force-pushed user-handbook-1 from 50410374af to 5279489408 2025-10-05 07:12:59 +02:00 Compare
crueter added 1 commit 2025-10-05 20:42:07 +02:00
something
All checks were successful
eden-license / license-header (pull_request) Successful in 27s
Details
b201c73689 
Signed-off-by: crueter <crueter@eden-emu.dev>
crueter changed title from WIP: [docs] initial user handbook draft to [docs] initial user handbook draft 2025-10-05 20:42:11 +02:00
requested review from crueter 2025-10-05 20:42:11 +02:00
crueter approved these changes 2025-10-05 20:43:09 +02:00
CamilleLaVey approved these changes 2025-10-05 20:44:24 +02:00
CamilleLaVey merged commit f6d99e5032 into master 2025-10-05 20:44:49 +02:00
CamilleLaVey deleted branch user-handbook-1 2025-10-05 20:44:49 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Maufeat
MrPurple666
MaranBr
crueter
CamilleLaVey
Labels
Clear labels   
android

Specific to android platform

  
audio

   
bug

Something is not working

  
ci

For changes to the ci/building

  
confirmed

Used when testers confirm a bug is reported and it is reproducable.

  
core

For core changes to the emulator

  
desktop

Specific to desktop PCs, handhelds, etc.

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
frontend

Frontend changes

  
fw

Changes related to firmware

  
git

For enhancements or changes regarding git.

  
graphics

   
loader

For changes to any of the loader implementations

  
nv gpu

For use with changes that involve the emulator GPU and any services.

  
ui
No labels
android
audio
bug
ci
confirmed
core
desktop
duplicate
enhancement
frontend
fw
git
graphics
loader
nv gpu
ui
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: eden-emu/eden#2629
No description provided.
Delete branch "user-handbook-1"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?