From db98401f694e2677c46bc81f39c72c3bfad80595 Mon Sep 17 00:00:00 2001 From: Lazorne Date: Tue, 28 Nov 2023 16:11:40 +0100 Subject: [PATCH] MKDocs testing --- wiki-rtd/docs/index.md | 31 ++-- .../docs/wiki_general/what-is-retrodeck.md | 62 +++++++ wiki-rtd/docs/wiki_misc/archive.md | 171 ++++++++++++++++++ wiki-rtd/mkdocs.yml | 4 + 4 files changed, 256 insertions(+), 12 deletions(-) create mode 100644 wiki-rtd/docs/wiki_general/what-is-retrodeck.md create mode 100644 wiki-rtd/docs/wiki_misc/archive.md diff --git a/wiki-rtd/docs/index.md b/wiki-rtd/docs/index.md index 000ea345..bfce2713 100644 --- a/wiki-rtd/docs/index.md +++ b/wiki-rtd/docs/index.md @@ -1,17 +1,24 @@ -# Welcome to MkDocs +

+ RetroDECK logo +

-For full documentation visit [mkdocs.org](https://www.mkdocs.org). +# Please use this wiki: -## Commands +We are in the process of migrating to MKDocs, but most information is still here: +https://github.com/XargonWan/RetroDECK/wiki -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. +# Welcome to the **RetroDECK wiki**! -## Project layout +🏗️ This wiki is currently under construction 🏗️ - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +![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) + +### The RetroDECK community: + +[Website](https://retrodeck.net)
+[Discord](https://discord.gg/Dz3szYsP8g)
+[Lemmy](https://lemmy.zip/c/retrodeck)
+[Subreddit](https://www.reddit.com/r/retrodeck)
diff --git a/wiki-rtd/docs/wiki_general/what-is-retrodeck.md b/wiki-rtd/docs/wiki_general/what-is-retrodeck.md new file mode 100644 index 00000000..ce4150a0 --- /dev/null +++ b/wiki-rtd/docs/wiki_general/what-is-retrodeck.md @@ -0,0 +1,62 @@ + + +# What is RetroDECK? + +Instead of having several different software on your system for a variety of emulators and frontends you only need to have one: RetroDECK. + +RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) (ES-DE) powered flatpak application that builds-in a variety of emulators and other software that allows you to play your favorite retro (and even not-so-retro) games in one complete package. + +## So what does that mean? +It means that RetroDECK takes all the emulators and frontend, configures them for you and put them into one application you can download from flathub. + +By being one application RetroDECK can put all important files in one location for all the emulators, instead of having them spread out over your entire system and even add features on top. + +## What else? +RetroDECK also adds the `RetroDECK Framework` and the `RetroDECK Configurator` on top of the emulators and ES-DE interface that allows deeper integrations between emulators and easier exposure to a variety of features that you otherwise need to set per emulator basis to create a uniformity between them. + +**We ship:** + +* Tools for compressing games. +* Tools for file management. +* Tools for troubleshooting (BIOS Checker, Multi-File Structure Checker, Partial or full reset of functions) +* Tools for auto installing some BIOSes +* Prebuilt Steam Input profiles. +* Presets that can be acitivated to configure things over many emulators in one go like: RetroAchievements, Borders, Widescreen Mode, Swaping A/B X/Y for Nintendo Games. +* Easier management of `mods` `roms` `texture_packs` `scraped media` `screenshots` `saves / states` `gamelists` and more. + +**For more information about the beta you can check here:**
+[[RetroDECK: Beta period]] + +**For more information about know issues and missing features you can check here:**
+[[RetroDECK: Known Issues]] + + +## Inspiration for RetroDECK and goals +It's inspired by embedded emulation systems like: + +- AmberELEC +- EmuELEC +- CoreELEC +- Lakka +- Batocera + + +The RetroDECK team consists of several veterans from some of the projects mentioned above as well as a bunch of other talented other individuals. + +**For our long term vision you can check out the following wiki page:**
+[[RetroDECK: Visions and Goals]] + +### The Story & Philosophy of RetroDECK +If you want to know the history of RetroDECK, there is a short write-up here: + +[[Misc: RetroDECK ‐ Story & Philosophy]] + +# The FAQ +The FAQ answers a lot of deeper questions on different topics for example: + +- How is RetroDECK is different from other projects? +- What is a flatpak? + +Check it out here: + +[[FAQs: Frequently asked questions]] diff --git a/wiki-rtd/docs/wiki_misc/archive.md b/wiki-rtd/docs/wiki_misc/archive.md new file mode 100644 index 00000000..6d06b613 --- /dev/null +++ b/wiki-rtd/docs/wiki_misc/archive.md @@ -0,0 +1,171 @@ +# 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:**
+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)
+Ported and remixed by: [anthonycaccese](https://github.com/anthonycaccese)
+Ported from: [Alekfull-NX for Batocera](https://github.com/fagnerpc/Alekfull-NX)
+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:**
+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)
+Ported and remixed by: [anthonycaccese](https://github.com/anthonycaccese)
+Ported from: [ES Theme Retrofix for Batocera](https://github.com/20GotoTen/es-theme-retrofix)
+Original creator: [20GotoTen](https://github.com/20GotoTen)
+ + +## 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:**
+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)
+Created by: [LeonSE from ES-DE](https://gitlab.com/es-de)
+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:**
+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)
+Created by: [LeonSE from ES-DE](https://gitlab.com/es-de)
+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:**
+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)
+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` | \ No newline at end of file diff --git a/wiki-rtd/mkdocs.yml b/wiki-rtd/mkdocs.yml index 7cb4b0d0..422fcaa3 100644 --- a/wiki-rtd/mkdocs.yml +++ b/wiki-rtd/mkdocs.yml @@ -1 +1,5 @@ site_name: RetroDECK Wiki +nav: + - Home: index.md + - What is RetroDECK?: wiki_general/what-is-retrodeck.md +theme: readthedocs