Xargon/RetroDECK
1
0
Fork 0
mirror of https://github.com/RetroDECK/RetroDECK.git synced 2025-01-31 12:35:39 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Formating fixes

Browse source
This commit is contained in:
Lazorne 2023-12-04 14:51:11 +01:00
parent 983c62a9db
commit e8af91b714
5 changed files with 69 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
wiki-rtd/.mkdocs.yml.kate-swp Normal file
View file

Binary file not shown.

46
wiki-rtd/docs/wiki_development/folders-filepaths.md
View file

@ -2,8 +2,9 @@
RetroDECK is a Flatpak a sandboxed bundle of different applications and configurations. One part of the files are none writable while others are.
## `~/retrodeck`
## ~/retrodeck
It's the home folder of RetroDECK itself, it contains:
- `bios`, the bios folder, the actual `retroarch/system` folder is poiting here `~/.var/app/net.retrodeck.retrodeck/config/emulationstation/.emulationstation/downloaded_media` is pointing here
- `.downloaded_media`, this is where you scraped data is saved (images, videos, logos..),
- `.lock`, this file tells RetroDECK that the settings are done and to not reset them, if this file is missing it will trigger a first boot showing the setup. Here is written the software version that is compared to the actual version to check if an update is needed.
@ -17,38 +18,42 @@ It's the home folder of RetroDECK itself, it contains:
- `mods`, emulators mods location
- `.themes`, additional themes folder, `~/.var/app/net.retrodeck.retrodeck/config/emulationstation/.emulationstation/themes` is poiting here
## `~/.var/app/net.retrodeck.retrodeck`
## ~/.var/app/net.retrodeck.retrodeck
This folder is the only flatpak folder that is editable user side, it's mapped as `/var` in the flatpak itself, from now on we will use the flatpak paths unless differently specified.
### `config/`
- `config`, contains all the various software configs such as RetroDECK, retroarch folder and standalones emulator configs
-- `retroarch`, the retroarch folder (see below)
-- `emulationstation`, emulationstation home folder (see below)
-- `retrodeck`, to not be confued with `~/retrodeck/`, this folder contains the retrodeck configs, see below.
-- various standalone emulators config folders such as `yuzu`, `pcsx2`, `melonDS`, `dolphin-emu` and so on.
### config/
- `config`, contains all the various software configs such as RetroDECK, retroarch folder and standalones emulator configs
- `retroarch`, the retroarch folder (see below)
- `emulationstation`, emulationstation home folder (see below)
- `retrodeck`, to not be confued with `~/retrodeck/`, this folder contains the retrodeck configs, see below.
- various standalone emulators config folders such as `yuzu`, `pcsx2`, `melonDS`, `dolphin-emu` and so on.
### config/retroarch
### `config/retroarch`
- `system`, retroarch bios (system) folder, this points to `~/retrodeck/bios`
- `core`, retroarch cores folder, this is populated by `/app/share/libretro/cores` at the first startup (or with `--reset`, `--reset-ra`)
- `retroarch.cfg`, the retroarch config, the original one is located in `/app/retrodeck/emu-configs/retroarch.cfg`, and similarly to above it's generated at the first startup
### `config/emulationstation`
### config/emulationstation
- `ROMs`, this is linked to the roms folder in `~/retroeck/roms`or `<sdcard>/roms`
- `.emulationstation`, ES-DE main folder
-- `custom_systems`, where the customs systems are kept (example the tools file), check the official ES-DE docs for more info.
-- `downloaded_media`, this points to `~/retrodeck/.downloaded_media`
-- `themes`, this points to `~/retrodeck/.themes`
-- `es_log.txt`, ES-DE log file
-- `es_settings.xml`, ES-DE settings file
- `custom_systems`, where the customs systems are kept (example the tools file), check the official ES-DE docs for more info.
- `downloaded_media`, this points to `~/retrodeck/.downloaded_media`
- `themes`, this points to `~/retrodeck/.themes`
- `es_log.txt`, ES-DE log file
- `es_settings.xml`, ES-DE settings file
### config/retrodeck
### `config/retrodeck`
- `tools`
- `version`, this file carries the RetroDECK version number and it ś generated during the flatpak build.
### `data/`
### data/
Some emulators, like yuzu, needs this path, here for example is even symlinked the yuzu keys and firmware folder.
## `/var/lib/flatpak/app/net.retrodeck.retrodeck/current/active/files`
### /var/lib/flatpak/app/net.retrodeck.retrodeck/current/active/files/
Non-flatpak path: this folders contain file such as the .desktop, icons, etc.
This is mapped as the `/app` folder in flatpak, this folder is inside the read only file system and so all this tree is immutable (actually can be edited by root for develop purposes).<br>
@ -57,12 +62,13 @@ FYI: you can edit the with KWrite, it justs ask you for the root password when s
### /var/lib/flatpak/app/net.retrodeck.retrodeck/current/active/files/share/emulationstation/resources/systems/unix/
This contains `es_find_rules.xml` and `es_systems.xml`
## `/app/bin`
### /app/bin
All the binary files, like `retrodeck.sh`, the main program (wrapper).
All these programs can be launched in developer mode just invoking them in the terminal.
### `/app/retrodeck`
### /app/retrodeck
This folder contains the default configuration that is restored with the various `--reset` commands.
- `emu-configs`
- `steam`
- `tools`

9
wiki-rtd/docs/wiki_development/general-development.md
View file

@ -11,6 +11,7 @@ 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
@ -27,12 +28,14 @@ flatpak install --user -y org.kde.Sdk//5.15-21.08 org.kde.Platform//5.15-21.08 i
```
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
@ -43,16 +46,19 @@ flatpak build-bundle local ~/RetroDECK.flatpak net.retrodeck.retrodeck
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
```
@ -81,16 +87,19 @@ 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
```

30
wiki-rtd/docs/wiki_development/what-are-you-working.on.md Normal file
View file

@ -0,0 +1,30 @@
# What are you working on right now?
To get the latest updates be a member of the [Discord](https://discord.gg/Dz3szYsP8g)and follow `The RetroDECK Blog 📝`.
You can also get clues from the [Github issues](https://github.com/XargonWan/RetroDECK/issues/).
## Information
We are always working on more stuff then shown here.
What is presented here is just a short list of currently announced projects to give everyone a quick overview.
## New Emulators
- GZDoom (Doom engine)
- MAME (Standalone)
- Ryujinx (Switch)
- Solarus (engine)
- Vita3K (PSVita)
- OpenBOR (engine)
- IkemenGO (engine)
- ScummVM (Standalone)
## New Features Configurator
- Reset ES-DE
- Reset ES-DE Inputs
## New Features RetroDECK Framework
## Wiki
- Emulator Guides
- Cleaning up the Wiki

18
wiki-rtd/docs/wiki_general/what-is-included.md
View file

@ -2,6 +2,7 @@
## General information
We plan to add more emulators and functions over course of the development cycle. The goal is to support all of the systems ES-DE supports and ship the best emulator for that systems. We don't have any plans to ship all emulators in existence for each system but virtually only the best one per-system (this is more theoretical than practical) to avoid confusion and the user being loss in the choice.
In some cases we might ship more then one Emulator if the feature set is vastly diffrent or the user demand is high.
## Systems
@ -13,12 +14,12 @@ Is a powerful Utility that can be use to change/modify and manipulate various as
## Emulators
### RetroArch##
### RetroArch
RetroDECK ships will all cores under the stable branch of RetroArch.
If there is no stable version of a core the nightly version will be used instead.
## Standalone Emulators
The following standalone emulators are included:
### Standalone Emulators
The following standalone emulators are currently included:
- Yuzu (Switch)
- Citra (3DS)
@ -31,15 +32,4 @@ The following standalone emulators are included:
- RPCS3 (PS3)
- PPSSPP (PSP)
These are in the process of being added:
- GZDoom (Doom engine)
- MAME (Standalone)
- Ryujinx (Switch)
- Solarus (engine)
- Vita3K (PSVita)
- OpenBOR (engine)
- IkemenGO (engine)
- ScummVM (Standalone)