Xargon/RetroDECK
1
0
Fork 0
mirror of https://github.com/RetroDECK/RetroDECK.git synced 2025-03-03 06:00:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Wiki tests

Browse source
This commit is contained in:
Lazorne 2023-11-28 16:49:28 +01:00
parent 569d180e65
commit f0f84292ee
6 changed files with 37 additions and 205 deletions

5
wiki-rtd/docs/index.md
View file

@ -2,10 +2,11 @@
<img src="https://github.com/XargonWan/RetroDECK/blob/main/res/logo.png?raw=true" alt="RetroDECK logo" width="400"/> <img src="https://github.com/XargonWan/RetroDECK/blob/main/res/logo.png?raw=true" alt="RetroDECK logo" width="400"/>
</p> </p>
# Please use this wiki: # Please use this wiki:
We are in the process of migrating to MKDocs, but most information is still here: We are in the process of migrating to MKDocs, but most information is still here:<br>
https://github.com/XargonWan/RetroDECK/wiki [Old Wiki](https://github.com/XargonWan/RetroDECK/wiki)
# Welcome to the **RetroDECK wiki**! # Welcome to the **RetroDECK wiki**!

31
wiki-rtd/docs/wiki_about/visions-and-goals.md Normal file
View file

@ -0,0 +1,31 @@
# Whats the long term vision and goals of the RetroDECK project?
The long term vision and goals of the project is an all-in-one application to manage your entire retro games library that is:
- Already configured and should just work with your games.
- Has disaster recovery and multi device support: with cloud saves and syncs.
- Easy to install with one click installation.
- Easy to use and provide a "Console-like / Batocera-like" featured user experience.
- Easy to manage your collections of roms, mods and romhacks.
- As much as possible should be configurable from inside RetroDECK itself without needing to exiting the application.
- Make tighter integrations with bundled emulators and expose more features and ways to handle them to the end users.
- Should be secure, safe, and stable.
- Should have an easy way to mange external controllers and other inputs.
- Should support a majority of all supported Emulators in ES-DE, so at least you have one good option per system.
- Should in the long run support applications outside of the scope of ES-DE via a ports manager.
- Should be plug and play and fill the need for a portable retro gaming solution that you can bring on the go to a friend’s/family/others house. Just dock into the TV and get going!
- Should fully support Steam Deck, Linux Desktop, other SteamOS or Linux based devices.
- AND MORE

0
wiki-rtd/docs/wiki_general/what-is-retrodeck.md → wiki-rtd/docs/wiki_about/what-is-retrodeck.md
View file

5
wiki-rtd/mkdocs.yml
View file

@ -1,6 +1,7 @@
site_name: RetroDECK Wiki site_name: RetroDECK Wiki
site_url:
nav: nav:
- Home: index.md - Home: index.md
- What is RetroDECK?: wiki_general/what-is-retrodeck.md - About RetroDECK:
- What is RetroDECK?: wiki_about/what-is-retrodeck.md
- Visions & Goals: wiki_about/visions-and-goals.md
theme: readthedocs theme: readthedocs

30
wiki-rtd/old/index.md
View file

@ -1,30 +0,0 @@
<p float="center">
<img src="https://github.com/XargonWan/RetroDECK/blob/main/res/logo.png?raw=true" alt="RetroDECK logo" width="400"/>
</p>
# Welcome to the **RetroDECK wiki**!
🏗️ This wiki is currently under construction 🏗️
![Flathub](https://img.shields.io/flathub/downloads/net.retrodeck.retrodeck)
![Flathub](https://img.shields.io/flathub/v/net.retrodeck.retrodeck)
![Discord](https://img.shields.io/discord/951662718102962256?label=discord)
![GitHub](https://img.shields.io/github/license/XargonWan/RetroDECK)
.. toctree::
:maxdepth: 2
:hidden:
:caption: 🚀 Tutorials
/wiki_misc/archive.md
### The RetroDECK community:
[Website](https://retrodeck.net) <br/>
[Discord](https://discord.gg/Dz3szYsP8g)<br/>
[Lemmy](https://lemmy.zip/c/retrodeck)<br/>
[Subreddit](https://www.reddit.com/r/retrodeck)<br/>

171
wiki-rtd/old/wiki_misc/Archive.md
View file

@ -1,171 +0,0 @@
# Archive
The Archive have some legacy information from the wiki, for those that would want to read it or run some older version of RetroDECK.
# Legacy included Themes
## Alekfull NX (Light)
| System View | Gamelist View |
|----|----|
| ![rd-theme-AlekfullNXLight-SystemView](https://user-images.githubusercontent.com/1454947/193457765-e56875cd-a34d-4675-8267-56d04d4d1c32.jpeg) | ![rd-theme-AlekfullNXLight-GamelistView](https://user-images.githubusercontent.com/1454947/193457762-4d997ca3-d77c-4993-81bb-0c1a78f240a1.jpeg) |
**Description:** <br>
Alekfull NX was inspired by the straightforward and intuitive interface of the Nintendo Switch and offers a similar experience but with a light retro twist.
Source: [Alekfull NX (Light)](https://github.com/anthonycaccese/alekfull-nx-retropie/tree/retro-deck-esde-1.x-light)<br>
Ported and remixed by: [anthonycaccese](https://github.com/anthonycaccese)<br>
Ported from: [Alekfull-NX for Batocera](https://github.com/fagnerpc/Alekfull-NX)<br>
Original creator: [fagnerpc](https://github.com/fagnerpc)
## Retrofix Revisited
| System View | Gamelist View |
|----|----|
| ![rd-theme-RetrofixRevisited-SystemView](https://user-images.githubusercontent.com/1454947/193457596-05dc4316-9f2a-41ae-aa27-9609c680ec5a.jpeg) | ![rd-theme-RetrofixRevisited-GamelistView](https://user-images.githubusercontent.com/1454947/193457594-b803546b-36eb-4e71-9eca-bfee1d81ba36.jpeg) |
**Description:** <br>
Retrofix Revisited is a theme where the goal is to showcase that the art of video games can be more interesting than the games themselves.
Source: [Retrofix Revisited](https://github.com/anthonycaccese/retrofix-revisited-retropie)<br>
Ported and remixed by: [anthonycaccese](https://github.com/anthonycaccese)<br>
Ported from: [ES Theme Retrofix for Batocera](https://github.com/20GotoTen/es-theme-retrofix)<br>
Original creator: [20GotoTen](https://github.com/20GotoTen)<br>
## Slate-DE
| System View | Gamelist View |
|----|----|
| ![rd-SlateDE-SystemView](https://user-images.githubusercontent.com/1454947/193464197-14cb8c12-77ea-4b8b-965f-fa51a5d004b9.jpeg) | ![rd-SlateDE-GamelistView](https://user-images.githubusercontent.com/1454947/193464213-b73f18a3-840d-4cab-bac2-268bc51fbc03.jpeg) |
**Description:** <br>
Slate-DE is based on the community created theme Recalbox-Multi for Recalbox.
Source: [slate-DE](https://gitlab.com/es-de/emulationstation-de/-/tree/master/themes/slate-DE)<br>
Created by: [LeonSE from ES-DE](https://gitlab.com/es-de)<br>
Inspired by: [Recalbox-Multi](https://gitlab.com/recalbox/recalbox-themes/-/tree/master/themes/recalbox-multi)
## Modern-DE
| System View | Gamelist View |
|----|----|
| ![rd-ModernDE-SystemView](https://user-images.githubusercontent.com/1454947/193464329-938c5b68-6ae9-4ab6-8ac7-e7312e9698c5.jpeg) | ![rd-ModernDE-GamelistView](https://user-images.githubusercontent.com/1454947/193464333-890444ed-dd85-4322-8056-c3be8df6cad2.jpeg) |
**Description:** <br>
Modern-DE is based on ES-Theme-Switch for RetroPie, a lightweight Switch inspired theme.
Source: [Modern-DE](https://gitlab.com/es-de/emulationstation-de/-/tree/master/themes/modern-DE)<br>
Created by: [LeonSE from ES-DE](https://gitlab.com/es-de)<br>
Inspired by: [ES-Theme-Switch](https://github.com/lilbud/es-theme-switch)
## NSO Menu Interpreted
| System View | Gamelist View |
|----|----|
| ![rd-NSO-SystemView](https://user-images.githubusercontent.com/1454947/222733121-975db30a-098c-4f77-aebd-f252ebe8c4cc.png) | ![rd-NSO-GamelistView](https://user-images.githubusercontent.com/1454947/222733148-42d38a12-34d1-4063-8ecc-13d16c1e44d3.png) |
**Description:** <br>
NSO Menu Interpreted is a theme that takes inspiration from the menu design of Nintendo Switch Online.
Source: [NSO-Menu-Interpreted](https://github.com/anthonycaccese/nso-menu-interpreted-es-de)<br>
Created by: [anthonycaccese](https://github.com/anthonycaccese) & [rogs123](https://github.com/rogs123)
# Legacy Steam Deck Inputs Pre: 0.7b
These are legacy inputs from the old RetroDECK TEST Official Layout profile for the Steam Deck
| Command | Button / Combination |
| :--- | :---: |
| RetroArch Menu | `L3+R3` or `SELECT+Y` |
| Quit Game | `START + SELECT` |
| Pause Emulation | `Select + B` |
| Take Screenshot | `Select + A` |
| Select Save State Slot +| `Select + D-Pad UP` |
| Select Save State Slot -| `Select + D-Pad Down` |
| Load State | `Select + L1` |
| Save State | `Select + R1` |
| Rewind Emulation* | `Select + L2` |
| Fast forward Emulation* | `Select + R2` |
`*` Fast forwarding and rewind must be enabled inside RetroDeck firstly inside the Tools menu.
## MelonDS
| Command | Button / Combination |
| :--- | :---: |
| Fast forward Emulation* | `R2 or R4` |
| Swap screen layout | `L3 or R5` |
| Pause/Resume | `R3 or L4` |
## CITRA (SA)
| Command | Button / Combination |
| :--- | :---: |
| Load State | `L4` |
| Save State | `R4` |
| Citra Main Menu | `R5` |
| Swap Screens | `L5` |
**NOTE:** in order to quit CITRA just exit from the menu.
## YUZU
| Command | Button / Combination |
| :--- | :---: |
| Pause/Resume | `R4 + A` |
| Load Amiibo | `R4 + X` |
| Docked/Undocked Mode | `R4 + Y` |
| Yuzu Main Menu | `R4 + B` |
| Exit Yuzu | `R4 + Select` |
| Take Screenshot | `R4` |
| Home | `L4` |
## Ryujinx
Please note!
Unfortunately Ryujinx doesn't support the full hotkey customization yet. These are the default hotkeys as of now:
| Command | Button / Combination |
| :--- | :---: |
| Vsync Toggle | `F1` |
| Sound Mute/Unmute | `F2` |
| Show UI | `F4` |
| Pause/Resume | `F5` |
| Screenshot | `F8` |
| Fulscreen Toggle | `F11` or `Alt+Enter` |
## DOLPHIN (SA)
| Command | Button / Combination |
| :--- | :---: |
| Take Screenshot | `Select + A` |
| Load State | `Select + L2` |
| Save State | `Select + R2` |
| Fastforward | `Select + R4` |
| Slowdown | `Select + L4` |
| Exit Dolphin | `Select + Start` |
## PPSSPPSDL (SA)
| Command | Button / Combination |
| :--- | :---: |
| Fastforward | `R2` |
| Rewind | `L2` |
| Pause/Resume | `R4` |
| Take Screenshot | `L4` |
| Load State | `L5` |
| Save State | `R5` |
## Duckstation (SA)
| Command | Button / Combination |
| :--- | :---: |
| Fastforward | `R4` |
| Rewind | `L4` |
| Load State | `L5` |
| Save State | `R5` |