From f0f84292ee35087fcc859d6b1bdafa55d8bbdbd9 Mon Sep 17 00:00:00 2001 From: Lazorne <thelazorne@protonmail.com> Date: Tue, 28 Nov 2023 16:49:28 +0100 Subject: [PATCH] Wiki tests --- wiki-rtd/docs/index.md | 5 +- wiki-rtd/docs/wiki_about/visions-and-goals.md | 31 ++++ .../what-is-retrodeck.md | 0 wiki-rtd/mkdocs.yml | 5 +- wiki-rtd/old/index.md | 30 --- wiki-rtd/old/wiki_misc/Archive.md | 171 ------------------ 6 files changed, 37 insertions(+), 205 deletions(-) create mode 100644 wiki-rtd/docs/wiki_about/visions-and-goals.md rename wiki-rtd/docs/{wiki_general => wiki_about}/what-is-retrodeck.md (100%) delete mode 100644 wiki-rtd/old/index.md delete mode 100644 wiki-rtd/old/wiki_misc/Archive.md diff --git a/wiki-rtd/docs/index.md b/wiki-rtd/docs/index.md index bfce2713..c437e2e5 100644 --- a/wiki-rtd/docs/index.md +++ b/wiki-rtd/docs/index.md @@ -2,10 +2,11 @@ <img src="https://github.com/XargonWan/RetroDECK/blob/main/res/logo.png?raw=true" alt="RetroDECK logo" width="400"/> </p> + # Please use this wiki: -We are in the process of migrating to MKDocs, but most information is still here: -https://github.com/XargonWan/RetroDECK/wiki +We are in the process of migrating to MKDocs, but most information is still here:<br> +[Old Wiki](https://github.com/XargonWan/RetroDECK/wiki) # Welcome to the **RetroDECK wiki**! diff --git a/wiki-rtd/docs/wiki_about/visions-and-goals.md b/wiki-rtd/docs/wiki_about/visions-and-goals.md new file mode 100644 index 00000000..362ae7c8 --- /dev/null +++ b/wiki-rtd/docs/wiki_about/visions-and-goals.md @@ -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 + diff --git a/wiki-rtd/docs/wiki_general/what-is-retrodeck.md b/wiki-rtd/docs/wiki_about/what-is-retrodeck.md similarity index 100% rename from wiki-rtd/docs/wiki_general/what-is-retrodeck.md rename to wiki-rtd/docs/wiki_about/what-is-retrodeck.md diff --git a/wiki-rtd/mkdocs.yml b/wiki-rtd/mkdocs.yml index d8510856..0a9b94d1 100644 --- a/wiki-rtd/mkdocs.yml +++ b/wiki-rtd/mkdocs.yml @@ -1,6 +1,7 @@ site_name: RetroDECK Wiki -site_url: nav: - 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 diff --git a/wiki-rtd/old/index.md b/wiki-rtd/old/index.md deleted file mode 100644 index e3af737b..00000000 --- a/wiki-rtd/old/index.md +++ /dev/null @@ -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 ๐๏ธ - - - - - - - - -.. 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/> diff --git a/wiki-rtd/old/wiki_misc/Archive.md b/wiki-rtd/old/wiki_misc/Archive.md deleted file mode 100644 index 6d06b613..00000000 --- a/wiki-rtd/old/wiki_misc/Archive.md +++ /dev/null @@ -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 | -|----|----| -|  |  | - -**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 | -|----|----| -|  |  | - -**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 | -|----|----| -|  |  | - -**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 | -|----|----| -|  |  | - -**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 | -|----|----| -|  |  | - -**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` | \ No newline at end of file