Xargon/Wiki
1
0
Fork 0
mirror of https://github.com/RetroDECK/Wiki.git synced 2025-04-10 19:15:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

merged several docs

Browse source
This commit is contained in:
laz 2025-01-19 14:25:21 +01:00
parent dfcb687fe0
commit b8b47b52f2
8 changed files with 236 additions and 263 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

122
wiki-rtd/docs/wiki_emulator_guides/dolphin-primehack/dolphin-controls.md
View file

@ -1,122 +0,0 @@
# Dolphin Controls
## Gamecube Controls
The controls here are described as an Xbox Layout style controller.
| Action | Button | Comment |
| :--- | :---: | :---: |
| A | `A ` | |
| B | `B` | |
| X | `X` | |
| Y | `Y` | |
| Z | `R2 or L2` | |
| START | `START` | |
| Control Stick | `Left Stick` | |
| C Stick | `Right Stick` | |
| D-Pad Up | `D-Pad Up` | |
| D-Pad Down | `D-Pad Down` | |
| D-Pad Left | `D-Pad Left` | |
| D-Pad Right | `D-Pad Right` | |
## Wii - How do I use a Real Wii Remote with RetroDECK and Dolphin / Primehack?
To get a Wii Remote working on Dolphin / Primehack and Linux read more here in this in-depth guide:
[Wii Remote - Guide](../../wiki_controllers/nintendo/wii-remote.md)
## Wii Controls for Controllers
The controls here are described as an Xbox Layout style controller.
There are hotkeys in the Radial Menus to change the Wii Mote from Upright / Sidways.
| Action | Button | Comment |
| :--- | :---: | :---: |
| A | `A` or `Left Mouse Click` | |
| B | `B` | |
| 1 | `Y` | |
| 2 | `X` | |
| - | `Select` | |
| + | `Start` | |
| C | `R1` | |
| Z | `R2 or L2` | |
| Shake Wii Mote | `L1` | |
| Shake Nunchuck | `L1 + L2` | |
| D-Pad Up | `D-Pad Up` | |
| D-Pad Down | `D-Pad Down` | |
| D-Pad Left | `D-Pad Left` | |
| D-Pad Right | `D-Pad Right` | |
| Home | `R3` | |
### Wii Motion - General Pointer Emulation
- Mouse movement is the general way to to get the pointer emulation.
- `Left Mouse Click` that correspons to a press of the `A` button (as that one is the one mostly used for Wii games that are based around pointing as the primary button).
- That also means if you run RetroDECK on a computer you could also use your mouse.
#### External Controllers - Joystick as Temporary Mouse
For all external controllers without a touchpad (this can also be used for those with touchpad if wanted).
By holding `SELECT` and moving the `Right Joystick` you can use it as a mouse for various systems that uses mouse input.
| Function | Button / Combination| Comment |
| :--- | :---: | :---: |
| Joystick as Mouse | `SELECT + Right Stick` | Cursor Movement |
| Right Mouse Click | `SELECT + L3` | |
| Left Mouse Click | `SELECT + R3` | |
#### Steam Deck
| Function | Button / Combination | Comment |
| :--- | :---: | :---: |
| Right Touchpad | | The entire touchpad acts a mouse |
| Right Touchpad Press | `Left Mouse Click` | |
The Steam Deck uses the `Right Touchpad` for mouse movement and `Wii Pointer` emulation, clicking on the Touchpad will produce a `Left Click` and send the press of the `A` button.
#### Dualshock 4 and DualSense
The touchpads acts as a mouse and can be used to navigate mouse based inputs and be used for Dolphin.
| Function | Button / Combination | Comment |
| :--- | :---: | :---: |
| Full Touchpad | | The entire touchpad acts a mouse |
| Right Touchpad Click | `Left Mouse Click` | |
| Left Touchpad Click | `Right Mouse Click` | |
#### Steam Controller - Gordon:
**You can use the general:**
Hold `SELECT` or `L4` and move the `Right Touchpad` while holding if you don't want to switch modes.
**Right Touchpad: Joystick Mode / Mouse Mode Switch**
By pressing `R4` you can switch the right touchpad between semi-permanent `Right Joystick Mode` or `Mouse Mode`.
| Function | Button / Combination | Comment |
| :--- | :---: | :---: |
| Touchpad as Mouse / Joystick Switch | `R4` | The entire touchpad acts a mouse or the right joystick |
| Left Click - Mouse Mode | `R3` | `Left Click` | |
### Wii Motion - Tilt Emulation
Tilt emulation is made possible by holding the `L2` button and moving the `Right Joystick`.
| Action | Button | Comment |
| :--- | :---: | :---: |
| Tilt Up | `L2 + Right Joystick Up` | |
| Tilt Down | `L2 + Right Joystick Down` | |
| Tilt Left | `L2 + Right Joystick Left` | |
| Tilt Right | `L2 + Right Joystick Right` | |

181
wiki-rtd/docs/wiki_emulator_guides/dolphin-primehack/dolphin-primehack-guide.md
View file

@ -67,7 +67,7 @@ Should be put under the `retrodeck/roms/wii/` directory.
No
## What other folders are used?
## Folder structure
### Dolphin
@ -109,3 +109,182 @@ This shows what folder corresponds to each folder in the standard PrimeHack stru
2. Navigate to `Options` -> `Configuration` -> `Interface` .
3. Select preferred language in the drop-down menu.
4. Close the Emulator, Configurator and return to RetroDECK.
## Dolphin Controls
### Gamecube Controls
The controls here are described as an Xbox Layout style controller.
| Action | Button | Comment |
| :--- | :---: | :---: |
| A | `A ` | |
| B | `B` | |
| X | `X` | |
| Y | `Y` | |
| Z | `R2 or L2` | |
| START | `START` | |
| Control Stick | `Left Stick` | |
| C Stick | `Right Stick` | |
| D-Pad Up | `D-Pad Up` | |
| D-Pad Down | `D-Pad Down` | |
| D-Pad Left | `D-Pad Left` | |
| D-Pad Right | `D-Pad Right` | |
### Wii - How do I use a Real Wii Remote with RetroDECK and Dolphin / Primehack?
To get a Wii Remote working on Dolphin / Primehack and Linux read more here in this in-depth guide:
[Wii Remote - Guide](../../wiki_controllers/nintendo/wii-remote.md)
### Wii Controls for Controllers
The controls here are described as an Xbox Layout style controller.
There are hotkeys in the Radial Menus to change the Wii Mote from Upright / Sidways.
| Action | Button | Comment |
| :--- | :---: | :---: |
| A | `A` or `Left Mouse Click` | |
| B | `B` | |
| 1 | `Y` | |
| 2 | `X` | |
| - | `Select` | |
| + | `Start` | |
| C | `R1` | |
| Z | `R2 or L2` | |
| Shake Wii Mote | `L1` | |
| Shake Nunchuck | `L1 + L2` | |
| D-Pad Up | `D-Pad Up` | |
| D-Pad Down | `D-Pad Down` | |
| D-Pad Left | `D-Pad Left` | |
| D-Pad Right | `D-Pad Right` | |
| Home | `R3` | |
### Wii Motion - Pointer Emulation
- Mouse movement is the general way to to get the pointer emulation.
- `Left Mouse Click` that correspons to a press of the `A` button (as that one is the one mostly used for Wii games that are based around pointing as the primary button).
- That also means if you run RetroDECK on a computer you could also use your mouse.
#### External Controllers - Joystick as Temporary Mouse
For all external controllers without a touchpad (this can also be used for those with touchpad if wanted).
By holding `SELECT` and moving the `Right Joystick` you can use it as a mouse for various systems that uses mouse input.
| Function | Button / Combination| Comment |
| :--- | :---: | :---: |
| Joystick as Mouse | `SELECT + Right Stick` | Cursor Movement |
| Right Mouse Click | `SELECT + L3` | |
| Left Mouse Click | `SELECT + R3` | |
#### Steam Deck
| Function | Button / Combination | Comment |
| :--- | :---: | :---: |
| Right Touchpad | | The entire touchpad acts a mouse |
| Right Touchpad Press | `Left Mouse Click` | |
The Steam Deck uses the `Right Touchpad` for mouse movement and `Wii Pointer` emulation, clicking on the Touchpad will produce a `Left Click` and send the press of the `A` button.
#### Dualshock 4 and DualSense
The touchpads acts as a mouse and can be used to navigate mouse based inputs and be used for Dolphin.
| Function | Button / Combination | Comment |
| :--- | :---: | :---: |
| Full Touchpad | | The entire touchpad acts a mouse |
| Right Touchpad Click | `Left Mouse Click` | |
| Left Touchpad Click | `Right Mouse Click` | |
#### Steam Controller - Gordon
**You can use the general:**
Hold `SELECT` or `L4` and move the `Right Touchpad` while holding if you don't want to switch modes.
**Right Touchpad: Joystick Mode / Mouse Mode Switch**
By pressing `R4` you can switch the right touchpad between semi-permanent `Right Joystick Mode` or `Mouse Mode`.
| Function | Button / Combination | Comment |
| :--- | :---: | :---: |
| Touchpad as Mouse / Joystick Switch | `R4` | The entire touchpad acts a mouse or the right joystick |
| Left Click - Mouse Mode | `R3` | `Left Click` | |
### Wii Motion - Tilt Emulation
Tilt emulation is made possible by holding the `L2` button and moving the `Right Joystick`.
| Action | Button | Comment |
| :--- | :---: | :---: |
| Tilt Up | `L2 + Right Joystick Up` | |
| Tilt Down | `L2 + Right Joystick Down` | |
| Tilt Left | `L2 + Right Joystick Left` | |
| Tilt Right | `L2 + Right Joystick Right` | |
## How-to add mods?
The `~/retrodeck/mods/dolphin/` / `~/retrodeck/mods/primehack/` that represents the `/load/GraphicMods` folder.
**Note:**
Some texture packs could made for a specific version or region of a game.
Make sure you have the right game and textures for it.
`GAME_ID` is different for every game.
### Enable Mods
1. Open up Dolphin or Primehack inside `RetroDECK Configurator` by pressing `Open Emulator` - `Dolphin` / `Primehack`.
2. Press `Options` -> `Graphic Settings`.
3. `Enable Graphics Mods` and set it to `On`.
### Add the mods
1. Extract any mod files from compressed `.zip` or any other format into folders.
2. Go into mods folders, they contain folders that are all named by `GAME_ID`.
3. Move the mods into the right folder:
**Dolphin:** `~/retrodeck/mods/dolphin/<GAME_ID>`
**Primehack:** `~/retrodeck/mods/primehack/<GAME_ID>`
If all is correct the mods should be loaded on next game launch.
## How-to add texture packs?
Primehack is based on Dolphin so the method is the same.
The `~/retrodeck/texture_packs/dolphin/` & `~/retrodeck/texture_packs/primehack/` represents the `/load/Textures` folder.
Some texture packs could made for a specific version or region of a game. Make sure you have the right game and textures for it.
`GAME_ID` is different for every game.
## Enable Custom Textures
1. Open up Dolphin or Primehack inside `RetroDECK Configurator` by pressing `Open Emulator` - `Dolphin` / `Primehack`.
2. Press `Options` -> `Graphic Settings`
3. `Load Custom Textures` & `Prefetch Custom Textures` and set them to `On`.
### Add the textures
1. Extract any texture pack files from compressed `.zip` or any other format into folders.
2. Go into texture pack folders, they contain folders that are all named by `GAME_ID`.
3. Move the textures into the right folder:
**Dolphin:** `~/retrodeck/texture_packs/dolphin/<GAME_ID>`
**Primehack:** `~/retrodeck/texture_packs/primehack/<GAME_ID>` <br>
If all is correct the textures should be loaded on next game launch.

37
wiki-rtd/docs/wiki_emulator_guides/dolphin-primehack/dolphin-primehack-mod.md
View file

@ -1,37 +0,0 @@
# Dolphin / Primehack - Mod Guide
Primehack is based on Dolphin so the method is the same.
The `~/retrodeck/mods/dolphin/` & `~/retrodeck/mods/primehack/` that represents the `/load/GraphicMods` folder.<br>
**Note:** <br>
Some texture packs could made for a specific version or region of a game. Make sure you have the right game and textures for it.
**Note:**<br>
`GAME_ID` is different for every game.
## Enable Custom Textures
* Open up Dolphin or Primehack inside `RetroDECK Configurator` by pressing `Open Emulator` - `Dolphin` or `Primehack`.
* Press `Options` -> `Graphic Settings`
`Enable Graphics Mods` and set it to `On`.<br>
## How do I add mods?
**Requirements:** Mod files <br>
**NOTE:** On the Steam Deck this could be easier to do in `Desktop Mode`.
### Directly into the mods folder
1. Extract any mod files from compressed `.zip` or any other format into folders.
2. Go into mods folders, they contain folders that are all named by `GAME_ID`.<br>
**Dolphin:**`~/retrodeck/mods/dolphin/` <br>
**Primehack:**`~/retrodeck/mods/primehack/`.
3. Move the mods into the right folder: <br>
**Dolphin:** `~/retrodeck/mods/dolphin/<GAME_ID>` <br>
**Primehack:** `~/retrodeck/mods/primehack/<GAME_ID>` <br>

37
wiki-rtd/docs/wiki_emulator_guides/dolphin-primehack/dolphin-primehack-texture-pack.md
View file

@ -1,37 +0,0 @@
# Dolphin / Primehack - Texture Pack Guide
Primehack is based on Dolphin so the method is the same.
The `~/retrodeck/texture_packs/dolphin/` & `~/retrodeck/texture_packs/primehack/` represents the `/load/Textures` folder.<br>
Some texture packs could made for a specific version or region of a game. Make sure you have the right game and textures for it.<br>
`GAME_ID` is different for every game.
## Enable Custom Textures
* Open up Dolphin or Primehack inside `RetroDECK Configurator` by pressing `Open Emulator` - `Dolphin` or `Primehack`.
* Press `Options` -> `Graphic Settings`
`Load Custom Textures` and set it to `On`.<br>
`Prefetch Custom Textures` and set it to `On`.
## How do I add texture packs?
**Requirements:** Texture pack files <br>
**NOTE:** On the Steam Deck this could be easier to do in `Desktop Mode`.
### Directly in the folder
1. Extract any texture pack files from compressed `.zip` or any other format into folders.
2. Go into texture pack folders, they contain folders that are all named by `GAME_ID`.<br>
**Dolphin:**`~/retrodeck/texture_packs/dolphin/` <br>
**Primehack:**`~/retrodeck/texture_packs/primehack/`.
3. Move the textures into the right folder: <br>
**Dolphin:** `~/retrodeck/texture_packs/dolphin/<GAME_ID>` <br>
**Primehack:** `~/retrodeck/texture_packs/primehack/<GAME_ID>` <br>

54
wiki-rtd/docs/wiki_engine_guides/gzdoom/gzdoom-controls.md
View file

@ -1,54 +0,0 @@
# GZDoom Controls
<img src="../../../wiki_images/logos/gzdoom-logo.png" width="150">
### Known issues
- Multiple controllers for local multiplayer don't really work as there are bugs between GZDoom and Steam Input.
- You need to have set the primary controller as player one as all the other players input will cause the inputs to loop sometimes. For example if you are docking the Steam Deck and want to use an external controller, set that controller as player 1 via Steam Input and not the Steam Deck.
- Pressing "Save configuration" within the GZDOOM options menu and you have mods that adds extra controls will wipe those extra controls. It is better just to set the inputs without pressing save as they still will be saved.
## Controls
The controls are semi based on the inputs from `Timesplitters: Future Perfect` for the Playstation 2.
The controls here are described as an Xbox Layout style controller.
| Action | Button | Comment |
| :--- | :---: | :---: |
| Primary Fire | `R2` | |
| Secondary Fire | `R1` | |
| Action / Open | `A` | |
| Jump | `B` | |
| Reload | `Y` | |
| Crouch | `X` | |
| Quick Turn | `R3` | |
| Run Toggle | `L3` | |
| Main Menu | `Start` | |
| Open Map | `Select` | |
| Use Item | `Dpad - Down` | |
| Select Item | `Dpad - Up` | |
| Swap Next Weapon | `Dpad - Right` | |
| Swap Previous Weapon | `Dpad - Left` | |
| Movement: Forward / Back + Strafe | `Left Joystick` | |
| Movement: Look Up / Down + Turn | `Right Joystick` | |
### Mod Extras
Optional extra binds that can come into play for certain Project Brutality or Brutal Doom based mods.
| Action | Button | Comment |
| :--- | :---: | :---: |
| Quick Melee / Special Action | `L1` | |
| Throw Grenade / Second Special Action | `L2` | Replaces Zoom (most DOOM mods use Secondary Fire for this anyhow) |
| Dash | `R3` | Replaces Quick Turn |
### The mod needs more or other extra inputs
Many mods have also more inputs then what is bind-able on a controller, `L1`, `L2`, `Dpad - Up`, `Dpad - Down` are mostly free for those types of actions.
Try to bind `L1`, `L2` to more action orientated things you need to use more often. While `Dpad - Up`, `Dpad - Down` for things you use less often like Extra Menus.
If it is a new movement type that can replace quick turn try to bind it on `R3` and replace Quick Turn or either of the `L1` or `L2`.
You are also free to change any of the Default binds shipped by RetroDECK and if you mess something up you can always reset GZDoom via the Configurator.

58
wiki-rtd/docs/wiki_engine_guides/gzdoom/gzdoom-guide.md
View file

@ -95,6 +95,7 @@ Doomworld is the lifeblood of DOOM community, generations of knowledge and a vas
## Where to put the games
GZDoom games should be put under the `retrodeck/roms/doom/` directory.
### Supported file types
@ -119,14 +120,61 @@ GZDoom games should be put under the `retrodeck/roms/doom/` directory.
### Does GZDoom require BIOS or Firmware?
No
## What are the controls
## GZDoom Controls
Read the:
<img src="../../../wiki_images/logos/gzdoom-logo.png" width="150">
[GZDoom - Controls](gzdoom-controls.md)
**Known Issues**
- Multiple controllers for local multiplayer don't really work as there are bugs between GZDoom and Steam Input.
- You need to have set the primary controller as player one as all the other players input will cause the inputs to loop sometimes. For example if you are docking the Steam Deck and want to use an external controller, set that controller as player 1 via Steam Input and not the Steam Deck.
- Pressing "Save configuration" within the GZDOOM options menu and you have mods that adds extra controls will wipe those extra controls. It is better just to set the inputs without pressing save as they still will be saved.
### Standard Controls
The controls are semi based on the inputs from `Timesplitters: Future Perfect` for the Playstation 2.
The controls here are described as an Xbox Layout style controller.
| Action | Button | Comment |
| :--- | :---: | :---: |
| Primary Fire | `R2` | |
| Secondary Fire | `R1` | |
| Action / Open | `A` | |
| Jump | `B` | |
| Reload | `Y` | |
| Crouch | `X` | |
| Quick Turn | `R3` | |
| Run Toggle | `L3` | |
| Main Menu | `Start` | |
| Open Map | `Select` | |
| Use Item | `Dpad - Down` | |
| Select Item | `Dpad - Up` | |
| Swap Next Weapon | `Dpad - Right` | |
| Swap Previous Weapon | `Dpad - Left` | |
| Movement: Forward / Back + Strafe | `Left Joystick` | |
| Movement: Look Up / Down + Turn | `Right Joystick` | |
### Mod Controls - Extras
Optional extra binds that can come into play for certain `Project Brutality` or `Brutal Doom` based mods.
| Action | Button | Comment |
| :--- | :---: | :---: |
| Quick Melee / Special Action | `L1` | |
| Throw Grenade / Second Special Action | `L2` | Replaces Zoom (most DOOM mods use Secondary Fire for this anyhow) |
| Dash | `R3` | Replaces Quick Turn |
**The mod needs more inputs**
Many mods have also more inputs then what is bind-able on a controller, `L1`, `L2`, `Dpad - Up`, `Dpad - Down` are mostly free for those types of actions.
Try to bind `L1`, `L2` to more action orientated things you need to use more often. While `Dpad - Up`, `Dpad - Down` for things you use less often like Extra Menus.
If it is a new movement type that can replace quick turn try to bind it on `R3` and replace Quick Turn or either of the `L1` or `L2`.
You are also free to change any of the Default binds shipped by RetroDECK and if you mess something up you can always reset GZDoom via the Configurator.
## I only want to play standard doom and have no interest in modding or customization
Do as said above put the .WAD files directly into `retrodeck/roms/doom/` and they will run as normal, enjoy.
## I have bought the games how do I get my files?

2
wiki-rtd/docs/wiki_rd_versions/version_0.8.0b/0.8.0b.md
View file

@ -113,7 +113,7 @@ Read more here: [Get your IWADS](../../wiki_engine_guides/gzdoom/extract-doom-wa
### What about controls?
Read more here: [RetroDECK GZDOOM Controls](../../wiki_engine_guides/gzdoom/gzdoom-controls.md)
Read more here: [GZDOOM Guide](https://retrodeck.readthedocs.io/en/latest/wiki_engine_guides/gzdoom/gzdoom-guide.md)
Instead of using the standard GZDOOM controller input layout, we instead opted to redesign them to be played with with mods in mind (mods normally have more inputs than normal DOOM ever had).

8
wiki-rtd/mkdocs.yml
View file

@ -134,7 +134,6 @@ nav:
- GZDoom 👹:
- GZDoom - General Guide: wiki_engine_guides/gzdoom/gzdoom-guide.md
- GZDoom - Controls Guide: wiki_engine_guides/gzdoom/gzdoom-controls.md
- GZDoom - Get started on .doom files: wiki_engine_guides/gzdoom/retrodeck-doomfile.md
- GZDoom - Get the WADs from bought games: wiki_engine_guides/gzdoom/extract-doom-wads.md
@ -160,10 +159,7 @@ nav:
- Citra - General Guide: wiki_emulator_guides/citra/citra-guide.md
- Dolphin / Primehack 🐬:
- Controls Guide: wiki_emulator_guides/dolphin-primehack/dolphin-controls.md
- General Guide (WIP): wiki_emulator_guides/dolphin-primehack/dolphin-primehack-guide.md
- Mod Guide: wiki_emulator_guides/dolphin-primehack/dolphin-primehack-mod.md
- Texture Pack Guide: wiki_emulator_guides/dolphin-primehack/dolphin-primehack-texture-pack.md
- Dolphin / Primehack - General Guide: wiki_emulator_guides/dolphin-primehack/dolphin-primehack-guide.md
- Duckstation 🐓 (Legacy):
- Duckstation - General Guide: wiki_emulator_guides/duckstation/duckstation-guide.md
@ -190,7 +186,7 @@ nav:
- RPCS3 - General Guide: wiki_emulator_guides/rpcs3/rpcs3-guide.md
- Ruffle 🌩️:
- Ruffle - General Guide (WIP): wiki_emulator_guides/ruffle/ruffle-guide.md
- Ruffle - General Guide: wiki_emulator_guides/ruffle/ruffle-guide.md
- Ryujinx 🔵 (Legacy):
- Ryujinx - General Guide: wiki_emulator_guides/ryujinx/ryujinx-guide.md