From cf4aef26a96cdab513642fa628ea8cabdbe6cb43 Mon Sep 17 00:00:00 2001 From: Lazorne Date: Sat, 9 Mar 2024 18:09:16 +0100 Subject: [PATCH] wiki --- .../configurator.md | 0 wiki-rtd/docs/wiki_configurator/ponzu.md | 38 +++++++++++++++++++ wiki-rtd/docs/wiki_faq/faq-rd-usage.md | 2 +- wiki-rtd/mkdocs.yml | 2 +- 4 files changed, 40 insertions(+), 2 deletions(-) rename wiki-rtd/docs/{wiki_general => wiki_configurator}/configurator.md (100%) create mode 100644 wiki-rtd/docs/wiki_configurator/ponzu.md diff --git a/wiki-rtd/docs/wiki_general/configurator.md b/wiki-rtd/docs/wiki_configurator/configurator.md similarity index 100% rename from wiki-rtd/docs/wiki_general/configurator.md rename to wiki-rtd/docs/wiki_configurator/configurator.md diff --git a/wiki-rtd/docs/wiki_configurator/ponzu.md b/wiki-rtd/docs/wiki_configurator/ponzu.md new file mode 100644 index 0000000..22de432 --- /dev/null +++ b/wiki-rtd/docs/wiki_configurator/ponzu.md @@ -0,0 +1,38 @@ +# Guide: Ponzu + + + +Ponzu is a RetroDECK Framework function that is searching for Citra and Yuzu AppImages and integrates them into the RetroDECK framework, the result is that if a user provides their own AppImages, these will be available as emulators inside RetroDECK. + +## Where to put the AppImages +Ponzu is looking for the AppImages in the `retrodeck/ponzu/` directory (lowercase). + +### Accepted filenames + +- Yuzu*.AppImage +- yuzu*.AppImage +- Citra*.AppImage +- citra*.Appimage +Where `*` means that there can be a combination of any character. + +## Accepted version + +Ponzu was tested only with the latest versions of both the emulators. + +## How to: + +- Quit RetroDECK +- Put the dsired AppImages into `retrodeck/ponzu/` +- Open RetroDECK and wait +When RetroDECK will be started you will see the new Citra and Yuzu entries in the Configurator, such as Open Emulator and Reset Emulator. After this the emulators will be working like before, with the difference that now they are no more the default emulators. + +## How to make them defaults? + +WIP + +## How to uninstall the emulators + +- Open Configurator +- Navigate to RetroDECK Tools +- Run Ponzu - Remove Citra or Ponzu - Remove Yuzu +Your saves and games will not be deleted, so if you decide to re-install them everything will be as you left, except for the configurations that they will reset as RetroDECK defaults. diff --git a/wiki-rtd/docs/wiki_faq/faq-rd-usage.md b/wiki-rtd/docs/wiki_faq/faq-rd-usage.md index e0d4d43..aaf626d 100644 --- a/wiki-rtd/docs/wiki_faq/faq-rd-usage.md +++ b/wiki-rtd/docs/wiki_faq/faq-rd-usage.md @@ -48,7 +48,7 @@ Yes, you can do so inside the configurator and the `Move RetroDECK` option. Yes, you can reset various parts of the software using the RetroDECK Configurator's reset functions. -Read more on: [RetroDECK Configurator 🛠️](../wiki_general/configurator.md) +Read more on: [RetroDECK Configurator 🛠️](../wiki_configurator/configurator.md) diff --git a/wiki-rtd/mkdocs.yml b/wiki-rtd/mkdocs.yml index 64fd77f..c47f8c7 100644 --- a/wiki-rtd/mkdocs.yml +++ b/wiki-rtd/mkdocs.yml @@ -80,7 +80,7 @@ nav: - Known Issues: wiki_bugs/known-issues.md - Configurator 🧰: - - Configurator Features: wiki_general/configurator.md + - Configurator Features: wiki_configurator/configurator.md - Controllers 🎮: - About 🎮: