Wiki/wiki-rtd/mkdocs.yml
2024-06-02 11:17:48 +02:00

317 lines
15 KiB
YAML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Site configuration
site_name: RetroDECK Wiki
site_description: The Official RetroDECK Wiki
# Copyright
copyright: "© 2024 RetroDECK Team"
# Theme Configuration
theme:
name: "material"
language: "en"
logo: wiki_icons/retrodeck/rd_icon_circle_32x32.png
features:
- navigation.path
palette:
scheme: slate
primary: "deep purple"
accent: "white"
extra_css:
- stylesheets/extra.css
markdown_extensions:
- attr_list
plugins:
- search:
- mkdocs-video:
is_video: True
# video_muted: True
video_controls: True
# css_style:
# width: "50%"
- rss:
match_path: blog/posts/.*
date_from_meta:
as_creation: date
categories:
- categories
- tags
- blog:
enabled: true
post_url_date_format: yyyy/MM/dd
post_date_format: full
blog_toc: true
archive: true
archive_date_format: yyyy
pagination: false
pagination: false
post_excerpt: required
post_excerpt_separator: <!-- more -->
# Sidebar Navigation
nav:
- Wiki Home 🏠: index.md
- Blog: blog/index.md+
- Archive 🗃️:
- Yuzu 🔴 (Archive):
- Yuzu - General Guide: wiki_emulator_guides/yuzu/yuzu-guide.md
- Yuzu - Mod Guide: wiki_emulator_guides/yuzu/yuzu-mod.md
- Yuzu - Gyro Guide: wiki_emulator_guides/yuzu/yuzu-gyro.md
- Citra 🍋 (Archive):
- Citra - General Guide: wiki_emulator_guides/citra/citra-guide.md
- Citra - Mod Guide: wiki_emulator_guides/citra/citra-mod.md
- Citra - Texture Pack Guide: wiki_emulator_guides/citra/citra-texture-pack.md
- About 📜:
- RetroDECK Beta: wiki_about/beta-period.md
- What is RetroDECK?: wiki_about/what-is-retrodeck.md
- What is included in RetroDECK?: wiki_about/what-is-included.md
- Story & Philosophy: wiki_about/story-philosophy.md
- Visions & Goals: wiki_about/visions-and-goals.md
- General Information 📰:
- Start using RetroDECK: wiki_general/retrodeck-start.md
- What is the current Version?: wiki_rd_versions/version_0.8.0b/0.8.1b.md
- Supported Devices: wiki_general/supported-devices.md
- Supported Controllers: wiki_general/supported-controllers.md
- Version History (Patchnotes): wiki_rd_versions/version-history.md
- What are you working on?: wiki_development/general/what-are-you-working.on.md
- Bugs & Issues 🐜:
- Reporting Bugs: wiki_bugs/report-bugs.md
- Known Issues: wiki_bugs/known-issues.md
- Configurator & Tools 🧰:
- Configurator Features: wiki_configurator/configurator.md
- Ponzu: wiki_configurator/ponzu.md
- Controls & Hotkeys for RetroDECK 🎮:
- About :
- Different Button Prompts in Games: wiki_controllers/about/diffrent-game-inputs.md
- RetroDECK and Udev Rules: wiki_controllers/about/about-udev.md
- RetroDECK and Steam Input: wiki_steam/steam-input.md
- Hotkeys & Layouts 🔥:
- Generic Standard - Hotkeys & Layout: wiki_rd_controls/hotkeys-generic-standard.md
- Nintendo - Hotkeys & Layout: wiki_rd_controls/hotkeys-nintendo.md
- Playstation - Hotkeys & Layout: wiki_rd_controls/hotkeys-playstation.md
- Xbox - Hotkeys & Layout: wiki_rd_controls/hotkeys-xbox.md
- Radial Menus ⭕:
- RetroDECK - Simple Radial Menu: wiki_rd_controls/radial-simple.md
- Steam Deck - Full Radial Menu: wiki_rd_controls/radial-steamdeck-full.md
- Controllers 🎮:
- Accessibility ♿:
- About Accessibility Controllers: wiki_controllers/accessibility/about-accessibility.md
- Xbox Adaptive Controller: wiki_controllers/accessibility/xac.md
- Arcade 🕹️:
- About Arcade Controllers: wiki_controllers/arcade/about-arcade.md
- Flight ✈️:
- About Flight Controllers: wiki_controllers/flight/about-flight.md
- Generic 🎮:
- Generic Standard: wiki_controllers/generic/standard/generic-standard.md
- Gimmick 🤡:
- About Gimmick Controllers: wiki_controllers/gimmick/about-gimmick.md
- Buzz - Buzzers (WIP): wiki_controllers/gimmick/buzz-buzzers.md
- Cycling Sports - Cyberbike (WIP): wiki_controllers/gimmick/cyberbike.md
- Densha de Go! - Shinkansen Cockpit (WIP): wiki_controllers/gimmick/shinkansen-cockpit.md
- Drawsome! - Tablet (WIP): wiki_controllers/gimmick/drawsome-tablet.md
- EA - Active Heart Rate Monitor (WIP): wiki_controllers/gimmick/active-heart-rate-monitor.md
- RIDE - Balance Board (WIP): wiki_controllers/gimmick/ride-balance-board.md
- SEGA - Seamic Controller (WIP): wiki_controllers/gimmick/sega-seamic.md
- Steel Battalion - Cockpit: wiki_controllers/gimmick/steel-battalion-cockpit.md
- Udraw - Tablet (WIP): wiki_controllers/gimmick/udraw-tablet.md
- Lightguns 🔫:
- About Lightguns: wiki_controllers/lightgun/about-lightguns.md
- AE Lightgun (WIP): wiki_controllers/lightgun/ae-lightgun.md
- Aimtrak (WIP): wiki_controllers/lightgun/aimtrak.md
- GUN4IR (WIP): wiki_controllers/lightgun/gun4ir.md
- GunCon 1/2 (WIP): wiki_controllers/lightgun/guncon-1-2.md
- GunCon 3 (WIP): wiki_controllers/lightgun/guncon-3.md
- SAMCO (WIP): wiki_controllers/lightgun/samco.md
- Sinden (WIP): wiki_controllers/lightgun/sinden.md
- Wii Remote Gun (WIP): wiki_controllers/lightgun/wii-remote-gun.md
- Music / Rhythm🎵:
- About Music / Rhythm Controllers: wiki_controllers/music/about-music.md
- Dance Pads: wiki_controllers/music/dance-pads.md
- DJ Hero - Turntable (WIP): wiki_controllers/music/dj-hero-turntable.md
- DK Bongos: wiki_controllers/music/dk-bongos.md
- Guitar Hero / Rockband - Button Guitars (WIP): wiki_controllers/music/guitar-rb-gh.md
- Guitar Hero / Rockband - Drums (WIP): wiki_controllers/music/drums-rb-gh.md
- Guitar Hero / Rockband - Microphone (WIP): wiki_controllers/music/microphone-rb-gh.md
- Keyboardmania - Keyboard (WIP): wiki_controllers/music/keyboardmania-keyboard.md
- Rockband - Keyboard (WIP): wiki_controllers/music/keyboard-rb.md
- Singstar - Microphone (WIP): wiki_controllers/music/singstar-microphone.md
- Taiko Drum & Bachi (WIP): wiki_controllers/music/taiko-drum-bachi.md
- Nintendo 🎮:
- Switch - Joy-Cons (WIP): wiki_controllers/nintendo/joycon.md
- Switch - Ring Fit (WIP): wiki_controllers/nintendo/ring-fit.md
- Wii U - Gamepad: wiki_controllers/nintendo/wiiu-gamepad.md
- Wii - Wii Remote (Wiimote): wiki_controllers/nintendo/wii-remote.md
- Wii - Wii Balance Board (WIP): wiki_controllers/nintendo/wii-balance-board.md
- Gamecube - PC / WiiU Adapter: wiki_controllers/nintendo/gamecube-adapter.md
- Playstation 🎮:
- Playstation 2 - EyeToy: wiki_controllers/playstation/eyetoy.md
- Playstation 3 - DualShock 3: wiki_controllers/playstation/dualshock-3.md
- Playstation 3 - Eye & Move: wiki_controllers/playstation/playstation-move.md
- Playstation 4 - DualShock 4: wiki_controllers/playstation/dualshock-4.md
- Playstation 5 - DualSense: wiki_controllers/playstation/dualsense.md
- Playstation 5 - DualSense Edge: wiki_controllers/playstation/dualsense-edge.md
- Racing 🏎️:
- About Racing Controllers: wiki_controllers/racing/about-racing.md
- Steam/Valve 🎮:
- Steam Deck - Controller: wiki_controllers/steam/steamdeck-neptune-controller.md
- Steam - Steam Controller - Gordon: wiki_controllers/steam/steam-controller-gordon.md
- Toys-to-life 🧸:
- About Toys-to-life Controllers: wiki_controllers/toystolife/about-toys-to-life.md
- Disney Infinity - Infinity Base (WIP): wiki_controllers/toystolife/disney-infinity-base.md
- Kamen Rider Summonride - Summonrider Portal (WIP): wiki_controllers/toystolife/kamen-rider-summonrider-portal.md
- LEGO Dimensions - LEGO ToyPad: wiki_controllers/toystolife/lego-toypad.md
- Skylanders - Portal of Power (WIP): wiki_controllers/toystolife/skylanders-portal-of-power.md
- Skylanders - Traptanium Portal (WIP): wiki_controllers/toystolife/skylanders-traptanium-portal.md
- Xbox 🎮:
- Xbox 360 - Controller: wiki_controllers/xbox/xbox-360.md
- Xbox 360 - Kinect V1: wiki_controllers/xbox/xbox-360-kinect.md
- Xbox One - Kinect V2: wiki_controllers/xbox/xbox-one-kinect.md
- Xbox One/S/X - Xbox Wireless Controller: wiki_controllers/xbox/xbox-wireless.md
- Xbox S/X - Xbox Elite Series 2: wiki_controllers/xbox/xbox-wireless-elite.md
- Xbox Adaptive Controller (WIP): wiki_controllers/accessibility/xac.md
- Community & Helping Out ❤️:
- Discord: wiki_community/discord.md
- Lemmy/Reddit: wiki_community/lemmy-reddit.md
- How to Contribute to RetroDECK?: wiki_community/contibute-rd.md
- Credits & Donations 📖:
- Credits - Team: wiki_credits/credits-team.md
- Credits - Additional: wiki_credits/credits-additional.md
- Credits - Boot Logo: wiki_credits/credits-boot.md
- Credits - Translations: wiki_credits/credits-translation.md
- Donations & Licenses 🎁: wiki_credits/donations-licenses.md
- Development 🧪:
- Flatpak 📦:
- About Flatpak: wiki_development/flatpak/retrodeck-flatpak.md
- Functions ⚙️:
- Easter Egg Splashes: wiki_development/functions/easter-egg-splashes.md
- Compression: wiki_development/functions/compression.md
- General 🗜️:
- CLI Guide: wiki_development/general/cli-guide.md
- Debug Mode: wiki_development/general/debug-mode.md
- Folders and Filepaths: wiki_development/general/folders-filepaths.md
- Start with Development (WIP): wiki_development/general/general-development.md
- Build Locally (WIP): wiki_development/general/build-locally.md
- Testing 📝:
- How do I help out with testing?: wiki_development/testing/general-testing.md
- Release Candidate Testing: wiki_development/testing/release-candidate-testing.md
- Files & Game Management 📂:
- Game Compability Lists: wiki_management/retrodeck-move.md
- Manage your BIOS/Firmware: wiki_management/bios-firmware.md
- Manage your Multidisk/file games: wiki_management/multi-disk.md
- Move RetroDECK to a new device: wiki_management/retrodeck-move.md
- Scraping Game Media: wiki_management/about-scraping.md
- Spreading Files over Multiple Drives: wiki_management/spread-files.md
- FAQ ❔:
- Documentation & Wiki: wiki_faq/faq-documentation.md
- Feature Requests: wiki_faq/faq-feature.md
- ES-DE Frontend: wiki_faq/faq-esde.md
- ES-DE Scraping: wiki_faq/faq-scraping.md
- RetroDECK General: wiki_faq/faq-rd-general.md
- RetroDECK Usage: wiki_faq/faq-rd-usage.md
- Steam Deck: wiki_faq/faq-rd-steamdeck.md
- Guides - Steam Deck 🕹️:
- RetroDECK Installation and Updates: wiki_devices/steamdeck/steamdeck-start.md
- Optimizations: wiki_devices/steamdeck/steamdeck-optimize.md
- Recommended Software: wiki_devices/steamdeck/steamdeck-software.md
- RetroDECK Controls: wiki_controllers/steam/steamdeck-neptune-controller.md
- Built-in Controls: wiki_controllers/steam/steamdeck-neptune-builtin.md
- Guides - Linux Desktop 🐧:
- Installation and Updates: wiki_devices/linux_desktop/linux-install.md
- Recommended Software: wiki_devices/linux_desktop/linux-software.md
- Guides - RetroDECK with Steam 💻:
- Add RetroDECK to Steam: wiki_steam/add-to-steam.md
- Enable Controllers in Steam: wiki_steam//enable-controllers-steam.md
- Change controller order in Steam: wiki_steam//set-controller-order-steam.md
- RetroDECK and Steam Input: wiki_steam/steam-input.md
- Guides - ES-DE Frontend 🤖:
- ES-DE - User Guide: wiki_es_de/esde-guide.md
- Themes: wiki_es_de/esde-themes.md
- Guides - Engines 🛠️:
- 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
- IkemenGO / M.U.G.E.N 🥋:
- IkemenGO - General Guide: wiki_engine_guides/ikemengo/ikemengo-guide.md
- IkemenGO - M.U.G.E.N Convertion Guidelines: wiki_engine_guides/ikemengo/mugen-conversion.md
- Pico-8 8:
- Pico-8 - General Guide: wiki_engine_guides/pico8/pico8-guide.md
- ScummVM 🖱️:
- ScummVM - General Guide: wiki_engine_guides/scummvm/scummvm-guide.md
- Solarus 🌞:
- Solarus - General Guide: wiki_engine_guides/solarus/solarus-guide.md
- OpenBOR 🐉:
- OpenBOR - General Guide: wiki_engine_guides/openbor/openbor-guide.md
- Guides - Emulators 📘:
- Cemu ⬜:
- Cemu - General Guide (WIP): wiki_emulator_guides/cemu/cemu-guide.md
- Dolphin / Primehack 🐬:
- 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
- Duckstation 🐓:
- Duckstation - General Guide (WIP): wiki_emulator_guides/duckstation/duckstation-guide.md
- Duckstation - Texture Pack Guide: wiki_emulator_guides/duckstation/duckstation-texture-pack.md
- MAME 💰:
- MAME - General Guide (WIP): wiki_emulator_guides/mame/mame-guide.md
- melonDS 🍉:
- General Guide (WIP): wiki_emulator_guides/melonds/melonds-guide.md
- PCSX2 2:
- PCSX2 - General Guide (WIP): wiki_emulator_guides/pcsx2/pcsx2-guide.md
- PCSX2 - Texture Pack Guide: wiki_emulator_guides/pcsx2/pcsx2-texture-pack.md
- PPSSPP 🔺:
- PPSSPP - General Guide (WIP): wiki_emulator_guides/ppsspp/ppsspp-guide.md
- PPSSPP - Texture Pack Guide: wiki_emulator_guides/ppsspp/ppsspp-texture-pack.md
- RetroArch 👾:
- RetroArch - General Guide: wiki_emulator_guides/retroarch/retroarch-guide.md
- RetroArch - Cores with Rewind support: wiki_emulator_guides/retroarch/retroarch-rewind.md
- Mesen Core - Texture Pack Guide: wiki_emulator_guides/retroarch/retroarch-mesen-texture-pack.md
- Mupen64Plus-Next Core - Texture Pack Guide: wiki_emulator_guides/retroarch/retroarch-mupen64plus-texture-pack.md
- RPCS3 3:
- RPCS3 - General Guide: wiki_emulator_guides/rpcs3/rpcs3-guide.md
- Ryujinx 🔵:
- Ryujinx - General Guide (WIP): wiki_emulator_guides/ryujinx/ryujinx-guide.md
- Ryujinx - Mod Guide (WIP): wiki_emulator_guides/ryujinx/ryujinx-mod.md
- Vita3K 🤍:
- Vita3K - General Guide: wiki_emulator_guides/vita3k/vita3k-guide.md
- xemu ✖️:
- xemu - General Guide: wiki_emulator_guides/xemu/xemu-guide.md