diff --git a/wiki-rtd/docs/wiki_development/general-development.md b/wiki-rtd/docs/wiki_development/general-development.md new file mode 100644 index 00000000..224de10d --- /dev/null +++ b/wiki-rtd/docs/wiki_development/general-development.md @@ -0,0 +1,101 @@ +# Development General Notes + +## Cooker +Cooker, differently from the main (stable) branch, is what it's boiling in the pot now: the bleeding edge of the software development. +Every time a commit or a PR is done, a GitHub action automatically compiles the snapshot with the latest changes and publish them on the [cooker repository](https://github.com/XargonWan/RetroDECK-cooker). +This can be publicly tested and if it's stable will be merged in the main branch creating a new release. + +Useless to say that this channel is not suggested for the end user but it's developer / alpha tester oriented. +Expect major bugs and data loss: be warned. + +## Build instructions + +If you want to build the RetroDECK flatpak on your machine for developing or just testing purposes: +``` +cd ~ +git clone --recursive https://github.com/XargonWan/RetroDECK.git +cd RetroDECK +git submodule init +git submodule update +``` + +install `flatpak flatpak-builder p7zip-full` with your distro's package manager, then: + +``` +flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo +flatpak install --user -y org.kde.Sdk//5.15-21.08 org.kde.Platform//5.15-21.08 io.qt.qtwebengine.BaseApp/x86_64/5.15-21.08 org.freedesktop.Sdk.Extension.llvm13 org.freedesktop.Platform.ffmpeg-full/x86_64/21.08 +``` + +To build the stable release: +``` +flatpak-builder --user --install --install-deps-from=flathub --install-deps-from=flathub-beta --force-clean --repo=local ~/RetroDECK/retrodeck-main ~/RetroDECK/net.retrodeck.retrodeck.yml +flatpak build-bundle local ~/RetroDECK.flatpak net.retrodeck.retrodeck +``` + +Or alternatively, to build the cooker (experimental) release: +``` +git checkout cooker +flatpak-builder --user --install --force-clean --repo=local ~/RetroDECK/retrodeck-cooker ~/RetroDECK/net.retrodeck.retrodeck.yml +flatpak build-bundle local ~/RetroDECK.flatpak net.retrodeck.retrodeck +``` + +## Debug Mode +It's possible to enter in a sort of debug mode, it's actually the flatpak shell. + +Enter in the flatpak shell: +``` +flatpak run --command=bash net.retrodeck.retrodeck +``` + +Launch ES-DE in debug mode: +``` +emulationstation --debug --home /var/config/emulationstation +``` + +Launch an emulator in debug mode: +``` +ls /app/bin +``` +To get the list of the available binaries to launch, then just write the command, such as `yuzu` or `retroarch` + +This is useful when for example a game is not starting and you want the output printed in the terminal. + +## Manual installation instructions +This method is usually for the beta/cooker testers: +- Download the RetroDECK.flatpak from the [release page](https://github.com/XargonWan/RetroDECK/releases) or from the [cooker release page](https://github.com/XargonWan/RetroDECK-cooker/releases) (be sure to download the correct version, check the date as they're not ordered unfortunately). +- `cd` where the downloded file is located +- `flatpak install RetroDECK.flatpak` or whatever the filename is + +If this doesn´t work: +- cd into your download location +- `flatpak install RetroDECK.flatpak` +- Run it from the start menu or, alternatively, from the terminal by typing `flatpak run net.retrodeck.retrodeck` +- Then the first setup will guide you in the first steps, **please read all the messages carefully** as the rom directory must not be edited in EmulationStation + +### Updating instructions +- uninstall the previous version with `flatpak uninstall net.retrodeck.retrodeck` +- follow installation instructions +- [OPTIONAL] In case of issues it's suggested to remove `~/.var/app/net.retrodeck.retrodeck` and run `flatpak run net.retrodeck.retrodeck --reset`, but this will reset the application configs, please backup your data. +NOTE: this will not be needed after v`0.4.0b`. + +## Managing RetroDECK flatpak file + +Install RetroDECK from flatpak file: +``` +flatpak install RetroDECK.flatpak +``` + +Run RetroDECK: +``` +flatpak run net.retrodeck.retrodeck +``` + +Uninstall RetroDECK: +``` +flatpak uninstall net.retrodeck.retrodeck +``` + +## Making your own ES-DE theme +Please check the following link link over ES-DE
+[Theme Development ](https://gitlab.com/es-de/emulationstation-de/-/blob/master/THEMES-DEV.md) + diff --git a/wiki-rtd/docs/wiki_images/logos/Ryujinx-logo.svg b/wiki-rtd/docs/wiki_images/logos/Ryujinx-logo.svg new file mode 100644 index 00000000..d6a76312 --- /dev/null +++ b/wiki-rtd/docs/wiki_images/logos/Ryujinx-logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/wiki-rtd/docs/wiki_images/logos/cemu-logo.png b/wiki-rtd/docs/wiki_images/logos/cemu-logo.png new file mode 100644 index 00000000..15820a90 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/cemu-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/citra-logo.svg b/wiki-rtd/docs/wiki_images/logos/citra-logo.svg new file mode 100644 index 00000000..b6abc1cc --- /dev/null +++ b/wiki-rtd/docs/wiki_images/logos/citra-logo.svg @@ -0,0 +1,2 @@ + +image/svg+xml diff --git a/wiki-rtd/docs/wiki_images/logos/dolphin-logo.png b/wiki-rtd/docs/wiki_images/logos/dolphin-logo.png new file mode 100644 index 00000000..c9d5b683 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/dolphin-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/duckstation-logo.png b/wiki-rtd/docs/wiki_images/logos/duckstation-logo.png new file mode 100644 index 00000000..bc6655bb Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/duckstation-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/es-de-logo.png b/wiki-rtd/docs/wiki_images/logos/es-de-logo.png new file mode 100644 index 00000000..a6890a5b Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/es-de-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/gzdoom-logo.png b/wiki-rtd/docs/wiki_images/logos/gzdoom-logo.png new file mode 100644 index 00000000..63dd52c7 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/gzdoom-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/ikemen-go-logo.png b/wiki-rtd/docs/wiki_images/logos/ikemen-go-logo.png new file mode 100644 index 00000000..228ad77f Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/ikemen-go-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/kennynl-logo.png b/wiki-rtd/docs/wiki_images/logos/kennynl-logo.png new file mode 100644 index 00000000..e45e4e35 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/kennynl-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/mame-logo.png b/wiki-rtd/docs/wiki_images/logos/mame-logo.png new file mode 100644 index 00000000..b74f01ac Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/mame-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/melonds-logo.svg b/wiki-rtd/docs/wiki_images/logos/melonds-logo.svg new file mode 100644 index 00000000..6cef68cc --- /dev/null +++ b/wiki-rtd/docs/wiki_images/logos/melonds-logo.svg @@ -0,0 +1,80 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/wiki-rtd/docs/wiki_images/logos/openbor-logo.svg b/wiki-rtd/docs/wiki_images/logos/openbor-logo.svg new file mode 100644 index 00000000..0acb8579 --- /dev/null +++ b/wiki-rtd/docs/wiki_images/logos/openbor-logo.svg @@ -0,0 +1,88 @@ + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/wiki-rtd/docs/wiki_images/logos/pcsx2-logo.png b/wiki-rtd/docs/wiki_images/logos/pcsx2-logo.png new file mode 100644 index 00000000..f8fa3b2d Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/pcsx2-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/ppsspp-logo.png b/wiki-rtd/docs/wiki_images/logos/ppsspp-logo.png new file mode 100644 index 00000000..458fc369 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/ppsspp-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/primehack-logo.png b/wiki-rtd/docs/wiki_images/logos/primehack-logo.png new file mode 100644 index 00000000..84ebd6d2 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/primehack-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/qemu-logo.png b/wiki-rtd/docs/wiki_images/logos/qemu-logo.png new file mode 100644 index 00000000..a39c0e30 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/qemu-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/rd-logo-box.png b/wiki-rtd/docs/wiki_images/logos/rd-logo-box.png new file mode 100644 index 00000000..d9fc05e5 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/rd-logo-box.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/retroarch-logo.png b/wiki-rtd/docs/wiki_images/logos/retroarch-logo.png new file mode 100644 index 00000000..d591952d Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/retroarch-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/rpcs3-logo.png b/wiki-rtd/docs/wiki_images/logos/rpcs3-logo.png new file mode 100644 index 00000000..e59a9b5b Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/rpcs3-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/scummvm-logo.svg b/wiki-rtd/docs/wiki_images/logos/scummvm-logo.svg new file mode 100644 index 00000000..a8cd58fa --- /dev/null +++ b/wiki-rtd/docs/wiki_images/logos/scummvm-logo.svg @@ -0,0 +1,333 @@ + +image/svg+xml \ No newline at end of file diff --git a/wiki-rtd/docs/wiki_images/logos/solarus-logo.svg b/wiki-rtd/docs/wiki_images/logos/solarus-logo.svg new file mode 100644 index 00000000..237926cf --- /dev/null +++ b/wiki-rtd/docs/wiki_images/logos/solarus-logo.svg @@ -0,0 +1 @@ +solarus_logo_stroke \ No newline at end of file diff --git a/wiki-rtd/docs/wiki_images/logos/vita3k-logo.png b/wiki-rtd/docs/wiki_images/logos/vita3k-logo.png new file mode 100644 index 00000000..81672364 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/vita3k-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/xenia-logo.png b/wiki-rtd/docs/wiki_images/logos/xenia-logo.png new file mode 100644 index 00000000..ba11fd82 Binary files /dev/null and b/wiki-rtd/docs/wiki_images/logos/xenia-logo.png differ diff --git a/wiki-rtd/docs/wiki_images/logos/yuzu-logo.svg b/wiki-rtd/docs/wiki_images/logos/yuzu-logo.svg new file mode 100644 index 00000000..93171d1b --- /dev/null +++ b/wiki-rtd/docs/wiki_images/logos/yuzu-logo.svg @@ -0,0 +1 @@ +Artboard 1 \ No newline at end of file diff --git a/wiki-rtd/mkdocs.yml b/wiki-rtd/mkdocs.yml index 80cefa9d..2bf183de 100644 --- a/wiki-rtd/mkdocs.yml +++ b/wiki-rtd/mkdocs.yml @@ -24,6 +24,7 @@ nav: - Version History (Patchnotes): wiki_rd_versions/version-history.md - Folders and Filepaths: wiki_development/folders-filepaths.md - CLI Guide: wiki_development/cli-guide.md + - Development Notes: wiki_development/general-development.md - About RetroDECK 📖: - The Team & Credits: wiki_about/team-credits.md diff --git a/wiki-rtd/old/requirements.txt b/wiki-rtd/old/requirements.txt deleted file mode 100644 index b280e48f..00000000 --- a/wiki-rtd/old/requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ -mkdocs -sphinx_rtd_theme -myst-parser