mkdocs.yml

%YAML 1.2
---
site_name: Libretro Docs
site_url: 'https://docs.libretro.com/'
site_description: >-2
  This is the official RetroArch documentation for users and developers.
  Information from sources outside of this website may be dated or incorrect.
repo_name: 'libretro/docs'
repo_url: 'https://github.com/libretro/docs'
edit_uri: 'edit/master/docs'
copyright: >2
  Copyright © 2010–2025 Libretro. –
  <a href="#__consent">Change cookie settings</a>
nav:
  - 'About': 'index.md'
  - 'Start':
      - 'Understanding': 'start/understanding.md'
      - 'Installation': 'start/installation.md'
      - 'Love at first sight': 'start/love-at-first-sight.md'
      - 'Last Station': 'start/last-station.md'
  - 'For Users':
    - 'Getting Started':
      - 'Windows':
        - 'Windows 7/8/8.1/10/11': 'guides/install-windows.md'
        - 'Windows 2000/ME/98SE': 'guides/install-windows-2000-me-98SE.md'
      - 'GNU/Linux': 'guides/install-gnu.md'
      - 'Apple':
        - 'macOS': 'guides/install-macos.md'
        - 'iOS/tvOS': 'guides/install-ios.md'
      - 'Android': 'guides/install-android.md'
      - 'Nintendo':
        - 'Switch': 'guides/install-libnx.md'
        - '3DS/2DS Family': 'guides/install-3ds2ds.md'
      - 'Sony':
        - 'PlayStation Portable': 'guides/install-psp.md'
        - 'PlayStation Vita': 'guides/install-psv.md'
        - 'PlayStation 2': 'guides/install-ps2.md'
        - 'PlayStation 3': 'guides/install-ps3.md'
        - 'PlayStation Classic': 'guides/install-psc.md'
      - 'TV': 'guides/tv.md'
      - 'Others':
        - 'Lakka':
          - 'Installing': 'guides/install-lakka.md'
          - 'Building': 'guides/building-lakka.md'
        - 'Ludo':
          - 'Installing': 'guides/install-ludo.md'
          - 'Building': 'guides/building-ludo.md'
        - 'Steam Link': 'guides/install-steamlink.md'
        - 'Web Player': 'guides/web-player.md'
        - 'Sega Genesis Mini': 'guides/install-genesismini.md'
        - 'Facebook Portal': 'guides/install-facebookportal.md'
    - 'User Guides':
      - 'User Interface': 'guides/navigating.md'
      - 'Input and Controls': 'guides/input-and-controls.md'
      - 'Starting a Game': 'guides/starting-a-game.md'
      - 'Controller Auto-Configuration': 'guides/controller-autoconfiguration.md'
      - 'Installing Cores': 'guides/download-cores.md'
      - 'Core List': 'guides/core-list.md'
      - 'Directory Configuration': 'guides/change-directories.md'
      - 'File Browser': 'guides/file-browser.md'
      - 'Launching Content': 'guides/launch-content.md'
      - 'Menu Styles': 'guides/gui.md'
      - 'Quick Menu': 'guides/quick-menu.md'
      - 'Importing Content': 'guides/import-content.md'
      - 'Shaders': 'guides/shaders.md'
      - 'Overrides: Content/Folder/Core-Specific Settings': 'guides/overrides.md'
      - 'Cheat/Rumble Codes': 'guides/cheat-codes.md'
      - 'Input Overlays': 'guides/libretro-overlays.md'
      - 'Overlay Mouse & Lightgun': 'guides/overlay-pointing-devices.md'
      - 'What is BIOS?': 'guides/bios.md'
      - 'Netplay':
        - 'FAQ': 'guides/netplay-faq.md'
        - 'Getting Started': 'guides/netplay-getting-started.md'
        - 'Multiple Controllers': 'guides/netplay-multiple-controllers.md'
      - 'RetroAchievements': 'guides/retroachievements.md'
      - 'Memory Monitoring': 'guides/memorymonitoring.md'
      - 'Disc Swapping': 'guides/disc-swapping.md'
      - 'Softpatching ROMs': 'guides/softpatching.md'
      - 'Accessibility':
        - 'Quick Start': 'guides/accessibility.md'
        - 'Guide': 'guides/retroarch-accessibility-guide.md'
      - 'Video Recording and Streaming': 'guides/recording-and-streaming.md'
      - 'Troubleshooting': 'guides/troubleshooting-retroarch.md'
      - 'Generating Logs': 'guides/generating-retroarch-logs.md'
      - 'RetroArch Cloud Sync': 'guides/retroarch-cloud-sync.md'
      - 'Databases & Validation': 'guides/databases.md'
    - 'Appearance & Customization':
      - 'Interface Styles':
        - 'GLUI Interface': 'guides/glui.md'
        - 'Ozone Interface': 'guides/ozone.md'
        - 'RGUI Interface': 'guides/rgui.md'
        - 'XMB Interface': 'guides/xmb.md'
      - 'Creating a Theme': 'guides/themes.md'
      - 'Playlists and Thumbnails': 'guides/roms-playlists-thumbnails.md'
      - 'XMB Menu Map': 'guides/xmb-menu-map.md'
    - 'Advanced':
      - 'AI Service': 'guides/ai-service.md'
      - 'Command-Line Interface (CLI)': 'guides/cli-intro.md'
      - 'CRT SwitchRes': 'guides/crtswitchres.md'
      - 'Input and Controller Drivers': 'guides/input-controller-drivers.md'
      - 'Latency': 'guides/latency.md'
      - 'LED Drivers': 'guides/led-drivers.md'
      - 'Linux KMS Mode': 'guides/kms-mode.md'
      - 'Optimal Vsync Performance': 'guides/optimal-vsync.md'
      - 'Raspberry Pi': 'guides/rpi.md'
      - 'Run Ahead': 'guides/runahead.md'
    - 'Lakka Documentation': 'http://www.lakka.tv/doc/Home/'
    - 'Core Library: Emulation':
      - 'Getting Started with Arcade Emulation': 'guides/arcade-getting-started.md'
      - 'Getting Started with MAME Software List Emulation': 'guides/softwarelist-getting-started.md'
      - 'BIOS Information Hub': 'library/bios.md'
      - '3DO Emulation':
        - 'The 3DO Company - 3DO (Opera)': 'library/opera.md'
        - '3DO Compatibility List': 'library/compatibility/3do.md'
      - 'Acorn Emulation':
        - 'Acorn - BBC Micro (b2)': 'library/b2.md'
      - 'Amstrad Emulation':
        - 'Amstrad - CPC (Caprice32)': 'library/caprice32.md'
        - 'Amstrad - CPC (CrocoDS)': 'library/crocods.md'
      - 'Apple':
        - 'Apple - Macintosh (minivmac)': 'library/minivmac.md'
      - 'Arcade Emulation':
        - 'Arcade (DICE)': 'library/dice.md'
        - 'Arcade (FinalBurn Neo)': 'library/fbneo.md'
        - 'Arcade (MAME 2003)': 'library/mame_2003.md'
        - 'Arcade (MAME 2003-Plus)': 'library/mame2003_plus.md'
        - 'Arcade (MAME 2010)': 'library/mame_2010.md'
        - 'Arcade (SAME_CDI)': 'library/same_cdi.md'
      - 'Arduboy':
        - 'Ardens': 'library/ardens.md'
      - 'Atari Emulation':
        - 'Atari - Jaguar Compatibility List': 'library/compatibility/jaguar.md'
        - 'Atari - Lynx Compatibility List:': 'library/compatibility/lynx.md'
        - 'Atari - 2600 (Stella)': 'library/stella.md'
        - 'Atari - 7800 (ProSystem)': 'library/prosystem.md'
        - 'Atari - 5200 (Atari800)': 'library/atari800.md'
        - 'Atari - Jaguar (Virtual Jaguar)': 'library/virtual_jaguar.md'
        - 'Atari - Lynx (Beetle Lynx)': 'library/beetle_lynx.md'
        - 'Atari - Lynx (Gearlynx)': 'library/gearlynx.md'
        - 'Atari - Lynx (Handy)': 'library/handy.md'
        - 'Atari - Lynx (Holani)': 'library/holani.md'
        - 'Atari - ST/STE/TT/Falcon (Hatari)': 'library/hatari.md'
        - 'Atari - ST/STE/TT/Falcon (hatariB)': 'library/hatarib.md'
      - 'Bandai Emulation':
        - 'Bandai - Playdia (PlaydiaEmu)': 'library/playdiaemu.md'
        - 'Bandai - WonderSwan/Color (Beetle Cygne)': 'library/beetle_cygne.md'
        - 'Bandai - Wonderswan Compatibility List': 'library/compatibility/wswan.md'
      - 'BBK electronic dictionary':
        - 'BBK - 4980/4988/5980 electronic dictionary': 'library/gam4980.md'
      - 'ColecoVision Emulation':
        - 'ColecoVision (Gearcoleco)': 'library/gearcoleco.md'
        - 'ColecoVision/CreatiVision/My Vision (JollyCV)': 'library/jollycv.md'
        - 'MSX/SVI/ColecoVision/SG-1000 (blueMSX)': 'library/bluemsx.md'
      - 'Commodore Emulation':
        - 'Commodore - 8-bit (VICE)': 'library/vice.md'
        - 'Commodore - Amiga (PUAE)': 'library/puae.md'
      - 'DOS Emulation':
        - 'MS - DOS (DOSBox)': 'library/dosbox.md'
        - 'MS - DOS (DOSBox Pure)': 'library/dosbox_pure.md'
        - 'MS - DOS (VirtualXT)': 'library/virtualxt.md'
      - 'Dingoo Emulation':
        - 'Dingoo - A320 (DingooEmu)': 'library/dingooemu.md'
      - 'Emerson':
        - 'Emerson - Arcadia 2001 / Interton VC 4000 (AmiArcadia)': 'library/amiarcadia.md'
      - 'Enterprise Emulation':
        - 'Enterprise 128 (ep128emu)': 'library/ep128emu.md'
      - 'Elektronika':
        - 'Elektronika - BK-0010/BK-0011 (bk)': 'library/bk.md'
      - 'Epoch Emulation':
        - 'Epoch - Cassette Vision (PD777)': 'library/pd777.md'
        - 'Epoch - Super Cassette Vision (EmuSCV)': 'library/emuscv.md'
      - 'GCE Emulation':
        - 'GCE - Vectrex (vecx)': 'library/vecx.md'
      - 'Magnavox Emulation':
        - 'Magnavox - Odyssey2 / Philips Videopac+ (O2EM)': 'library/o2em.md'
      - 'Mattel Emulation':
        - 'Mattel - Intellivision (FreeIntv)': 'library/freeintv.md'
      - 'Microsoft Emulation':
        - 'Microsoft - MSX (fMSX)': 'library/fmsx.md'
        - 'MSX/SVI/ColecoVision/SG-1000 (blueMSX)': 'library/bluemsx.md'
      - 'Mobile Emulation':
        - 'Mobile - J2ME (FreeJ2ME)': 'library/freej2me.md'
        - 'Mobile - J2ME (FreeJ2ME-Plus)': 'library/freej2me_plus.md'
      - 'Nintendo Emulation':
        - 'Nintendo - DS Compatibility List': 'library/compatibility/ds.md'
        - 'Nintendo - Game Boy Advance Compatibility List': 'library/compatibility/gba.md'
        - 'Nintendo - Game Boy Color Compatibility List': 'library/compatibility/gbc.md'
        - 'Nintendo - NES Compatibility List': 'library/compatibility/nes.md'
        - 'Nintendo - SNES Compatibility List': 'library/compatibility/snes.md'
        - 'Nintendo - Game Boy / Color (Emux GB)': 'library/emux_gb.md'
        - 'Nintendo - Game Boy / Color (Gambatte)': 'library/gambatte.md'
        - 'Nintendo - Game Boy / Color (SameBoy)': 'library/sameboy.md'
        - 'Nintendo - Game Boy / Game Boy Color (TGB Dual)': 'library/tgb_dual.md'
        - 'Nintendo - Game Boy / Color (Gearboy)': 'library/gearboy.md'
        - 'Nintendo - Game Boy Advance (Beetle GBA)': 'library/beetle_gba.md'
        - 'Nintendo - Game Boy Advance (gpSP)': 'library/gpsp.md'
        - 'Nintendo - Game Boy Advance (Meteor)': 'library/meteor.md'
        - 'Nintendo - Game Boy Advance (mGBA)': 'library/mgba.md'
        - 'Nintendo - Game Boy Advance (TempGBA)': 'library/tempgba.md'
        - 'Nintendo - Game Boy Advance (VBA Next)': 'library/vba_next.md'
        - 'Nintendo - Game Boy Advance (VBA-M)': 'library/vba_m.md'
        - 'Nintendo - GameCube/Wii (Dolphin)': 'library/dolphin.md'
        - 'Nintendo - NES (bnes)': 'library/bnes.md'
        - 'Nintendo - NES / Famicom (Emux NES)': 'library/emux_nes.md'
        - 'Nintendo - NES / Famicom (FCEUmm)': 'library/fceumm.md'
        - 'Nintendo - NES / Famicom (Mesen)': 'library/mesen.md'
        - 'Nintendo - NES / Famicom (Nestopia)': 'library/nestopia.md'
        - 'Nintendo - NES / Famicom (QuickNES)': 'library/quicknes.md'
        - 'Nintendo - NES / Famicom (RustyNES)': 'library/rustynes.md'
        - 'Nintendo - 3DS (Citra)': 'library/citra.md'
        - 'Nintendo - 3DS (Citra Canary/Experimental)': 'library/citra_canary.md'
        - 'Nintendo - Nintendo 64 (Mupen64Plus)': 'library/mupen64plus.md'
        - 'Nintendo - DS (DeSmuME 2015)': 'library/desmume_2015.md'
        - 'Nintendo - DS (DeSmuME)': 'library/desmume.md'
        - 'Nintendo - DS (melonDS DS)': 'library/melonds_ds.md'
        - 'Nintendo - DS (melonDS 2021)': 'library/melonds.md'
        - 'Nintendo - Pokémon Mini (PokeMini)': 'library/pokemini.md'
        - 'Nintendo - SNES / Famicom (Beetle bsnes)': 'library/beetle_bsnes.md'
        - 'Nintendo - SNES / SFC (bsnes)': 'library/bsnes.md'
        - 'Nintendo - SNES / Famicom (bsnes-jg)': 'library/bsnes-jg.md'
        - 'Nintendo - SNES / Famicom (bsnes Accuracy)': 'library/bsnes_accuracy.md'
        - 'Nintendo - SNES / Famicom (bsnes Balanced)': 'library/bsnes_balanced.md'
        - 'Nintendo - SNES / Famicom (bsnes C++98 (v085))': 'library/bsnes_cplusplus98.md'
        - 'Nintendo - SNES / Famicom (bsnes Performance)': 'library/bsnes_performance.md'
        - 'Nintendo - SNES / Famicom (bsnes-mercury Accuracy)': 'library/bsnes_mercury_accuracy.md'
        - 'Nintendo - SNES / Famicom (bsnes-mercury Balanced)': 'library/bsnes_mercury_balanced.md'
        - 'Nintendo - SNES / Famicom (bsnes-mercury Performance)': 'library/bsnes_mercury_performance.md'
        - 'Nintendo - SNES / Famicom (higan Accuracy)': 'library/higan_accuracy.md'
        - 'Nintendo - SNES / Famicom (nSide Balanced)': 'library/nside_balanced.md'
        - 'Nintendo - SNES / SFC / Game Boy / Color (Mesen-S)': 'library/mesen-s.md'
        - 'Nintendo - SNES / Famicom (Snes9x 2002)': 'library/snes9x_2002.md'
        - 'Nintendo - SNES / Famicom (Snes9x 2005 Plus)': 'library/snes9x_2005_plus.md'
        - 'Nintendo - SNES / Famicom (Snes9x 2005)': 'library/snes9x_2005.md'
        - 'Nintendo - SNES / Famicom (Snes9x 2010)': 'library/snes9x_2010.md'
        - 'Nintendo - SNES / Famicom (Snes9x)': 'library/snes9x.md'
        - 'Nintendo - Virtual Boy (Beetle VB)': 'library/beetle_vb.md'
      - 'NEC Emulation':
        - 'NEC - PC-FX Compatibility List': 'library/compatibility/pcfx.md'
        - 'NEC - PC-8000 / PC-8800 series (QUASI88)': 'library/quasi88.md'
        - 'NEC - PC-98 (Neko Project II Kai)': 'library/neko_project_ii_kai.md'
        - 'NEC - PC Engine SuperGrafx (Beetle SGX)': 'library/beetle_sgx.md'
        - 'NEC - PC Engine / CD (Beetle PCE FAST)': 'library/beetle_pce_fast.md'
        - 'NEC - PC Engine / SuperGrafx (Geargrafx)': 'library/geargrafx.md'
        - 'NEC - PC-FX (Beetle PC-FX)': 'library/beetle_pc_fx.md'
      - 'Palm Emulation':
        - 'Palm OS (Mu)': 'library/mu.md'
      - 'Philips Emulation':
        - 'Magnavox - Odyssey2 / Philips Videopac+ (O2EM)': 'library/o2em.md'
        - 'Philips - P2000T (M2000)': 'library/m2000.md'
      - 'RISC-V Emulation':
        - 'RVVM - RISC-V Virtual Machine': 'library/rvvm.md'
      - 'SNK Emulation':
        - 'SNK - Neo Geo AES / MVS (Geolith)': 'library/geolith.md'
        - 'SNK - Neo Geo Pocket / Color (Beetle NeoPop)': 'library/beetle_neopop.md'
        - 'SNK - Neo Geo Pocket / Color (RACE)': 'library/race.md'
      - 'Sega Emulation':
        - 'Sega - 32X Compatibility List': 'library/compatibility/32x.md'
        - 'Sega - Dreamcast Compatibility List': 'library/compatibility/dc.md'
        - 'Sega - Saturn Compatibility List': 'library/compatibility/saturn.md'
        - 'Sega - Dreamcast (flycast)': 'library/flycast.md'
        - 'Sega - Dreamcast (redream)': 'library/redream.md'
        - 'Sega - Dreamcast VMU (VeMUlator)': 'library/vemulator.md'
        - 'Sega - Master System (Emux SMS)': 'library/emux_sms.md'
        - 'Sega - MS/GG (SMS Plus GX)': 'library/smsplus.md'
        - 'Sega - MS/GG/SG-1000 (Gearsystem)': 'library/gearsystem.md'
        - 'Sega - MS/GG/MD/CD (Genesis Plus GX)': 'library/genesis_plus_gx.md'
        - 'Sega - MS/MD/CD/32X (PicoDrive)': 'library/picodrive.md'
        - 'Sega - MD/CD (BlastEm)': 'library/blastem.md'
        - 'Sega - MD/CD (ClownMDEmu)': 'library/clownmdemu.md'
        - 'Sega - Saturn (Beetle Saturn)': 'library/beetle_saturn.md'
        - 'Sega - Saturn/ST-V (Kronos)': 'library/kronos.md'
        - 'Sega - Saturn (Yabause)': 'library/yabause.md'
        - 'Sega - Saturn (YabaSanshiro)': 'library/yabasanshiro.md'
        - 'Sega - Model 3 (Supermodel)': 'library/supermodel.md'
        - 'MSX/SVI/ColecoVision/SG-1000 (blueMSX)': 'library/bluemsx.md'
      - 'Sharp Emulation':
        - 'Sharp - X68000 (PX68k)': 'library/px68k.md'
      - 'Sinclair Emulation':
        - 'Sinclair - ZX 81 (EightyOne)': 'library/eightyone.md'
        - 'Sinclair - ZX Spectrum (Fuse)': 'library/fuse.md'
      - 'Sony Emulation':
        - 'Sony - Playstation Compatibility List': 'library/compatibility/psx.md'
        - 'Sony - PlayStation (Beetle PSX)': 'library/beetle_psx.md'
        - 'Sony - PlayStation (Beetle PSX HW)': 'library/beetle_psx_hw.md'
        - 'Sony - PlayStation (PCSX ReARMed)': 'library/pcsx_rearmed.md'
        - 'Sony - PlayStation 2 (PCSX2)': 'library/lrps2.md'
        - 'Sony - PlayStation 2 (Play!)': 'library/play.md'
        - 'Sony - PlayStation Portable (PPSSPP)': 'library/ppsspp.md'
      - 'SpectraVision Emulation':
        - 'MSX/SVI/ColecoVision/SG-1000 (blueMSX)': 'library/bluemsx.md'
      - 'Sunplus Emulation':
        - 'Sunplus - Native32 (Native32Emu)': 'library/native32emu.md'
        - 'Sunplus - SPMP8000 (SPMP8000Emu)': 'library/spmp8000emu.md'
      - 'MStar Emulation':
        - 'MStar - Nicai (NicaiEmu)': 'library/nicaiemu.md'
      - 'Texas Instruments Emulation':
        - 'Texas Instruments - TI-83 (Numero)': 'library/numero.md'
      - 'Thomson Emulation':
        - 'Thomson - MO/TO (Theodore)': 'library/theodore.md'
      - 'Wenquxing Emulation':
        - 'Wenquxing - Electronic Dictionary (WQXEmu)': 'library/wqxemu.md'
      - 'MegaDuck Emulation':
        - 'Welback Holdings - Mega Duck (SameDuck)': 'library/sameduck.md'
    - 'Core Library: Game and Scripting Engines':
      - '2048': 'library/2048.md'
      - '3D Engine': 'library/3d_engine.md'
      - 'Anarch': 'library/anarch.md'
      - 'Cave Story (doukutsu-rs)': 'library/doukutsu-rs.md'
      - 'Cave Story (NXEngine)': 'library/nxengine.md'
      - 'Cannonball': 'library/cannonball.md'
      - 'ChaiLove': 'library/chailove.md'
      - 'CHIP-8 Emulation':
        - 'XO-CHIP/CHIP-8 (JAXE)': 'library/jaxe.md'
        - 'CHIP-8 (Emux)': 'library/emux_chip8.md'
      - 'Dinothawr': 'library/dinothawr.md'
      - 'Doom (PrBoom)': 'library/prboom.md'
      - 'Doom 3 (Boom3)': 'library/boom3.md'
      - 'Dungeon Crawl Stone Soup': 'library/stone_soup.md'
      - 'Flashback (REminiscence)': 'library/reminiscence.md'
      - 'Handheld Electronic (GW)': 'library/gw.md'
      - 'Jump n Bump': 'library/jumpnbump.md'
      - 'LowRes NX': 'library/lowres_nx.md'
      - 'Lua Engine (Lutro)': 'library/lutro.md'
      - 'MicroW8': 'library/microw8.md'
      - 'Minecraft (Craft)': 'library/craft.md'
      - 'Mr.Boom (Bomberman)': 'library/mr_boom.md'
      - 'Quake 1 (TyrQuake)': 'library/tyrquake.md'
      - 'Rick Dangerous (XRick)': 'library/xrick.md'
      - 'RPG Maker Emulation':
        - 'RPG Maker 2000/2003 (EasyRPG)': 'library/easyrpg.md'
        - 'RPG Maker XP/VX/VX Ace (mkxp-z)': 'library/mkxp-z.md'
      - 'ScummVM': 'library/scummvm.md'
      - 'The Powder Toy': 'library/the_powder_toy.md'
      - 'TIC-80': 'library/tic80.md'
      - 'Tomb Raider (OpenLara)': 'library/openlara.md'
      - 'Uzebox (Uzem)': 'library/uzem.md'
      - 'VaporSpec': 'library/vaporspec.md'
      - 'Vircon32': 'library/vircon32.md'
      - 'WebAssembly (WASM-4)': 'library/wasm-4.md'
      - 'Wolfenstein 3D (ECWolf)': 'library/ecwolf.md'
    - 'Core Library: Media':
      - 'Imageviewer': 'library/imageviewer.md'
      - 'FFmpeg': 'library/ffmpeg.md'
      - 'Game Music Emu': 'library/game_music_emu.md'
      - 'PocketCDG': 'library/pocketcdg.md'
      - 'Video Processor': 'library/video_processor.md'
    - 'Core Library: Special-Purpose':
      - 'Dummy Core': 'library/dummy.md'
      - 'Remote RetroPad': 'library/remote_retropad.md'
    - 'Shader Library':
      - 'Introduction': 'shader/introduction.md'
      - '3dfx': 'shader/3dfx.md'
      - 'antialiasing': 'shader/antialiasing.md'
      - 'autobox': 'shader/auto-box.md'
      - 'border': 'shader/border.md'
      - 'blurs': 'shader/blurs.md'
      - 'cel': 'shader/cel.md'
      - 'cgp': 'shader/cgp.md'
      - 'crt': 'shader/crt.md'
      - 'crt-royale': 'shader/crt_royale.md'
      - 'cubic': 'shader/cubic.md'
      - 'ddt': 'shader/ddt.md'
      - 'dithering': 'shader/dithering.md'
      - 'eagle': 'shader/eagle.md'
      - 'handheld': 'shader/handheld.md'
      - 'handheld-border': 'shader/handheld-border.md'
      - 'hqx': 'shader/hqx.md'
      - 'linear': 'shader/linear.md'
      - 'motionblur': 'shader/motionblur.md'
      - 'mudlord': 'shader/mudlord.md'
      - 'nedi': 'shader/nedi.md'
      - 'nnedi3': 'shader/nnedi3.md'
      - 'ntsc': 'shader/ntsc.md'
      - 'presets': 'shader/presets.md'
      - 'retro': 'shader/retro.md'
      - 'sabr': 'shader/sabr.md'
      - 'scalefx-OLD-shaders': 'shader/scalefx-old-shaders.md'
      - 'scalefx': 'shader/scalefx.md'
      - 'scalehq': 'shader/scalehq.md'
      - 'scalenx': 'shader/scalenx.md'
      - 'sharpen': 'shader/sharpen.md'
      - 'windowed': 'shader/windowed.md'
      - 'xbr': 'shader/xbr.md'
      - 'xbrz': 'shader/xbrz.md'
      - 'xsal': 'shader/xsal.md'
      - 'xsoft': 'shader/xsoft.md'
  - 'For Developers':
    - 'Libretro API and Ecosystem':
      - 'Libretro Overview': 'development/libretro-overview.md'
      - 'Open Source Bounties': 'development/bounties.md'
      - 'Input API': 'development/input-api.md'
      - 'Coding Standards': 'development/coding-standards.md'
      - 'Licenses': 'development/licenses.md'
      - 'Frontends': 'development/frontends.md'
    - 'RetroArch Development':
      - 'Glossary': 'development/retroarch/glossary.md'
      - 'Debugging': 'development/retroarch/debugging.md'
      - 'Adding Menu Entries': 'development/retroarch/new-menu-options.md'
      - 'Input':
        - 'Input Driver Specification': 'development/retroarch/input/input-drivers.md'
        - 'Input Overlays': 'development/retroarch/input/overlay.md'
        - 'Parallel Port Controllers': 'development/retroarch/input/parallel-port-controllers.md'
      - 'Adding New Languages to RetroArch': 'development/retroarch/new-translations.md'
      - 'Helping With RetroArch Translations': 'development/retroarch/new-translations-crowdin.md'
      - 'Network Protocols':
        - 'Netplay': 'development/retroarch/netplay.md'
        - 'Network Control Interface': 'development/retroarch/network-control-interface.md'
      - 'RetroArch Compilation Guides':
        - 'Apple':
          - 'macOS': 'development/retroarch/compilation/osx.md'
          - 'iOS/tvOS': 'development/retroarch/compilation/ios.md'
        - 'Android': 'development/retroarch/compilation/android.md'
        - 'Linux and BSD':
          - 'Overview for Linux/BSD': 'development/retroarch/compilation/linux-and-bsd.md'
          - 'Ubuntu': 'development/retroarch/compilation/ubuntu.md'
        - 'Haiku': 'development/retroarch/compilation/haiku.md'
        - 'Microsoft':
          - 'Windows 7 and later (MSYS2)': 'development/retroarch/compilation/windows.md'
          - 'MSVC Compatibility Guide': 'development/retroarch/compilation/msvc-runtime-versions.md'
          - 'Windows XP and later (MSVC2010)':
            - 'MSVC Commandline': 'development/retroarch/compilation/windowsXP-msvc-cmdline.md'
            - 'MSVC IDE': 'development/retroarch/compilation/windowsXP.md'
          - 'Windows 2000 and later (MSVC2008)':
            - 'MSVC Commandline': 'development/retroarch/compilation/windows2000-msvc-cmdline.md'
            - 'MSVC IDE': 'development/retroarch/compilation/windows2000.md'
          - 'Windows 98SE/ME/2000 (MSVC2005)':
            - 'MSVC Commandline': 'development/retroarch/compilation/windows98-msvc-cmdline.md'
            - 'MSVC IDE': 'development/retroarch/compilation/windows98.md'
          - 'Windows 95/98/NT4 (MSVC2003)':
            - 'MSVC Commandline': 'development/retroarch/compilation/windows95-msvc-cmdline.md'
          - 'Windows NT3.51 (MSVC6)':
            - 'MSVC Commandline': 'development/retroarch/compilation/windowsNT351-msvc-cmdline.md'
          - 'DOS': 'development/retroarch/compilation/dos.md'
        - 'Nintendo':
          - 'Nintendo 3DS': 'development/retroarch/compilation/3ds.md'
          - 'Nintendo GameCube': 'development/retroarch/compilation/gamecube.md'
          - 'Nintendo Wii': 'development/retroarch/compilation/wii.md'
          - 'Nintendo Wii U': 'development/retroarch/compilation/wiiu.md'
          - 'Nintendo Switch (libnx)': 'development/retroarch/compilation/switch-libnx.md'
        - 'Sony':
          - 'PlayStation2': 'development/retroarch/compilation/ps2.md'
          - 'PlayStation Portable': 'development/retroarch/compilation/psp.md'
          - 'PlayStation Vita/TV': 'development/retroarch/compilation/psvita.md'
    - 'Core Development':
      - 'Core Development Overview': 'development/cores/developing-cores.md'
      - 'Dynamic Rate Control for Emulators': 'development/cores/dynamic-rate-control.md'
      - 'OpenGL Accelerated Cores': 'development/cores/opengl-cores.md'
      - 'Core Options Translation': 'development/cores/core-options-translation.md'
      - 'Core-Specific Docs':
        - 'Nintendo - GameCube/Wii (Dolphin)': 'development/cores/core-specific/dolphin.md'
        - 'Nintendo - GameCube/Wii (Ishiiruka)': 'development/cores/core-specific/ishiiruka.md'
        - 'Sega - Dreamcast/NAOMI (Flycast)': 'development/cores/core-specific/flycast.md'
        - 'Sony - PlayStation (SwanStation)': 'development/cores/core-specific/swanstation.md'
        - 'Sony - PlayStation2 (PCSX2)': 'development/cores/core-specific/pcsx2.md'
        - 'MAME (0.181-current)': 'development/cores/core-specific/mame.md'
        - 'MAME 2016': 'development/cores/core-specific/mame-2016.md'
        - 'MAME 2003-Plus': 'development/cores/core-specific/mame-2003-plus.md'
    - 'Shader Development':
      - 'Shader Development Overview': 'development/shader/shader-overview.md'
      - 'Slang Shader Development': 'development/shader/slang-shaders.md'
      - 'GLSL Shader Development': 'development/shader/glsl-shaders.md'
      - 'Cg Shader Development (deprecated)': 'development/shader/cg-shaders.md'
      - 'XML Shader Development (discontinued)': 'development/shader/xml-shaders.md'
      - 'Content-Aware Shaders': 'development/shader/content-aware-shaders.md'
      - 'Shader Lookup Textures': 'development/shader/shader-lookup-textures.md'
  - 'Contribute to the Docs':
    - 'Adding or Editing Documentation': 'meta/how-to-contribute.md'
    - 'Core Template': 'meta/core-template.md'
    - 'Shader Preview Template': 'meta/shader-preview-template.md'
    - 'See Also': 'meta/see-also.md'
  - 'Support':
    - 'Privacy Policy': 'support/privacy-policy.md'
    - 'Quick information': 'support/quick-informations.md'
    - 'Developing Cores': 'tech/developing-cores.md'

extra:
  adsense: "ca-pub-9447404270680650"
  analytics:
    provider: google
    property: G-MT11L3F6EZ
  consent:
    description: >-2
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
    title: Cookie consent
  font:
    text: 'Noto Sans'
    code: 'Noto Sans Mono'
  i18n:
    prev: 'Previous'
    next: 'Next'
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/libretro
      name: Libretro on GitHub
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/libretro
      name: Libretro on X
    - icon: fontawesome/brands/discord
      link: https://discord.gg/C4amCeV
      name: RetroArch Discord server
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@Libretro
      name: Libretro YouTube channel
    - icon: fontawesome/brands/facebook
      link: https://facebook.com/libretro
      name: Libretro on Facebook
    - icon: fontawesome/brands/instagram
      link: https://www.instagram.com/libretro
      name: Libretro/RetroArch on Instagram
  status:
    fixed: The information on this page never changes
    stable: The information on this page changes infrequently, or not at all
  unit:
    stable: 1.22.2
  version: '0.2.0'

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - meta
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret:
      insert: true
      smart_insert: true
      superscript: true
  - pymdownx.critic:
      mode: accept
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      auto_title: false
      guess_lang: block
      line_spans: __span
      linenums: false
      linenums_style: pymdownx-inline
      pygments_lang_class: true
      stripnl: false
      use_pygments: true
  - pymdownx.inlinehilite:
      style_plain_text: true
  - pymdownx.keys:
      camel_case: true
      strict: true
  - pymdownx.magiclink:
      repo: docs
      repo_url_shorthand: true
      user: libretro
  - pymdownx.mark:
      smart_mark: true
  - pymdownx.smartsymbols:
      arrows: false
  - pymdownx.snippets:
      check_paths: true
      dedent_subsections: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
  - pymdownx.tasklist:
      clickable_checkbox: false
      custom_checkbox: true
  - pymdownx.tilde:
      delete: true
      smart_delete: true
      subscript: true
  - toc:
      permalink: true
      permalink_title: Reference link to this section
      toc_depth: 6

plugins:
  - git-revision-date-localized
  - macros
  - search

theme:
  custom_dir: docs/overrides/
  favicon: 'image/branding/invader.png'
  features:
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.indexes
    - navigation.prune
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  font:
    text: 'Noto Sans'
    code: 'Noto Sans Mono'
  # Don't include MkDocs' JavaScript
  include_search_page: false
  language: en
  logo: 'image/branding/invader.png'
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: retroarch
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      accent: deep purple
      primary: black
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  search_index_only: true
  static_templates:
    - 404.html
...