Wiki/wiki-rtd/mkdocs.yml

# Site configuration

site_name: RetroDECK Wiki
site_description: The Official RetroDECK Wiki

# Copyright
copyright: "GPL3 - RetroDECK Team"

# Theme Configuration
theme:
  name: material
  language: "en"
  logo: wiki_icons/retrodeck/icon-rd.svg
  features:
   - navigation.path
   - content.code.copy
  palette:
    scheme: slate
    primary: "deep purple"
    accent: "white"
  extra_css:
   - stylesheets/extra.css
  custom_dir: overrides

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      pygments_lang_class: true

# Used to create custom emoji/icons using .svg files. See link for usage information
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#additional-icons
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - pymdownx.superfences
  - attr_list

plugins:
  - search
  - mkdocs-audio:
  - mkdocs-video:
      is_video: True
      video_controls: True
  - 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
      post_excerpt: required
      post_excerpt_separator: <!-- more -->
  - rss:
      match_path: blog/posts/.*
      date_from_meta:
        as_creation: date
      categories:
        - categories
        - tags

# Sidebar Navigation

nav:

  - Blog:
    - blog/index.md

  - Start using RetroDECK 🏎️: wiki_general/retrodeck-start.md

  - About RetroDECK 📦:

    - What is RetroDECK?: wiki_about/what-is-retrodeck.md
    - What is systems are included in RetroDECK?: wiki_about/what-is-included.md
    - What is the Story Behind RetroDECK?: wiki_about/story-goals.md
    - Supported Devices & OS: wiki_general/supported-devices.md
    - Version History: wiki_rd_versions/version-history.md
    - Report a Problem & Known Issues: wiki_general/known-issues.md
    - How to Contribute?: wiki_about/contibute-retrodeck.md
    - Donations & Licenses: wiki_about/donations-licenses.md

  - FAQ ❔:

    - Documentation & Wiki: wiki_faq/faq-documentation.md
    - Feature Requests: wiki_faq/faq-feature.md
    - Emulation: wiki_faq/faq-emulation.md
    - RetroDECK General: wiki_faq/faq-rd-general.md
    - RetroDECK Usage: wiki_faq/faq-rd-usage.md

  - Guides - RetroDECK Controls & Hotkeys 🎮:

    - RetroDECK - Controller Hotkeys: wiki_rd_controls/hotkeys-retrodeck.md
    - RetroDECK - Simple Radial Menu: wiki_rd_controls/radial-simple.md
    - RetroDECK - Full Radial Menu: wiki_rd_controls/radial-steamdeck-full.md
    - Steam Deck - Gyro: wiki_rd_controls/gyro-steamdeck-neptune.md
    - Change Controller Order: wiki_rd_controls/change-controller-order-steam.md
    - Different Button Prompts in Games: wiki_rd_controls/diffrent-game-inputs.md
    - Udev Rules: wiki_rd_controls/about-udev.md

  - Guides - RetroDECK Management 🧰:

    - RetroDECK Configurator: wiki_system_guides/configurator/configurator.md
    - RetroDECK Folders : wiki_management/retrodeck-folders.md
    - Update RetroDECK : wiki_management/retrodeck-update.md
    - Remove RetroDECK: wiki_management/retrodeck-remove.md
    - Add RetroDECK to Steam: wiki_management/add-to-steam.md
    - Move RetroDECK to another Device: wiki_management/retrodeck-move.md
    - BIOS/Firmware: wiki_management/bios-firmware.md
    - Multidisk/file Games: wiki_management/multi-disk.md
    - Spreading Files over Multiple Drives: wiki_management/spread-files.md

  - Guides - Steam Deck 🕹️:

    - Steam Deck - Installation: wiki_devices/steamdeck/steamdeck-start.md
    - Steam Deck - Optimizations: wiki_devices/steamdeck/steamdeck-optimize.md
    - Steam Deck - Recommended Software: wiki_devices/steamdeck/steamdeck-software.md

  - Guides - Linux Desktop 🐧:

    - Linux - Installation: wiki_devices/linux_desktop/linux-install.md
    - Linux - Recommended Software: wiki_devices/linux_desktop/linux-software.md

  - Guides - Engines  🛠️:

    - GZDoom 👹:
      - GZDoom - General Guide: wiki_engine_guides/gzdoom/gzdoom-guide.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

    - 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

  - Guides - Emulators  📘:

    - Cemu ⬜:
      - Cemu - General Guide: wiki_emulator_guides/cemu/cemu-guide.md

    - Dolphin / Primehack 🐬:
      - 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

    - MAME 💰:
      - MAME - General Guide: wiki_emulator_guides/mame/mame-guide.md

    - melonDS 🍉:
      - melonDS - General Guide: wiki_emulator_guides/melonds/melonds-guide.md

    - PCSX2 2️⃣:
      - PCSX2 - General Guide: wiki_emulator_guides/pcsx2/pcsx2-guide.md

    - PPSSPP 🔺:
      - PPSSPP - General Guide: wiki_emulator_guides/ppsspp/ppsspp-guide.md

    - RetroArch 👾:
      - RetroArch - General Guide: wiki_emulator_guides/retroarch/retroarch-guide.md
      - Mesen (NES) - Texture Pack Guide: wiki_emulator_guides/retroarch/retroarch-mesen-texture-pack.md
      - Beetle (PSX) HW - Texture Pack Guide: wiki_emulator_guides/retroarch/retroarch-beetlehw-texture-pack.md
      - Mupen64Plus-Next (N64) - Texture Pack Guide: wiki_emulator_guides/retroarch/retroarch-mupen64plus-texture-pack.md

    - RPCS3 3️⃣:
      - RPCS3 - General Guide: wiki_emulator_guides/rpcs3/rpcs3-guide.md

    - Ruffle 🌩️:
      - Ruffle - General Guide: wiki_emulator_guides/ruffle/ruffle-guide.md

    - Ryujinx 🔵 (Legacy):
      - Ryujinx - General Guide: wiki_emulator_guides/ryujinx/ryujinx-guide.md

    - Vita3K 🤍:
      - Vita3K - General Guide: wiki_emulator_guides/vita3k/vita3k-guide.md

    - xemu ✖️:
      - xemu - General Guide: wiki_emulator_guides/xemu/xemu-guide.md

  - Guides - ES-DE & Other Systems 🗃️:

    - ES-DE 📺:
      - ES-DE - General Guide: wiki_system_guides/es-de/esde-guide.md

    - PortMaster 🚢:
      - PortMaster - General Guide: wiki_system_guides/portmaster/portmaster-guide.md

    - Steam Rom Manager 🚂:
      - SRM - General Guide: wiki_system_guides/srm/srm-guide.md

    - RetroENGINE 👨‍🔧:
      - RetroENGINE - General Guide: wiki_system_guides/retroengine/retroengine-guide.md

    - Ponzu 🍶:
      - Ponzu - General Guide: wiki_system_guides/ponzu/ponzu-guide.md

  - The Controller Vault 🎮:

    - 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 Type: wiki_controllers/generic/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: 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: wiki_controllers/gimmick/ride-balance-board.md
      - SEGA - Seamic Controller: 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
      - Switch - Pro (WIP): wiki_controllers/nintendo/switch-pro.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.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

    - 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

  - Development 🧪:

    - Social Rules ❤️:
      - Discord/Matrix: wiki_development/social/discord-matrix.md
      - Lemmy/Reddit: wiki_development/social/lemmy-reddit.md

    - Credits 📖:
      - Credits - RetroDECK Team: wiki_development/credits/credits-team.md
      - Credits - RetroDECK Alumni: wiki_development/credits/credits-alumni.md
      - Credits - Additional: wiki_development/credits/credits-additional.md
      - Credits - Boot Logos: wiki_development/credits/credits-boot.md
      - Credits - Collaborators: wiki_development/credits/credits-collaborators.md

    - Functions ⚙️:
      - Easter Egg Splashes: wiki_development/functions/easter-egg-splashes.md
      - Compression: wiki_development/functions/compression.md
      - Creating Emulator/Engine Presets: wiki_development/functions/emulator-presets.md

    - General 🗜️:
      - About Flatpak: wiki_development/general/retrodeck-flatpak.md
      - CLI Guide: wiki_development/general/cli-guide.md
      - Debug Mode: wiki_development/general/debug-mode.md
      - Steam Input: wiki_development/general/steam-input.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
      - Add System (WIP): wiki_development/general/add-system.md
      - Updating Systems (components): wiki_development/general/updating-components.md

    - Testing 📝:
      - Cooker Testing - FAQ: wiki_development/testing/faq-cooker.md
      - Cooker Testing - Guide: wiki_development/testing/cooker-testing.md
      - Expermental Features: wiki_development/testing/experimental-features.md

  - Archive 📂:

    - Citra 🍋 (Archive):
      - Citra - General Guide: wiki_archive/citra/citra-guide.md

    - Yuzu 🔴 (Archive):
      - Yuzu - General Guide: wiki_archive/yuzu/yuzu-guide.md
      - Yuzu - Gyro Guide: wiki_archive/yuzu/yuzu-gyro.md