From 080953fa2c678ffdf12fdd08d02fd3e9185d6044 Mon Sep 17 00:00:00 2001 From: WizzardSK <42868978+WizzardSK@users.noreply.github.com> Date: Fri, 25 Sep 2026 21:46:39 +0200 Subject: [PATCH 1/3] Add pages for 54 cores the buildbot builds that had none Amiberry, AppleWin, Arduous, ARMSX2, BBKEmu, Beetle PCE, Beetle Supafaust, bsnes-hd beta, CDi 2015, Citra 2018, DirkSimple, Emir, FB Alpha 2012 (and its CPS-1, CPS-2, CPS-3 and Neo Geo cores), fixGB, fixNES, FreeChaF, Frodo, FS-UAE, Galaksija, Gong, HBMAME, IroGB, MAME 2000, MAME 2015, McSoftServe, MesenCE, MojoZork, Neko Project II, NeoCD, NooDS, Nuance, Oberon, Omicron, Panda3DS, ParaLLEl N64, PCem, pokketstation, Potator, QEMU, Radio, RemoteJoy, Retro8, ROM Cleaner, SkyEmu, SquirrelJME, Super Bros War, TamaLIBretro, vitaQuake 2, vitaQuake 3 and X Millennium. Each page takes its background, authors, license, extensions, databases, firmware and feature support from the core's info file, and its core options and controller types from the core itself - the current nightly build, or its source where the build sets its options only once content is loaded or is not built for aarch64. Where options differ between platforms or are added per game, the page says so. The pages are added to the nav, and the core list links them, adding the 22 cores it did not list. --- _typos.toml | 3 + docs/guides/core-list.md | 86 +++-- docs/library/amiberry.md | 216 ++++++++++++ docs/library/applewin.md | 153 +++++++++ docs/library/arduous.md | 51 +++ docs/library/armsx2.md | 171 ++++++++++ docs/library/bbkemu.md | 59 ++++ docs/library/bsnes_hd_beta.md | 142 ++++++++ docs/library/cdi2015.md | 72 ++++ docs/library/citra2018.md | 100 ++++++ docs/library/dirksimple.md | 52 +++ docs/library/fbalpha2012.md | 56 +++ docs/library/fbalpha2012_cps1.md | 81 +++++ docs/library/fbalpha2012_cps2.md | 81 +++++ docs/library/fbalpha2012_cps3.md | 64 ++++ docs/library/fbalpha2012_neogeo.md | 78 +++++ docs/library/fixgb.md | 42 +++ docs/library/fixnes.md | 43 +++ docs/library/freechaf.md | 51 +++ docs/library/frodo.md | 55 +++ docs/library/fsuae.md | 54 +++ docs/library/galaksija.md | 58 ++++ docs/library/gong.md | 63 ++++ docs/library/hbmame.md | 136 ++++++++ docs/library/irogb.md | 63 ++++ docs/library/mame2000.md | 91 +++++ docs/library/mame2015.md | 79 +++++ docs/library/mcsoftserve.md | 43 +++ docs/library/mednafen_pce.md | 233 +++++++++++++ docs/library/mednafen_supafaust.md | 97 ++++++ docs/library/mesen2.md | 462 +++++++++++++++++++++++++ docs/library/mojozork.md | 60 ++++ docs/library/nekop2.md | 105 ++++++ docs/library/neocd.md | 68 ++++ docs/library/noods.md | 92 +++++ docs/library/nuance.md | 63 ++++ docs/library/oberon.md | 42 +++ docs/library/omicron.md | 51 +++ docs/library/panda3ds.md | 95 ++++++ docs/library/parallel_n64.md | 524 +++++++++++++++++++++++++++++ docs/library/pcem.md | 69 ++++ docs/library/pokketstation.md | 55 +++ docs/library/potator.md | 68 ++++ docs/library/qemu.md | 52 +++ docs/library/radio.md | 69 ++++ docs/library/remotejoy.md | 37 ++ docs/library/retro8.md | 49 +++ docs/library/romcleaner.md | 84 +++++ docs/library/skyemu.md | 77 +++++ docs/library/squirreljme.md | 55 +++ docs/library/superbroswar.md | 51 +++ docs/library/tamalibretro.md | 59 ++++ docs/library/vitaquake2.md | 216 ++++++++++++ docs/library/vitaquake3.md | 100 ++++++ docs/library/x1.md | 89 +++++ docs/library/ymir.md | 133 ++++++++ mkdocs.yml | 59 ++++ 57 files changed, 5425 insertions(+), 32 deletions(-) create mode 100644 docs/library/amiberry.md create mode 100644 docs/library/applewin.md create mode 100644 docs/library/arduous.md create mode 100644 docs/library/armsx2.md create mode 100644 docs/library/bbkemu.md create mode 100644 docs/library/bsnes_hd_beta.md create mode 100644 docs/library/cdi2015.md create mode 100644 docs/library/citra2018.md create mode 100644 docs/library/dirksimple.md create mode 100644 docs/library/fbalpha2012.md create mode 100644 docs/library/fbalpha2012_cps1.md create mode 100644 docs/library/fbalpha2012_cps2.md create mode 100644 docs/library/fbalpha2012_cps3.md create mode 100644 docs/library/fbalpha2012_neogeo.md create mode 100644 docs/library/fixgb.md create mode 100644 docs/library/fixnes.md create mode 100644 docs/library/freechaf.md create mode 100644 docs/library/frodo.md create mode 100644 docs/library/fsuae.md create mode 100644 docs/library/galaksija.md create mode 100644 docs/library/gong.md create mode 100644 docs/library/hbmame.md create mode 100644 docs/library/irogb.md create mode 100644 docs/library/mame2000.md create mode 100644 docs/library/mame2015.md create mode 100644 docs/library/mcsoftserve.md create mode 100644 docs/library/mednafen_pce.md create mode 100644 docs/library/mednafen_supafaust.md create mode 100644 docs/library/mesen2.md create mode 100644 docs/library/mojozork.md create mode 100644 docs/library/nekop2.md create mode 100644 docs/library/neocd.md create mode 100644 docs/library/noods.md create mode 100644 docs/library/nuance.md create mode 100644 docs/library/oberon.md create mode 100644 docs/library/omicron.md create mode 100644 docs/library/panda3ds.md create mode 100644 docs/library/parallel_n64.md create mode 100644 docs/library/pcem.md create mode 100644 docs/library/pokketstation.md create mode 100644 docs/library/potator.md create mode 100644 docs/library/qemu.md create mode 100644 docs/library/radio.md create mode 100644 docs/library/remotejoy.md create mode 100644 docs/library/retro8.md create mode 100644 docs/library/romcleaner.md create mode 100644 docs/library/skyemu.md create mode 100644 docs/library/squirreljme.md create mode 100644 docs/library/superbroswar.md create mode 100644 docs/library/tamalibretro.md create mode 100644 docs/library/vitaquake2.md create mode 100644 docs/library/vitaquake3.md create mode 100644 docs/library/x1.md create mode 100644 docs/library/ymir.md diff --git a/_typos.toml b/_typos.toml index 84f35f3d10..9200d29f3d 100644 --- a/_typos.toml +++ b/_typos.toml @@ -10,6 +10,9 @@ ue = "ue" # Nestopia UE sav = "sav" # .sav file extension kernal = "kernal" # Commodore's low-level Operating System gam = "gam" # GAM4980 core name / .gam file extension +noo = "noo" # NooDS core name (library/noods.md) +wirth = "wirth" # Niklaus Wirth, designer of Oberon (library/oberon.md) +wizzard = "wizzard" # WizzardSK, a core author (library/armsx2.md, library/nuance.md) bload = "bload" # MSX-BASIC BLOAD command (library/bluemsx.md) consol = "consol" # Atari 8-bit CONSOL_SELECT/CONSOL_START hardware register (library/atari800.md) pn = "pn" # UPnP substring (ppsspp.md, netplay-faq.md, netplay-getting-started.md) diff --git a/docs/guides/core-list.md b/docs/guides/core-list.md index c5cbcc48df..85c8d0a51f 100644 --- a/docs/guides/core-list.md +++ b/docs/guides/core-list.md @@ -4,24 +4,28 @@ | 3D Engine | - | This is a test core; it demonstrates how to create a hardware-rendered core in a libretro context | | [4DO](https://docs.libretro.com/library/opera/) | 3DO | | | a5200 | Atari 5200 | | +| [Amiberry](../library/amiberry.md) | Commodore Amiga | Amiberry is a lightweight, optimized Amiga emulator based on UAE | | Anarch | Game | A port of Anarch, 90s-style Doom clone shooter game | +| [AppleWin](../library/applewin.md) | Apple II | Apple II - AppleWin emulator | | [Ardens](../library/ardens.md) | Arduboy | A simulator for the Arduboy FX | -| Arduous | Arduboy | A emulator for Arduboy, a handheld game console with open source software, based on the Arduino hardware platform | +| [Arduous](../library/arduous.md) | Arduboy | A emulator for Arduboy, a handheld game console with open source software, based on the Arduino hardware platform | +| [ARMSX2](../library/armsx2.md) | Sony PlayStation 2 | A libretro port of ARMSX2, a PlayStation 2 emulator forked from PCSX2 and aimed at ARM64 platforms | | [Atari800](https://docs.libretro.com/library/atari800/) | Atari 5200 | | | [b2](../library/b2.md) | Acorn BBC Micro | | +| [BBKEmu](../library/bbkemu.md) | BBK electronic dictionaries | BBKEmu is an emulator for BBK electronic dictionary game platform | | [Beetle bsnes](../library/beetle_bsnes.md) | Nintendo SNES/SFC | | | [Beetle Cygne](https://docs.libretro.com/library/beetle_cygne/) | Bandai WonderSwan/Color | | | [Beetle GBA](../library/beetle_gba.md) | Game Boy Advance | | | [Beetle Lynx](../library/beetle_lynx.md) | Atari Lynx | | | Beetle NeoPop | Neo Geo Pocket/Color | | | Beetle PC-FX | NEC PC-FX | | -| Beetle PCE | NEC PC Engine/SuperGrafx/CD | | +| [Beetle PCE](../library/mednafen_pce.md) | NEC PC Engine/SuperGrafx/CD | | | Beetle PCE FAST | NEC PC Engine/CD | | | Beetle PSX | Sony PlayStation | | | Beetle PSX HW | Sony PlayStation | A fork of Mednafen's PSX providing GPU-accelerated renderers for OpenGL and Vulkan | | Beetle Saturn | Sega Saturn | | | Beetle SuperGrafx | NEC PC Engine/SuperGrafx | | -| Beetle Supafaust | Nintendo SNES/SFC | | +| [Beetle Supafaust](../library/mednafen_supafaust.md) | Nintendo SNES/SFC | | | [Beetle VB](../library/beetle_vb.md) | Nintendo Virtual Boy | | | [BK](../library/bk.md) | Elektronika BK-0010/BK-0011(M)/Terak 8510-a | A port of the PDP11 emulator to libretro. This core emulates the PDP-11/03 platform. | | BlastEm | Sega Genesis (Mega Drive) | | @@ -34,17 +38,17 @@ | [bsnes 2014 Balanced](../library/bsnes_balanced.md) | Nintendo SNES/SFC | | | [bsnes 2014 Performance](../library/bsnes_performance.md) | Nintendo SNES/SFC | | | [bsnes C++98 (v085)](../library/bsnes_cplusplus98.md) | Nintendo SNES/SFC | | -| bsnes-hd beta | Nintendo SNES/SFC | | +| [bsnes-hd beta](../library/bsnes_hd_beta.md) | Nintendo SNES/SFC | | | [bsnes-jg](../library/bsnes-jg.md) | Nintendo SNES/SFC | | | [bsnes-mercury Accuracy](../library/bsnes_mercury_accuracy.md) | Nintendo SNES/SFC | | | [bsnes-mercury Balanced](../library/bsnes_mercury_balanced.md) | Nintendo SNES/SFC | | | [bsnes-mercury Performance](../library/bsnes_mercury_performance.md) | Nintendo SNES/SFC | | | Cannonball | Game engine | A port of the Cannonball, enhanced OutRun engine to libretro | | [Caprice32](../library/caprice32.md) | Amstrad CPC | | -| CDi 2015 | Philips CDi | | +| [CDi 2015](../library/cdi2015.md) | Philips CDi | | | ChaiLove | Game engine | A free, open-source framework used to make 2D games in ChaiScript | | [Citra](../library/citra.md) | Nintendo 3DS | | -| Citra 2018 | Nintendo 3DS | | +| [Citra 2018](../library/citra2018.md) | Nintendo 3DS | | | [Citra Canary](../library/citra_canary.md) | Nintendo 3DS | Based on Citra development branch | | [ClownMDEmu](../library/clownmdemu.md) | Sega MD/CD | | | Craft | Game | A basic clone of the Minecraft sandbox game | @@ -57,6 +61,7 @@ | [DICE](../library/dice.md) | Arcade | Pre-CPU games like Pong | | Dinothawr | Game engine | A push-the-block-in-a-straight-line puzzle game in the spirit of Kickle Cubicle | | DirectXbox | Xbox | | +| [DirkSimple](../library/dirksimple.md) | Laserdisc arcade games | A player of laserdisc arcade games | | [Dolphin](../library/dolphin.md) | Nintendo GameCube/Wii | | | [DOSBox](../library/dosbox.md) | DOS | | | DOSBox-core | DOS | Provides some improvements over the DOSBox-SVN trunk, including native MIDI support, cycle-accurate OPL3 (YMF262) emulation, MT-32 emulation and experimental 3dfx Voodoo support | @@ -67,6 +72,7 @@ | EasyRPG | RPG Maker 2000/2003 | | | ECWolf | Game engine | A port of the Wolfenstein 3D engine to libretro | | EighyOne | Sinclair ZX 81 | | +| [Emir](../library/ymir.md) | Sega Saturn | A port of the Ymir Sega Saturn emulator to libretro | | Emux CHIP-8 | CHIP-8 | | | [Emux GB](../library/emux_gb.md) | Game Boy/Color | | | [Emux NES](../library/emux_nes.md) | Nintendo NES/Famicom | | @@ -75,25 +81,26 @@ | [Ep128emu](../library/ep128emu.md) | Enterprise 64/128 | | | FAKE-08 | Pico-8 | A port of the FAKE-08 open-source reimplementation of the PICO-8 fantasy console to libretro | | FB Alpha | Arcade/Console/various | (See FB Neo note) | -| FB Alpha 2012 | Arcade/Console/various | (See FB Neo note) | -| FB Alpha 2012 CPS-1 | CPS-1 | | -| FB Alpha 2012 CPS-2 | CPS-2 | | -| FB Alpha 2012 CPS-3 | CPS-3 | | -| FB Alpha 2012 Neo Geo | Neo Geo | | +| [FB Alpha 2012](../library/fbalpha2012.md) | Arcade/Console/various | (See FB Neo note) | +| [FB Alpha 2012 CPS-1](../library/fbalpha2012_cps1.md) | CPS-1 | | +| [FB Alpha 2012 CPS-2](../library/fbalpha2012_cps2.md) | CPS-2 | | +| [FB Alpha 2012 CPS-3](../library/fbalpha2012_cps3.md) | CPS-3 | | +| [FB Alpha 2012 Neo Geo](../library/fbalpha2012_neogeo.md) | Neo Geo | | | [FB Neo](../library/fbneo.md) | Arcade/Console/various | Full list of supported systems: https://github.com/finalburnneo/FBNeo/wiki | | [FCEUmm](../library/fceumm.md) | Nintendo NES/Famicom | | | [FFmpeg](../library/ffmpeg.md) | Media player | Plays common video and audio formats through the FFmpeg libretro core | -| fixGB | Game Boy/Color | | -| fixNES | Nintendo NES/Famicom | | +| [fixGB](../library/fixgb.md) | Game Boy/Color | | +| [fixNES](../library/fixnes.md) | Nintendo NES/Famicom | | | Flycast | Sega Dreamcast/NAOMI | | | Flycast GLES2 | Sega Dreamcast/NAOMI | | | fMSX | MSX/MSX2/MSX2+ | | -| FreeChaF | Fairchild ChannelF | | +| [FreeChaF](../library/freechaf.md) | Fairchild ChannelF | | | [FreeIntv](../library/freeintv.md) | Mattel Intellivision | | | FreeJ2ME | J2ME | a port of Java 2 Micro Edition emulator | -| Frodo | Commodore C64 | | -| FS-UAE | Commodore Amiga | | +| [Frodo](../library/frodo.md) | Commodore C64 | | +| [FS-UAE](../library/fsuae.md) | Commodore Amiga | | | Fuse | Sinclair ZX Spectrum | | +| [Galaksija](../library/galaksija.md) | Galaksija | Galaksija (Galaxy) was a low-cost home computer released in 1983 in the former Yugoslav countries as a build-it-yourself kit | | [GAM4980](../library/gam4980.md) | BBK 4980/4988/5980 electronic dictionary | | [Gambatte](../library/gambatte.md) | Game Boy/Color | | | Game Music Emu | Music player | A port of Game Music Emu which allows playback of a wide variety of video game music formats | @@ -105,15 +112,16 @@ | [Genesis Plus GX](../library/genesis_plus_gx.md) | Sega MS/GG/MD/CD | | | [Geolith](../library/geolith.md) | SNK Neo Geo AES/MVS | Highly accurate emulator for the Neo Geo AES and MVS Cartridge Systems | | [gpSP](../library/gpsp.md) | Game Boy Advance | | -| Gong | Game | A clone of Pong written for libretro | +| [Gong](../library/gong.md) | Game | A clone of Pong written for libretro | | GW | Handheld Electronic | A simulator of various Game and Watch-style handheld electronic games | | [Handy](../library/handy.md) | Atari Lynx | | | [Hatari](../library/hatari.md) | Atari ST/STE/TT/Falcon | | | [hatariB](../library/hatarib.md) | Atari ST/STE/TT/Falcon | | -| HBMAME | Arcade/Console/various | HBMAME (HomeBrew MAME) is a derivative of MAME, and contains various hacks and homebrews | +| [HBMAME](../library/hbmame.md) | Arcade/Console/various | HBMAME (HomeBrew MAME) is a derivative of MAME, and contains various hacks and homebrews | | [higan Accuracy](../library/higan_accuracy.md) | Nintendo SNES/SFC/Game Boy/Color | | | [Holani](../library/holani.md) | Atari Lynx | | | Imageviewer | Imageviewer | A basic core for viewing still images in a libretro frontend | +| [IroGB](../library/irogb.md) | Nintendo Game Boy | A libretro port of the IroGB Game Boy Color emulator | | Ishiiruka | Nintendo GameCube/Wii | | | JAXE | CHIP-8/S-CHIP/XO-CHIP | | | [JollyCV](../library/jollycv.md) | ColecoVision/CreatiVision/My Vision | | @@ -124,24 +132,27 @@ | Lutro | Game engine | An experimental Lua game framework for libretro, based on a subset of the LOVE API | | M2000 | Philips P2000T | A port of M2000, the portable Philips P2000 emulator to libretro | | MAME (Current) | Arcade/Console/various | Based on MAME development branch. Full list of supported systems: http://adb.arcadeitalia.net/mame.php | -| MAME 2000 | Arcade/Console/various | (See MAME note) | +| [MAME 2000](../library/mame2000.md) | Arcade/Console/various | (See MAME note) | | [MAME 2003](../library/mame_2003.md) | Arcade/Console/various | (See MAME note) | | MAME 2003 Midway | Arcade/Console/various | (See MAME note) | | [MAME 2003-Plus](../library/mame2003_plus.md) | Arcade/Console/various | (See MAME note) | | MAME 2009 | Arcade/Console/various | (See MAME note) | | [MAME 2010](../library/mame_2010.md) | Arcade/Console/various | (See MAME note) | -| MAME 2015 | Arcade/Console/various | (See MAME note) | +| [MAME 2015](../library/mame2015.md) | Arcade/Console/various | (See MAME note) | | MAME 2016 | Arcade/Console/various | (See MAME note) | +| [McSoftServe](../library/mcsoftserve.md) | Game | An experimental libretro core for the Taylor C713 soft-serve ice cream machine, popularized by a well-known American fast food chain | | [melonDS 2021](../library/melonds.md) | Nintendo DS | | | [melonDS DS](../library/melonds_ds.md) | Nintendo DS/DSi | Enhanced remake of the melonDS core based on a newer version of the emulator. | | [Mesen](../library/mesen.md) | Nintendo NES/Famicom | | | [Mesen-S](../library/mesen-s.md) | Nintendo SNES/SFC/Game Boy/Color | | +| [MesenCE](../library/mesen2.md) | Multi-system | A port of MesenCE to the libretro API | | MESS 2015 | Multi (various) | (See MAME note) | | [Meteor](../library/meteor.md) | Game Boy Advance | | | [mGBA](../library/mgba.md) | Game Boy Advance | | | Microw8 | Game engine | A port of a WebAssembly based fantasy console to libretro | | [Minivmac](../library/minivmac.md) | Mac II | MacII variant of minivmac emulator | | [mkxp-z](../library/mkxp-z.md) | RPG Maker XP/VX/VX Ace | | +| [MojoZork](../library/mojozork.md) | Infocom Z-Machine | A Z-Machine emulator for playing text-based interactive fiction | | mpv | Media player | An port of MPV media player to libretro | | Mr.Boom | Game | A clone of the classic Bomberman series | | Mu | Palm OS | An emulator for the Palm m515 OS ported to libretro | @@ -150,21 +161,25 @@ | [Mupen64Plus-Next GLES3](https://docs.libretro.com/library/mupen64plus/) | Nintendo 64 | | | [Native32Emu](../library/native32emu.md) | Sunplus Native32 | An emulator for the Sunplus Native32 game format used by DVD player and TV chipsets | | [NicaiEmu](../library/nicaiemu.md) | MStar Nicai | An emulator for the MStar Nicai game format used by MStar feature phones | -| Neko Project II | NEC PC-98 | | +| [Neko Project II](../library/nekop2.md) | NEC PC-98 | | | Neko Project II Kai | NEC PC-98 | | -| NeoCD | Neo Geo CD | | +| [NeoCD](../library/neocd.md) | Neo Geo CD | | | [Nestopia](../library/nestopia.md) | Nintendo NES/Famicom | | +| [NooDS](../library/noods.md) | Nintendo DS | Unofficial libretro port of NooDS, the speedy DS emulator | | [nSide Balanced](../library/nside_balanced.md) | Nintendo SNES/SFC/Game Boy/Color | | +| [Nuance](../library/nuance.md) | VM Labs NUON | Nuance is a NUON (VM Labs) emulator | | Numero | TI-83 | A TI-83 Emulator for Libretro | | NXEngine | Game engine | An open-source reimplementation of the Cave Story / Doukutsu engine | | O2EM | Magnavox Odyssey2/Philips Videopac+ | | -| Oberon | Oberon RISC machine | An emulator for the Oberon RISC machine, ported to libretro | +| [Oberon](../library/oberon.md) | Oberon RISC machine | An emulator for the Oberon RISC machine, ported to libretro | +| [Omicron](../library/omicron.md) | Game engine | Omicron is an open source game engine for Java built on libGDX and inspired by fantasy consoles: a small API for drawing, sound and input, with no resource... | | OpenLara | Game engine | A port of the OpenLara free/open re-implementation of the engine used by the original Tomb Raider series | | OpenTyrian | Game | A port of the OpenTyrian clone of the classic Tyrian shmup, ported to libretro | | [Opera](https://docs.libretro.com/library/opera/) | 3DO | | -| ParaLLEl N64 | Nintendo 64 | | +| [Panda3DS](../library/panda3ds.md) | Nintendo 3DS | Panda3DS is an HLE, red-panda-themed Nintendo 3DS emulator | +| [ParaLLEl N64](../library/parallel_n64.md) | Nintendo 64 | | | PascalPong | Game | A free and basic clone of the classic Pong game, written for libretro | -| PCem | IBM PC | | +| [PCem](../library/pcem.md) | IBM PC | | | [PCSX ReARMed](https://docs.libretro.com/library/pcsx_rearmed/) | Sony PlayStation | | | [PD777](../library/pd777.md) | Epoch Cassette Vision | | | PicoDrive | Sega MS/GG/MD/CD/32X | | @@ -172,7 +187,8 @@ | [PlaydiaEmu](../library/playdiaemu.md) | Bandai Playdia | An emulator for the Bandai Playdia interactive CD console | | Pocket CDG | Karaoke player | A karaoke music player, ported to libretro | | [PokeMini](../library/pokemini.md) | Nintendo Pokemon Mini | | -| Potator | Watara Supervision | | +| [pokketstation](../library/pokketstation.md) | Sony PocketStation | An open-source Sony PocketStation emulator core, written in portable C | +| [Potator](../library/potator.md) | Watara Supervision | | | PPSSPP | PlayStation Portable | | | PrBoom | Game engine | A port of the PrBoom source port of iD's classic Doom engine | | [ProSystem](../library/prosystem.md) | Atari 7800 | | @@ -180,12 +196,16 @@ | [PUAE 2021](../library/puae.md) | Commodore Amiga | | | PuzzleScript | Game engine | A port of PuzzleScript, open source HTML5 puzzle game engine | | PX68k | Sharp X68000 | | +| [QEMU](../library/qemu.md) | PC | A port of the QEMU emulator to libretro | | QUASI88 | NEC PC-8000/PC-8800 series | | | [QuickNES](../library/quicknes.md) | Nintendo NES/Famicom | | | RACE | Neo Geo Pocket/Color | | +| [Radio](../library/radio.md) | Internet radio | Streams internet radio stations over the network, and plays local MP3 and WAV files | | Redbook | Music player | A libretro core for playing back Redbook-formatted audio, such as commercial audio CDs | | REminiscence | Game engine | A port of the REminiscence engine, a reimplementation of the engine used by Delphine Software's Flashback | -| Retro8 | Game engine | A port of the Retro8 open-source reimplementation of the PICO-8 fantasy console to libretro | +| [RemoteJoy](../library/remotejoy.md) | PSP remote play | An old, experimental libretro core designed to stream inputs to/from a Playstation Portable console | +| [Retro8](../library/retro8.md) | Game engine | A port of the Retro8 open-source reimplementation of the PICO-8 fantasy console to libretro | +| [ROM Cleaner](../library/romcleaner.md) | - | A utility core for removing dust and dirt from your ROM collection | | Rustation | Sony PlayStation | | | RVVM | RISC-V Virtual Machine | | | [SameBoy](../library/sameboy.md) | Game Boy/Color | | @@ -193,6 +213,7 @@ | [SAME CDI](../library/same_cdi.md) | Philips CDi | SAME CDi is a S(ingle) A(rcade) M(achine) E(mulator) for libretro, forked from MAME, which only includes the Philips CD-i driver | | [ScummVM](https://docs.libretro.com/library/scummvm/) | Game engine | A fork of the ScummVM adventure game engine ported to libretro | | SimCoupe | SAM Coupe | | +| [SkyEmu](../library/skyemu.md) | Nintendo GB/GBC/GBA/DS | SkyEmu is a multi-system emulator, supporting Game Boy, Game Boy Color and Nintendo DS cores | | [SMS Plus GX](https://docs.libretro.com/library/smsplus/) | Sega MS/GG | | | [Snes9x](https://docs.libretro.com/library/snes9x/) | Nintendo SNES/SFC | | | [Snes9x 2002](https://docs.libretro.com/library/snes9x_2002/) | Nintendo SNES/SFC | | @@ -200,12 +221,13 @@ | [Snes9x 2005 Plus](https://docs.libretro.com/library/snes9x_2005_plus/) | Nintendo SNES/SFC | | | [Snes9x 2010](https://docs.libretro.com/library/snes9x_2010/) | Nintendo SNES/SFC | | | [SPMP8000Emu](../library/spmp8000emu.md) | Sunplus SPMP8000 | An emulator for the Sunplus SPMP8000 game platform used by portable game devices | -| SquirrelJME | Java ME | A port of the SquirrelJME Java ME 8 Virtual Machine emulator to libretro | +| [SquirrelJME](../library/squirreljme.md) | Java ME | A port of the SquirrelJME Java ME 8 Virtual Machine emulator to libretro | | [Stella](https://docs.libretro.com/library/stella/) | Atari 2600 | | | Stella 2014 | Atari 2600 | | -| Super Bros War | Game engine | A fork of Super Mario War, a fan-made multiplayer Super Mario Bros. style deathmatch game | +| [Super Bros War](../library/superbroswar.md) | Game engine | A fork of Super Mario War, a fan-made multiplayer Super Mario Bros. style deathmatch game | | [Supermodel](../library/supermodel.md) | Sega Model 3 | A port of the Supermodel emulator for the Sega Model 3 arcade system | | SwanStation | Sony PlayStation | SwanStation is a fork of the DuckStation emulator | +| [TamaLIBretro](../library/tamalibretro.md) | Bandai Tamagotchi P1 | A port of the TamaLIB emulator for first-generation Tamagotchi handhelds to libretro | | [TempGBA](https://docs.libretro.com/library/tempgba/) | Game Boy Advance | | | [TGB Dual](https://docs.libretro.com/library/tgb_dual/) | Game Boy/Color | | | [Theodore](https://docs.libretro.com/library/theodore/) | Thomson MO/TO | | @@ -233,15 +255,15 @@ | Vircon32 | Game engine | A port of Vircon32 game console to libretro | | [Virtual Jaguar](../library/virtual_jaguar.md) | Atari Jaguar | | | [VirtualXT](../library/virtualxt.md) | DOS | Runs PC/XT class software. Mainly intended for PC booters from the 80's. | -| vitaQuake 2 | Game engine | A port of the VitaQuake 2 source port of iD's Quake 2 engine to libretro. There is a separate core for each of the Quake 2 mission packs, 'Rogue', 'Zaero' and 'Xatrix'. | +| [vitaQuake 2](../library/vitaquake2.md) | Game engine | A port of the VitaQuake 2 source port of iD's Quake 2 engine to libretro. There is a separate core for each of the Quake 2 mission packs, 'Rogue', 'Zaero' and 'Xatrix'. | | vitaQuake 2 (Rogue) | Game engine | (See vitaQuake 2 note) | | vitaQuake 2 (Xatrix) | Game engine | (See vitaQuake 2 note) | | vitaQuake 2 (Zaero) | Game engine | (See vitaQuake 2 note) | -| vitaQuake 3 | Game engine | A port of the VitaQuake 3 source port of iD's ioquake3 engine to libretro | +| [vitaQuake 3](../library/vitaquake3.md) | Game engine | A port of the VitaQuake 3 source port of iD's ioquake3 engine to libretro | | vitaVoyager | Game engine | A port of the Lilium Voyager engine, which runs the Star Trek: Voyager - Elite Force game and is itself based on the ioquake3 | | [WQXEmu](../library/wqxemu.md) | Wenquxing Electronic Dictionary | Emulates NC1020, PC1000, CC800, NC2000, and NC3000 models via low-level firmware execution | | WASM-4 | Game engine | WASM-4 is a open source low-level fantasy game console for building small games with WebAssembly | -| X Millennium | Sharp X1 | | +| [X Millennium](../library/x1.md) | Sharp X1 | | | XRick | Game engine | A port of the XRick, an open-source clone of the Rick Dangerous engine | | YabaSanshiro | Sega Saturn | A port of the YabaSanshiro, which is itself a fork of Yabause emulator | | Yabause | Sega Saturn | | diff --git a/docs/library/amiberry.md b/docs/library/amiberry.md new file mode 100644 index 0000000000..d68364e77c --- /dev/null +++ b/docs/library/amiberry.md @@ -0,0 +1,216 @@ +# Commodore - Amiga (Amiberry) + +## Background + +Amiberry is a lightweight, optimized Amiga emulator based on UAE. Requires appropriate Kickstart ROMs. + +The Amiberry core has been authored by + +- BlitterStudio/amiberry + +The Amiberry core is licensed under + +- GPLv3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Amiberry core have the following file extensions: + +- .adf +- .adz +- .dms +- .fdi +- .raw +- .ipf +- .hdf +- .hdz +- .lha +- .lzh +- .zip +- .7z +- .uae +- .rp9 +- .m3u +- .m3u8 +- .iso +- .cue +- .ccd +- .nrg +- .mds +- .chd + +RetroArch database(s) that are associated with the Amiberry core: + +- [Commodore - Amiga](https://github.com/libretro/libretro-database/blob/master/rdb/Commodore%20-%20Amiga.rdb) +- [Commodore - CD32](https://github.com/libretro/libretro-database/blob/master/rdb/Commodore%20-%20CD32.rdb) +- [Commodore - CDTV](https://github.com/libretro/libretro-database/blob/master/rdb/Commodore%20-%20CDTV.rdb) + +## BIOS + +Required or optional firmware files go in the frontend's system directory. + +| Filename | Description | md5sum | +|:---:|:---:|:---:| +| kick34005.A500 | A500 Kickstart v1.3 r34.5 - Required | | +| kick37350.A600 | A600 Kickstart v2.05 r37.350 - Required | | +| kick40068.A1200 | A1200 Kickstart v3.1 r40.68 - Required | | +| kick33180.A500 | A500 Kickstart v1.2 r33.180 - Optional | | +| kick40068.A4000 | A4000 Kickstart v3.1 r40.68 - Optional | | +| kick40060.CD32 | CD32 Kickstart v3.1 r40.60 - Optional | | +| ext40060.CD32 | CD32 Extended-ROM r40.60 - Optional | | + +## Features + +Frontend-level settings or features that the Amiberry core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✔ | +| Rewind | ✔ | +| Core Options | ✔ | + +### Directories + +The Amiberry core's library name is 'Amiberry' + +## Core options + +The Amiberry core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +#### System + +System and ROM settings. + +- **Model** [amiberry_model] (**A500 (512K Chip + 512K Slow, OCS, KS 1.3)**|A500 Original (512K Chip, OCS, KS 1.2)|A500+ (1MB Chip, ECS)|A600 (2MB Chip + 8MB Fast, ECS)|A1200 Original (2MB Chip, AGA)|A1200 (2MB Chip + 8MB Fast, AGA)|A4000/030 (2MB Chip + 8MB, AGA)|A4000/040 (2MB Chip + 8MB, AGA)|CD32 (2MB Chip, AGA)|CD32 (2MB Chip + 8MB Fast, AGA)|CDTV (1MB Chip, ECS)) + + Select the Amiga model and configuration preset. Models with expanded RAM allow more demanding software to run. Core restart required. + +- **Kickstart ROM** [amiberry_kickstart] (**Automatic**|kick.rom|kick13.rom|kick20.rom|kick31.rom|kick205.rom|kick40068.A1200|kick40068.A4000|cd32.rom|cdtv.rom) + + Override the Kickstart ROM file. Uses system directory unless an absolute path is provided. Core restart required. + +- **CPU Model** [amiberry_cpu_model] (**Auto**|68000|68010|68020|68030) + + Override the CPU model. Uses model defaults when set to Auto. Core restart required. + +- **Chipset** [amiberry_chipset] (**Auto**|OCS|ECS) + + Override the chipset. Uses model defaults when set to Auto. Core restart required. + +- **Chipset (AGA)** [amiberry_chipset_aga] (**Auto**|OCS|ECS|AGA) + + Override the chipset on AGA-capable models. Uses model defaults when set to Auto. Core restart required. + +- **Floppy Speed** [amiberry_floppy_speed] (Turbo|**1x (Normal)**|2x|4x|8x) + + Set floppy drive speed multiplier. 0 enables turbo loading. + +#### Input + +Controller and mouse settings. + +- **Port 1 Device** [amiberry_port0_device] (**Mouse**|Joystick) + + Select the input device for Amiga port 1. + +- **Port 2 Device** [amiberry_port1_device] (**Joystick**|Mouse) + + Select the input device for Amiga port 2. + +- **Swap Ports** [amiberry_swap_ports] (**disabled**|enabled) + + Swap input devices between port 1 and port 2. + +- **Joyport Order** [amiberry_joyport_order] (**Automatic**|2-1|1-2) + + Order for mapping controller ports to Amiga ports. + +- **Deadzone** [amiberry_joy_deadzone] (**33%**|25%|20%|15%|10%|5%|0%|40%|50%) + + Analog deadzone percentage. + +- **Sensitivity** [amiberry_analog_sensitivity] (**18**|15|20|25|30|10) + + Adjust analog sensitivity. + +- **Analog Input** [amiberry_analog] (**enabled**|disabled) + + Enable analog input mapping. + +- **Joystick As Mouse** [amiberry_joy_as_mouse] (**disabled**|Port 1|Port 2|Both) + + Map joystick to mouse input. + +- **Input Log File** [amiberry_input_log] (**disabled**|enabled) + + Write input events to a log file in the save directory. + +#### Video + +Video and sync settings. + +- **Internal VSync** [amiberry_internal_vsync] (**disabled**|Standard|Standard (50Hz)) + + Select internal vsync mode. + +- **Video Standard** [amiberry_video_standard] (**Auto**|PAL (50Hz)|NTSC (60Hz)) + + Select PAL or NTSC timing mode. Auto uses the model default. Core restart required. + +- **Crop Overscan** [amiberry_crop_overscan] (**Disabled**|Automatic|Fixed 320x256|Fixed 320x240|Fixed 320x200|Fixed 320x180) + + Trim the Amiga overscan borders. Automatic uses content-aware detection of the drawn region; fixed presets use increasingly tighter centered crops for games with unstable display changes. No effect in RTG/Workbench (Picasso96) modes. + +- **Status Line** [amiberry_statusline] (**Disabled**|Enabled) + + Show an on-screen status line at the bottom with power/floppy/HD/CD activity LEDs and disk insert/eject messages, like the standalone Amiberry. + +- **Status Line Size** [amiberry_statusline_size] (**1x**|2x|3x|4x) + + Scale factor for the on-screen status line. Use a larger value for high-resolution output. + +- **On-Screen Keyboard** [amiberry_on_screen_keyboard] (**Disabled**|Enabled) + + Show an on-screen Amiga keyboard (bottom of the screen) for typing. Toggle it with a bound gamepad button; D-pad or stick moves the focus and another button presses the key. + +#### Audio + +Audio settings. + +- **Audio Rate** [amiberry_audio_rate] (**Auto**|44100|48000) + + Override audio sample rate. Uses defaults when set to Auto. Core restart required. + +- **Interpolation** [amiberry_audio_interpolation] (**Auto**|Off|Anti-alias|Sinc) + + Override audio interpolation. Uses defaults when set to Auto. Core restart required. + +- **Sound Filter** [amiberry_sound_filter] (**Off**|Emulated (A500)|Always On) + + Amiga audio low-pass filter. 'Emulated' mimics the original A500 hardware filter. + +- **Stereo Separation** [amiberry_stereo_separation] (0 (Mono)|1|2|3|4|5|6|**7 (Amiga Default)**|8|9|10 (Full Stereo)) + + Set stereo separation from mono to full stereo. 7 matches default Amiga hard-panned output. + +- **MIDI Output** [amiberry_midi_output] (**Disabled**|Frontend MIDI|Munt MT-32|Munt CM-32L) + + Select MIDI output device. 'Frontend MIDI' routes through RetroArch's MIDI driver (configure in Settings > Audio > MIDI). Munt options provide built-in MT-32/CM-32L synthesis (requires ROM files in system/mt32-roms/). + +## Controllers + +The Amiberry core supports 2 port(s). Each can be set to one of the following device types: + +- RetroPad +- CD32 Pad +- Joystick +- Mouse +- None + +## External Links + +- [Amiberry Repository](https://github.com/BlitterStudio/amiberry) +- [Report Amiberry Core Issues Here](https://github.com/BlitterStudio/amiberry/issues) + diff --git a/docs/library/applewin.md b/docs/library/applewin.md new file mode 100644 index 0000000000..1c4cec7e4f --- /dev/null +++ b/docs/library/applewin.md @@ -0,0 +1,153 @@ +# Apple II (AppleWin) + +## Background + +Apple II - AppleWin emulator. + +The AppleWin core has been authored by + +- AppleWin Team + +The AppleWin core is licensed under + +- GPLv2 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the AppleWin core have the following file extensions: + +- .bin +- .do +- .dsk +- .nib +- .po +- .gz +- .woz +- .zip +- .2mg +- .2img +- .iie +- .apl +- .hdv +- .yaml +- .m3u + +The AppleWin core can also be started without content. + +RetroArch database(s) that are associated with the AppleWin core: + +- [Apple - II](https://github.com/libretro/libretro-database/blob/master/rdb/Apple%20-%20II.rdb) + +## Features + +Frontend-level settings or features that the AppleWin core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✔ | +| States | ✔ | +| Rewind | ✔ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✔ | +| Subsystem | ✕ | +| Disk Control | ✔ | + +### Directories + +The AppleWin core's library name is 'AppleWin' + +## Core options + +The AppleWin core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +#### System + +Configure system options. + +- **Apple II Type** [applewin_machine] (Apple II (original)|Apple II Plus|Apple II J-Plus|Apple //e (original)|**Apple //e (enhanced)**|Pravets 82|Pravets 8M|Pravets 8A|Base64A|TK3000 //e) + +- **Card in Slot 3** [applewin_slot3] (**Empty**|Video HD) + +- **Card in Slot 4** [applewin_slot4] (Empty|**Mockingboard C**|Mouse Card|Phasor) + +- **Card in Slot 5** [applewin_slot5] (**Empty**|Z80 SoftCard|Mockingboard C|Phasor|SAM) + +- **Card in Slot 7** [applewin_slot7] (Empty|**Hard Disk Controller**) + +- **Video Mode** [applewin_video_mode] (**Color (RGB Card/Monitor)**|Color (Composite Idealized)|Color (Composite Monitor)|Color TV|B&W TV|Monochrome (Amber)|Monochrome (Green)|Monochrome (White)) + +- **Video Style** [applewin_video_style] (**Half Scanlines**|560 x 192|280 x 192) + +- **Video Refresh Rate** [applewin_video_refresh_rate] (**60Hz**|50Hz) + +#### Disk Control + +Configure disk control options. + +- **Disk Control Drive** [applewin_disk_control_drive] (**Drive 1**|Drive 2) + +- **Playlist Start Disk** [applewin_playlist_start] (**First**|Previous) + +- **Floppy MultiDrive** [applewin_floppy_multidrive] (**disabled**|enabled) + +#### Input + +Configure input options. + +- **Keyboard Type** [applewin_keyboard_type] (**ASCII**|Original) + +- **Mouse Speed** [applewin_mouse_speed] (0.25 to 5.00 in steps of 0.25, **1.00**) + +#### RetroPad Mapping + +Configure RetroPad mapping options. + +- **Joypad A [button 0]** [applewin_joypad_a] (****|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|Left|Right|Down|Up) + +- **Joypad B [button 1]** [applewin_joypad_b] (****|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|Left|Right|Down|Up) + +- **Joypad X** [applewin_joypad_x] (****|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|Left|Right|Down|Up) + +- **Joypad Y** [applewin_joypad_y] (****|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|Left|Right|Down|Up) + +- **Joypad Select** [applewin_joypad_select] (****|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|Left|Right|Down|Up) + +- **Joypad Start** [applewin_joypad_start] (****|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|Left|Right|Down|Up) + +- **Joypad Down [paddle 1 standard]** [applewin_joypad_down] (****|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|Left|Right|Down|Up) + +- **Joypad Up [paddle 1 standard]** [applewin_joypad_up] (****|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|Left|Right|Down|Up) + +- **Joypad Left [paddle 0 standard]** [applewin_joypad_left] (****|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|Left|Right|Down|Up) + +- **Joypad Right [paddle 0 standard]** [applewin_joypad_right] (****|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|Left|Right|Down|Up) + +- **Joypad L** [applewin_joypad_l] (|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|**Space**|ESC|Left|Right|Down|Up) + +- **Joypad R** [applewin_joypad_r] (|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|**Enter**|Space|ESC|Left|Right|Down|Up) + +- **Joypad L2** [applewin_joypad_l2] (|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|**Left**|Right|Down|Up) + +- **Joypad R2** [applewin_joypad_r2] (|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|Left|**Right**|Down|Up) + +- **Joypad L3** [applewin_joypad_l3] (****|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|Left|Right|Down|Up) + +- **Joypad R3** [applewin_joypad_r3] (****|0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z|Enter|Space|ESC|Left|Right|Down|Up) + +## Controllers + +The AppleWin core supports the following device type(s): + +- Standard Joypad +- Analog Joypad +- Mouse + +## External Links + +- [AppleWin Repository](https://github.com/AppleWin/AppleWin) +- [Report AppleWin Core Issues Here](https://github.com/AppleWin/AppleWin/issues) + diff --git a/docs/library/arduous.md b/docs/library/arduous.md new file mode 100644 index 0000000000..1d4f63622d --- /dev/null +++ b/docs/library/arduous.md @@ -0,0 +1,51 @@ +# Arduboy (Arduous) + +## Background + +Arduboy emulator implemented as a libretro core. + +The arduous core has been authored by + +- James Roeder + +The arduous core is licensed under + +- GPLv3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the arduous core have the following file extensions: + +- .hex + +RetroArch database(s) that are associated with the arduous core: + +- [Arduboy Inc - Arduboy](https://github.com/libretro/libretro-database/blob/master/rdb/Arduboy%20Inc%20-%20Arduboy.rdb) + +## Features + +Frontend-level settings or features that the arduous core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✕ | +| RetroArch Cheats | ✕ | +| Disk Control | ✕ | + +### Directories + +The arduous core's library name is 'arduous' + +## Core options + +The arduous core has no core options. + +## External Links + +- [arduous Repository](https://github.com/libretro/arduous) +- [Report arduous Core Issues Here](https://github.com/libretro/arduous/issues) + diff --git a/docs/library/armsx2.md b/docs/library/armsx2.md new file mode 100644 index 0000000000..7c7a43d8e3 --- /dev/null +++ b/docs/library/armsx2.md @@ -0,0 +1,171 @@ +# Sony - PlayStation 2 (ARMSX2) + +## Background + +A libretro port of ARMSX2, a PlayStation 2 emulator forked from PCSX2 and aimed at ARM64 platforms. The core renders through a hardware context it shares with the frontend: Vulkan by default, taking the VkInstance and VkPhysicalDevice from the context-negotiation interface and handing finished frames back through set_image, or an OpenGL core 3.3 context (OpenGL ES 3.2 on Android) when the renderer core option asks for it. A software GS renderer is selectable as well, and presents through that same context. Place a PS2 BIOS dump in 'system/pcsx2/bios' and a copy of the emulator's 'resources' directory in 'system/pcsx2/resources'. Save states, .m3u disc swapping and the usual renderer, upscale and speedhack core options are implemented. + +The ARMSX2 core has been authored by + +- PCSX2 Team +- ARMSX2 Team +- bmdhacks +- WizzardSK + +The ARMSX2 core is licensed under + +- GPLv3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the ARMSX2 core have the following file extensions: + +- .elf +- .iso +- .ciso +- .chd +- .cso +- .zso +- .bin +- .mdf +- .nrg +- .dump +- .gz +- .img +- .irx +- .m3u + +RetroArch database(s) that are associated with the ARMSX2 core: + +- [Sony - PlayStation 2](https://github.com/libretro/libretro-database/blob/master/rdb/Sony%20-%20PlayStation%202.rdb) + +## Features + +Frontend-level settings or features that the ARMSX2 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✔ | +| Rewind | ✕ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✕ | +| Subsystem | ✕ | +| Disk Control | ✔ | + +### Directories + +The ARMSX2 core's library name is 'ARMSX2' + +## Core options + +The ARMSX2 core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +#### Video + +Rendering, scaling and display options. + +- **GS Renderer (restart)** [armsx2_renderer] (**Vulkan**|OpenGL|Software) + + Vulkan renders the GS on the GPU. OpenGL does the same through the frontend's GL context, for devices with no usable Vulkan driver. Software renders on the CPU and presents through the same shared context. + +- **Internal Resolution** [armsx2_upscale] (**1x (native)**|2x|3x|4x) + + Renders the PS2 output at a multiple of native resolution. The output canvas follows this size. + +- **Aspect Ratio** [armsx2_aspect_ratio] (**Auto (4:3 / 3:2 progressive)**|4:3|16:9|Stretch) + + Display aspect ratio. 16:9 is intended for games with widescreen patches or native widescreen modes. + +- **Deinterlacing** [armsx2_deinterlacing] (**Automatic**|Off|Weave TFF|Weave BFF|Bob TFF|Bob BFF|Blend TFF|Blend BFF|Adaptive TFF|Adaptive BFF) + + How interlaced (480i/576i) output is turned into a full frame. Automatic picks per game; Bob is fast, Adaptive is highest quality; Off shows the raw field. + +- **No-Interlacing Patches (restart)** [armsx2_no_interlacing_patches] (**disabled**|enabled) + + Patches supported games to render progressive instead of interlaced — sharper than any deinterlacer. + +- **Widescreen Patches (restart)** [armsx2_widescreen_patches] (**disabled**|enabled) + + Patches supported games to render 16:9. Set Aspect Ratio to 16:9 alongside this. + +- **Blending Accuracy** [armsx2_blending_accuracy] (Minimum|**Basic**|Medium|High|Full|Maximum) + + How accurately PS2 framebuffer blending is emulated on the GPU. Lower levels are faster; raise it only for games with visible blending artifacts. + +- **Dithering** [armsx2_dithering] (**Unscaled**|Off|Scaled) + + Unscaled replicates PS2 dithering; Off can reduce banding artifacts at higher internal resolutions. + +- **Trilinear Filtering** [armsx2_trilinear_filtering] (**Automatic**|Off|Trilinear (PS2)|Trilinear (Forced)) + +- **Hardware Mipmapping** [armsx2_mipmapping] (**enabled**|disabled) + +- **FXAA** [armsx2_fxaa] (**disabled**|enabled) + + Cheap post-process anti-aliasing. + +- **Texture Filtering** [armsx2_texture_filtering] (Nearest|Bilinear (Forced)|**Bilinear (PS2)**|Bilinear (Forced excluding sprites)) + + Bilinear (PS2) filters as the game requests. Forced filters everything, which smooths textures but can blur 2D elements; the sprite-excluding variant protects UI sprites. + +- **Anisotropic Filtering** [armsx2_anisotropic_filtering] (**disabled**|2x|4x|8x|16x) + + Sharpens textures viewed at an angle. Cheap on the GPU, but can cause artifacts in games that rely on point sampling. + +- **Software Renderer Threads** [armsx2_sw_threads] (0|1|**2**|3|4) + + Worker threads for the Software renderer (in addition to the GS thread). No effect on Vulkan. + +- **Show FPS** [armsx2_show_fps] (**disabled**|enabled) + + Draws the internal framerate on screen. + +#### Performance + +Speed hacks trading accuracy for framerate. + +- **EE Cycle Rate** [armsx2_ee_cycle_rate] (50%|60%|75%|**100% (default)**|130%|180%|300%) + + Underclocks or overclocks the emulated Emotion Engine. Below 100% speeds up emulation but can cause stutter or breakage; above 100% can smooth out games with internal slowdown. + +- **EE Cycle Skip** [armsx2_ee_cycle_skip] (**disabled**|mild|moderate|maximum) + + Makes the emulated EE skip cycles. Helps games with obvious VU-driven slowdown; can cause false FPS readings and breakage. + +- **Hardware Download Mode** [armsx2_hw_download_mode] (**Accurate**|Disable Readbacks|Unsynchronized|Disabled) + + How GS-to-EE readbacks are handled. Accurate is correct but expensive on mobile GPUs; Disable Readbacks skips the data copy, Unsynchronized doesn't wait for the GPU, Disabled ignores the transfer entirely. Anything but Accurate can break effects that read the framebuffer. + +- **MTVU (Multi-Threaded VU1)** [armsx2_mtvu] (**enabled**|disabled) + + Runs VU1 on its own thread. Large speedup on multi-core CPUs; a small number of games hang with it. + +- **Instant VU1** [armsx2_instant_vu1] (**enabled**|disabled) + + Runs VU1 programs to completion instantly instead of interleaving with the EE. Fast and safe for most games. + +#### System + +Boot behaviour. + +- **BIOS (restart)** [armsx2_bios] (**Auto (first valid image)**) + + Which BIOS image from /pcsx2/bios to boot. Auto picks the first valid image. + +- **Fast Boot** [armsx2_fast_boot] (**enabled**|disabled) + + Skips the BIOS boot animation. + +- **Enable Cheats** [armsx2_cheats] (**disabled**|enabled) + + Loads .pnach cheat files from /pcsx2/cheats for the running game. + +## External Links + +- [ARMSX2 Repository](https://github.com/ARMSX2/ARMSX2) +- [Report ARMSX2 Core Issues Here](https://github.com/ARMSX2/ARMSX2/issues) + diff --git a/docs/library/bbkemu.md b/docs/library/bbkemu.md new file mode 100644 index 0000000000..ab45214277 --- /dev/null +++ b/docs/library/bbkemu.md @@ -0,0 +1,59 @@ +# BBKEmu (BBK Electronic Dictionary) + +## Background + +BBKEmu is an emulator for BBK electronic dictionary game platform. Games run on the 6502 CPU with the BBK OS ROM providing system calls for LCD, keyboard, audio and timer hardware. Requires font ROM (8.BIN) and OS ROM (E.BIN) from a physical BBK device in system/BBKEmu// directory. + +The BBKEmu core has been authored by + +- jiangxincode + +The BBKEmu core is licensed under + +- GPL-3.0-or-later + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the BBKEmu core have the following file extensions: + +- .gam + +RetroArch database(s) that are associated with the BBKEmu core: + +- [BBK](https://github.com/libretro/libretro-database/blob/master/rdb/BBK.rdb) + +## Features + +Frontend-level settings or features that the BBKEmu core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✔ | +| States | ✔ | +| Rewind | ✕ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✔ | +| Controls | ✔ | +| Subsystem | ✕ | +| Disk Control | ✕ | + +### Directories + +The BBKEmu core's library name is 'BBKEmu' + +## Core options + +The BBKEmu core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **bbkemu_swap_lcd** [bbkemu_lcd_color] (****) + +- **bbkemu_timer_rate** [bbkemu_cpu_rate] (****) + +## External Links + +- [BBKEmu Repository](https://github.com/AloysHF/BBKEmu) +- [Report BBKEmu Core Issues Here](https://github.com/AloysHF/BBKEmu/issues) + diff --git a/docs/library/bsnes_hd_beta.md b/docs/library/bsnes_hd_beta.md new file mode 100644 index 0000000000..a1ad893562 --- /dev/null +++ b/docs/library/bsnes_hd_beta.md @@ -0,0 +1,142 @@ +# Nintendo - SNES / SFC (bsnes-hd beta) + +## Background + +bsnes HD Beta is based on the latest code from the bsnes emulator, but it serves as a test-bed for some additional features that are not considered stable enough for inclusion in the standard bsnes core. These features include true widescreen support and increased color depth (i.e., without dithering), among others. Aside from these additional experimental features, this core is identical to the standard bsnes core in both accuracy and performance (and libretro features/limitations). + +The bsnes-hd beta core has been authored by + +- Near +- DerKoun + +The bsnes-hd beta core is licensed under + +- GPLv3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the bsnes-hd beta core have the following file extensions: + +- .smc +- .sfc +- .swc +- .fig +- .gb +- .gbc +- .bs + +RetroArch database(s) that are associated with the bsnes-hd beta core: + +- [Nintendo - Super Nintendo Entertainment System](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Super%20Nintendo%20Entertainment%20System.rdb) +- [Nintendo - Sufami Turbo](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Sufami%20Turbo.rdb) +- [Nintendo - Satellaview](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Satellaview.rdb) + +## Features + +Frontend-level settings or features that the bsnes-hd beta core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✔ | +| States | ✔ | +| Rewind | ✔ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✔ | +| Subsystem | ✔ | +| Disk Control | ✕ | + +## Core options + +The bsnes-hd beta core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **HD Mode 7 Scale** [bsnes_mode7_scale] (**2x**|3x|4x|5x|6x|7x|8x|9x|10x|disable|1x) + +- **HD Mode 7 Perspective Correction** [bsnes_mode7_perspective] (**auto (wide)**|auto (medium)|auto (narrow)|on (wide)|on (medium)|on (narrow)|off) + +- **HD Mode 7 Supersampling** [bsnes_mode7_supersample] (**none**|2x|3x|4x|5x|6x|7x|8x|9x|10x) + +- **HD Mode 7 HD->SD Mosaic** [bsnes_mode7_mosaic] (**1x scale**|non-HD|ignore) + +- **WideScreen Mode** [bsnes_mode7_wsMode] (**Mode 7**|all|none) + +- **WideScreen Aspect Ratio** [bsnes_mode7_widescreen] (**16:9**|2:1|21:9|16:10|4:3|none) + +- **WideScreen Background 1** [bsnes_mode7_wsbg1] (**auto horz and vert**|off|on|above line 40|below line 40|above line 80|below line 80|above line 120|below line 120|above line 160|below line 160|above line 200|below line 200|crop edges|auto crop edges|disable entirely|auto horizontal) + +- **WideScreen Background 2** [bsnes_mode7_wsbg2] (**auto horz and vert**|off|on|above line 40|below line 40|above line 80|below line 80|above line 120|below line 120|above line 160|below line 160|above line 200|below line 200|crop edges|auto crop edges|disable entirely|auto horizontal) + +- **WideScreen Background 3** [bsnes_mode7_wsbg3] (**auto horz and vert**|off|on|above line 40|below line 40|above line 80|below line 80|above line 120|below line 120|above line 160|below line 160|above line 200|below line 200|crop edges|auto crop edges|disable entirely|auto horizontal) + +- **WideScreen Background 4** [bsnes_mode7_wsbg4] (**auto horz and vert**|off|on|above line 40|below line 40|above line 80|below line 80|above line 120|below line 120|above line 160|below line 160|above line 200|below line 200|crop edges|auto crop edges|disable entirely|auto horizontal) + +- **WideScreen Sprites** [bsnes_mode7_wsobj] (**safe**|unsafe|disable entirely|clip) + +- **WideScreen Area Background Color** [bsnes_mode7_wsBgCol] (**auto**|color|black) + +- **WideScreen Ignore Window** [bsnes_mode7_igwin] (**outside**|outside and always|all|none) + +- **WideScreen Ig Win Coordinate** [bsnes_mode7_igwinx] (**128**|168|216|40|88) + +- **WideScreen Marker** [bsnes_mode7_wsMarker] (**none**|lines|darken) + +- **WideScreen Marker Alpha** [bsnes_mode7_wsMarkerAlpha] (**1/1**|1/2|1/3|1/4|1/5|1/6|1/7|1/8|1/9|1/10) + +- **HD Background Color Radius** [bsnes_mode7_bgGrad] (**4**|5|6|7|8|0|1|2|3) + +- **HD Windowing (experimental)** [bsnes_mode7_windRad] (**0**|1|2|3|4|5|6|7|8) + +- **Show Overscan** [bsnes_ppu_show_overscan] (**OFF**|ON) + +- **Pixel Aspect Correction** [bsnes_video_aspectcorrection] (**OFF**|ON) + +- **Blur emulation** [bsnes_blur_emulation] (**OFF**|ON) + +- **Entropy (randomization)** [bsnes_entropy] (**Low**|High|None) + +- **Hotfixes** [bsnes_hotfixes] (**OFF**|ON) + +- **CPU Fast Math** [bsnes_cpu_fastmath] (**OFF**|ON) + +- **CPU Overclocking** [bsnes_cpu_overclock] (100 to 400 in steps of 10, **100**) + +- **SA1 Coprocessor Overclocking** [bsnes_sa1_overclock] (100 to 400 in steps of 10, **100**) + +- **SuperFX Coprocessor Overclocking** [bsnes_sfx_overclock] (100 to 800 in steps of 10, **100**) + +- **PPU Fast mode** [bsnes_ppu_fast] (**ON**|OFF) + +- **PPU Deinterlace** [bsnes_ppu_deinterlace] (**ON**|OFF) + +- **PPU No sprite limit** [bsnes_ppu_no_sprite_limit] (**ON**|OFF) + +- **PPU No VRAM blocking** [bsnes_ppu_no_vram_blocking] (**OFF**|ON) + +- **DSP Fast mode** [bsnes_dsp_fast] (**ON**|OFF) + +- **DSP Cubic interpolation** [bsnes_dsp_cubic] (**OFF**|ON) + +- **DSP Echo shadow RAM** [bsnes_dsp_echo_shadow] (**OFF**|ON) + +- **Coprocessor Delayed Sync** [bsnes_coprocessor_delayed_sync] (**ON**|OFF) + +- **Coprocessor Prefer HLE** [bsnes_coprocessor_prefer_hle] (**ON**|OFF) + +- **Preferred Super GameBoy BIOS (restart)** [bsnes_sgb_bios] (**SGB1.sfc**|SGB2.sfc) + +- **Amount of frames for run-ahead** [bsnes_run_ahead_frames] (**OFF**|1|2|3|4) + +- **Luminance** [bsnes_video_luminance] (**100**|90|80|70|60|50|40|30|20|10|0) + +- **Saturation** [bsnes_video_saturation] (**100**|90|80|70|60|50|40|30|20|10|0|200|190|180|170|160|150|140|130|120|110) + +- **Gamma** [bsnes_video_gamma] (**100**|110|120|130|140|150|160|170|180|190|200) + +## External Links + +- [bsnes-hd beta Repository](https://github.com/libretro/bsnes-hd) +- [Report bsnes-hd beta Core Issues Here](https://github.com/libretro/bsnes-hd/issues) + diff --git a/docs/library/cdi2015.md b/docs/library/cdi2015.md new file mode 100644 index 0000000000..1d4e5647d3 --- /dev/null +++ b/docs/library/cdi2015.md @@ -0,0 +1,72 @@ +# Philips CDi (CDi 2015) + +## Background + +Based on the MAME codebase's Philips CDi emulation circa 2015, 'CDi 2015' is compatible with CDi games in CHD format from any MAME set. This core is designed to make it very easy to load these games. Names are irrelevant, hash lists aren't needed, just put the BIOS (again, from any MAME set) into the system directory, then load the game. + +The Philips CD-i 2015 core has been authored by + +- MAMEdev + +The Philips CD-i 2015 core is licensed under + +- GPLv2+ + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Philips CD-i 2015 core have the following file extensions: + +- .chd + +RetroArch database(s) that are associated with the Philips CD-i 2015 core: + +- [Philips - CD-i](https://github.com/libretro/libretro-database/blob/master/rdb/Philips%20-%20CD-i.rdb) + +## Features + +Frontend-level settings or features that the Philips CD-i 2015 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✕ | +| Disk Control | ✕ | + +### Directories + +The Philips CD-i 2015 core's library name is 'Philips CD-i 2015' + +## Core options + +The Philips CD-i 2015 core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Read configuration** [cdi2015_read_config] (**disabled**|enabled) + +- **Auto save/load states** [cdi2015_auto_save] (**disabled**|enabled) + +- **XY device (Restart)** [cdi2015_mouse_mode] (**none**|lightgun|mouse) + +- **Enable throttle** [cdi2015_throttle] (**disabled**|enabled) + +- **Enable cheats** [cdi2015_cheats_enable] (**disabled**|enabled) + +- **Hide nag screen** [cdi2015_hide_nagscreen] (**disabled**|enabled) + +- **Hide gameinfo screen** [cdi2015_hide_infoscreen] (**disabled**|enabled) + +- **Hide warnings screen** [cdi2015_hide_warnings] (**disabled**|enabled) + +- **Alternate render method** [cdi2015_alternate_renderer] (**disabled**|enabled) + +## External Links + +- [Libretro MAME 2015 Repository (CDi 2015 is built from it)](https://github.com/libretro/mame2015-libretro) +- [Report CDi 2015 Core Issues Here](https://github.com/libretro/mame2015-libretro/issues) + diff --git a/docs/library/citra2018.md b/docs/library/citra2018.md new file mode 100644 index 0000000000..66ec65f979 --- /dev/null +++ b/docs/library/citra2018.md @@ -0,0 +1,100 @@ +# Nintendo - 3DS (Citra 2018) + +## Background + +A port of the Citra 3DS emulator to libretro. The core requires decrypted ROMs to function, and some games require Mii data to be dumped from your own 3DS console. + +The Citra2018 core has been authored by + +- Citra Emulation Project + +The Citra2018 core is licensed under + +- GPLv2+ + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Citra2018 core have the following file extensions: + +- .3ds +- .3dsx +- .cia +- .elf + +RetroArch database(s) that are associated with the Citra2018 core: + +- [Nintendo - Nintendo 3DS](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Nintendo%203DS.rdb) + +## Features + +Frontend-level settings or features that the Citra2018 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✔ | +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✔ | +| Subsystem | ✕ | +| Disk Control | ✕ | + +### Directories + +The Citra2018 core's library name is 'Citra2018' + +## Core options + +The Citra2018 core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Enable CPU JIT** [citra2018_use_cpu_jit] (**enabled**|disabled) + +- **Enable hardware renderer** [citra2018_use_hw_renderer] (**enabled**|disabled) + +- **Enable shader JIT** [citra2018_use_shader_jit] (**enabled**|disabled) + +- **Enable hardware shaders** [citra2018_use_hw_shaders] (**enabled**|disabled) + +- **Enable accurate geometry shaders (only for H/W shaders)** [citra2018_use_acc_geo_shaders] (**enabled**|disabled) + +- **Enable accurate shaders multiplication (only for H/W shaders)** [citra2018_use_acc_mul] (**enabled**|disabled) + +- **Resolution scale factor** [citra2018_resolution_factor] (**1x (Native)**|2x|3x|4x|5x|6x|7x|8x|9x|10x) + +- **Screen layout positioning** [citra2018_layout_option] (**Default Top-Bottom Screen**|Single Screen Only|Large Screen, Small Screen|Side by Side) + +- **Prominent 3DS screen** [citra2018_swap_screen] (**Top**|Bottom) + +- **Right analog function** [citra2018_analog_function] (**C-Stick and Touchscreen Pointer**|Touchscreen Pointer|C-Stick) + +- **Emulated pointer deadzone (%)** [citra2018_deadzone] (**15**|20|25|30|35|0|5|10) + +- **Enable mouse input for touchscreen** [citra2018_mouse_touchscreen] (**enabled**|disabled) + +- **Show mouse pointer for touchscreen** [citra2018_mouse_show_pointer] (**enabled**|disabled) + +- **Enable virtual SD card** [citra2018_use_virtual_sd] (**enabled**|disabled) + +- **Savegame location** [citra2018_use_libretro_save_path] (**LibRetro Default**|Citra Default) + +- **3DS system model** [citra2018_is_new_3ds] (**Old 3DS**|New 3DS) + +- **3DS system region** [citra2018_region_value] (**Auto**|Japan|USA|Europe|Australia|China|Korea|Taiwan) + +- **Enable GDB stub** [citra2018_use_gdbstub] (**disabled**|enabled) + +## Controllers + +The Citra2018 core supports the following device type(s): + +- Nintendo 3DS + +## External Links + +- [Citra2018 Repository](https://github.com/libretro/citra2018) +- [Report Citra2018 Core Issues Here](https://github.com/libretro/citra2018/issues) + diff --git a/docs/library/dirksimple.md b/docs/library/dirksimple.md new file mode 100644 index 0000000000..173a9a975d --- /dev/null +++ b/docs/library/dirksimple.md @@ -0,0 +1,52 @@ +# Laserdisc arcade game (DirkSimple) + +## Background + +A player of laserdisc arcade games. + +The dirksimple core has been authored by + +- Ryan C. Gordon + +The dirksimple core is licensed under + +- zlib + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the dirksimple core have the following file extensions: + +- .ogv +- .dirksimple + +## Features + +Frontend-level settings or features that the dirksimple core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✔ | +| Rewind | ✔ | +| RetroArch Cheats | ✕ | + +### Directories + +The dirksimple core's library name is 'dirksimple' + +## Core options + +The dirksimple core has no core options. + +## Controllers + +The dirksimple core supports the following device type(s): + +- Generic game controller + +## External Links + +- [dirksimple Repository](https://github.com/icculus/DirkSimple) +- [Report dirksimple Core Issues Here](https://github.com/icculus/DirkSimple/issues) + diff --git a/docs/library/fbalpha2012.md b/docs/library/fbalpha2012.md new file mode 100644 index 0000000000..2159bda930 --- /dev/null +++ b/docs/library/fbalpha2012.md @@ -0,0 +1,56 @@ +# Arcade (FB Alpha 2012) + +## Background + +Based on a snapshot of the Final Burn Alpha codebase from circa 2012, 'FB Alpha 2012' is compatible with FB Alpha v0.2.97.29 ROM sets. Most users should use up-to-date FBNeo instead and should only fall back to this core if their device is not capable of running that core. + +The FB Alpha 2012 core has been authored by + +- Team FB Alpha + +The FB Alpha 2012 core is licensed under + +- Non-commercial + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the FB Alpha 2012 core have the following file extensions: + +- .iso +- .zip +- .7z + +## Features + +Frontend-level settings or features that the FB Alpha 2012 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✔ | +| Rewind | ✔ | + +### Directories + +The FB Alpha 2012 core's library name is 'FB Alpha 2012' + +## Core options + +The FB Alpha 2012 core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. These options are set when content is loaded. **Diagnostic Input** is only shown for games that have a diagnostic input, and **Neo Geo mode** only for Neo Geo games. Each game's DIP switches are added as further options. + +- **Core-provided aspect ratio** [fbalpha2012_aspect] (**DAR**|PAR) + +- **CPU overclock** [fbalpha2012_cpu_speed_adjust] (**100**|110|120|130|140|150|160|170|180|190|200) + +- **Diagnostic Input** [fbalpha2012_diagnostic_input] (**None**|Hold Start|Start + A + B|Hold Start + A + B|Start + L + R|Hold Start + L + R|Hold Select|Select + A + B|Hold Select + A + B|Select + L + R|Hold Select + L + R) + +- **Hiscores** [fbalpha2012_hiscores] (**enabled**|disabled) + +- **Neo Geo mode** [fbalpha2012_neogeo_mode] (**MVS**|AES|UNIBIOS|DIPSWITCH) + +## External Links + +- [FB Alpha 2012 Repository](https://github.com/libretro/fbalpha2012) +- [Report FB Alpha 2012 Core Issues Here](https://github.com/libretro/fbalpha2012/issues) + diff --git a/docs/library/fbalpha2012_cps1.md b/docs/library/fbalpha2012_cps1.md new file mode 100644 index 0000000000..70b212e1fb --- /dev/null +++ b/docs/library/fbalpha2012_cps1.md @@ -0,0 +1,81 @@ +# Arcade (FB Alpha 2012 CPS-1) + +## Background + +Based on a snapshot of the Final Burn Alpha codebase from circa 2012, 'FB Alpha 2012 CPS-1' is compatible with FB Alpha v0.2.97.28 ROM sets. This core variant is for CPS-1 games only. It exists solely for use with RAM-constrained platforms, such as certain console or embedded platforms, that do not have the capacity to load the full core along with large games. Most users should use up-to-date FBNeo instead. + +The FB Alpha 2012 CPS-1 core has been authored by + +- Team FB Alpha + +The FB Alpha 2012 CPS-1 core is licensed under + +- Non-commercial + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the FB Alpha 2012 CPS-1 core have the following file extensions: + +- .zip + +## Features + +Frontend-level settings or features that the FB Alpha 2012 CPS-1 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✔ | +| Rewind | ✔ | +| Core Options | ✔ | + +### Directories + +The FB Alpha 2012 CPS-1 core's library name is 'FB Alpha 2012 CPS-1' + +## Core options + +The FB Alpha 2012 CPS-1 core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **CPU Speed (%)** [fba2012cps1_cpu_speed_adjust] (**100**|110|120|130|140|150|160|170|180|190|200) + + Enables overclocking of the emulated CPU. Can reduce slowdown, but may cause glitches. + +- **High scores** [fba2012cps1_hiscores] (enabled|**disabled**) + + Enables saving of high scores in supported games. Requires the file 'hiscore.dat' to be placed in your system/fbalpha2012/ folder. + +- **Core-Provided Aspect Ratio** [fba2012cps1_aspect] (**DAR**|PAR) + + Selects the preferred content aspect ratio. This will only apply when RetroArch's aspect ratio is set to 'Core provided' in the Video settings. + +- **Rotate Vertically Aligned Games (Restart)** [fba2012cps1_auto_rotate] (**enabled**|disabled) + + Automatically rotate the display when running vertically aligned games. When disabled, D-Pad input will be rotated to match on-screen directions. + +- **Audio Filter** [fba2012cps1_lowpass_filter] (**disabled**|enabled) + + Enables a low pass audio filter to soften the 'harsh' sound of some arcade games. + +- **Audio Filter Level (%)** [fba2012cps1_lowpass_range] (5 to 95 in steps of 5, **60**) + + Specifies the cut-off frequency of the low pass audio filter. A higher value increases the perceived 'strength' of the filter, since a wider range of the high frequency spectrum is attenuated. + +- **Frameskip** [fba2012cps1_frameskip] (**disabled**|Auto|Manual) + + Skip frames to avoid audio buffer under-run (crackling). Improves performance at the expense of visual smoothness. 'Auto' skips frames when advised by the frontend. 'Manual' utilizes the 'Frameskip Threshold (%)' setting. + +- **Frameskip Threshold (%)** [fba2012cps1_frameskip_threshold] (15 to 60 in steps of 3, **33**) + + When 'Frameskip' is set to 'Manual', specifies the audio buffer occupancy threshold (percentage) below which frames will be skipped. Higher values reduce the risk of crackling by causing frames to be dropped more frequently. + +- **Diagnostic Input** [fba2012cps1_diagnostics] (**disabled**|enabled) + + Toggle ON then resume content to open service menu. + +## External Links + +- [FB Alpha 2012 CPS-1 Repository](https://github.com/libretro/fbalpha2012_cps1) +- [Report FB Alpha 2012 CPS-1 Core Issues Here](https://github.com/libretro/fbalpha2012_cps1/issues) + diff --git a/docs/library/fbalpha2012_cps2.md b/docs/library/fbalpha2012_cps2.md new file mode 100644 index 0000000000..dbca305ce3 --- /dev/null +++ b/docs/library/fbalpha2012_cps2.md @@ -0,0 +1,81 @@ +# Arcade (FB Alpha 2012 CPS-2) + +## Background + +Based on a snapshot of the Final Burn Alpha codebase from circa 2012, 'FB Alpha 2012 CPS-2' is compatible with FB Alpha v0.2.97.28 ROM sets. This core variant is for CPS-2 games only. It exists solely for use with RAM-constrained platforms, such as certain console or embedded platforms, that do not have the capacity to load the full core along with large games. Most users should use up-to-date FBNeo instead. + +The FB Alpha 2012 CPS-2 core has been authored by + +- Team FB Alpha + +The FB Alpha 2012 CPS-2 core is licensed under + +- Non-commercial + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the FB Alpha 2012 CPS-2 core have the following file extensions: + +- .zip + +## Features + +Frontend-level settings or features that the FB Alpha 2012 CPS-2 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✔ | +| Rewind | ✔ | +| Core Options | ✔ | + +### Directories + +The FB Alpha 2012 CPS-2 core's library name is 'FB Alpha 2012 CPS-2' + +## Core options + +The FB Alpha 2012 CPS-2 core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **CPU Speed (%)** [fba2012cps2_cpu_speed_adjust] (**100**|110|120|130|140|150|160|170|180|190|200) + + Enables overclocking of the emulated CPU. Can reduce slowdown, but may cause glitches. + +- **High scores** [fba2012cps2_hiscores] (enabled|**disabled**) + + Enables saving of high scores in supported games. Requires the file 'hiscore.dat' to be placed in your system/fbalpha2012/ folder. + +- **Controls** [fba2012cps2_controls] (**Gamepad**|Arcade) + + Set default controller mapping. + +- **Core-Provided Aspect Ratio** [fba2012cps2_aspect] (**DAR**|PAR) + + Selects the preferred content aspect ratio. This will only apply when RetroArch's aspect ratio is set to 'Core provided' in the Video settings. + +- **Rotate Vertically Aligned Games (Restart Required)** [fba2012cps2_auto_rotate] (**enabled**|disabled) + + Automatically rotate the display when running vertically aligned games. When disabled, D-Pad input will be rotated to match on-screen directions. + +- **Audio Filter** [fba2012cps2_lowpass_filter] (**disabled**|enabled) + + Enables a low pass audio filter to soften the 'harsh' sound of some arcade games. + +- **Audio Filter Level (%)** [fba2012cps2_lowpass_range] (5 to 95 in steps of 5, **60**) + + Specifies the cut-off frequency of the low pass audio filter. A higher value increases the perceived 'strength' of the filter, since a wider range of the high frequency spectrum is attenuated. + +- **Frameskip** [fba2012cps2_frameskip] (**disabled**|Auto|Manual) + + Skip frames to avoid audio buffer under-run (crackling). Improves performance at the expense of visual smoothness. 'Auto' skips frames when advised by the frontend. 'Manual' utilizes the 'Frameskip Threshold (%)' setting. + +- **Frameskip Threshold (%)** [fba2012cps2_frameskip_threshold] (15 to 60 in steps of 3, **33**) + + When 'Frameskip' is set to 'Manual', specifies the audio buffer occupancy threshold (percentage) below which frames will be skipped. Higher values reduce the risk of crackling by causing frames to be dropped more frequently. + +## External Links + +- [FB Alpha 2012 CPS-2 Repository](https://github.com/libretro/fbalpha2012_cps2) +- [Report FB Alpha 2012 CPS-2 Core Issues Here](https://github.com/libretro/fbalpha2012_cps2/issues) + diff --git a/docs/library/fbalpha2012_cps3.md b/docs/library/fbalpha2012_cps3.md new file mode 100644 index 0000000000..bc1f89a382 --- /dev/null +++ b/docs/library/fbalpha2012_cps3.md @@ -0,0 +1,64 @@ +# Arcade (FB Alpha 2012 CPS-3) + +## Background + +Based on a snapshot of the Final Burn Alpha codebase from circa 2012, 'FB Alpha 2012 CPS-3' is compatible with FB Alpha v0.2.97.29 ROM sets. This core variant is for CPS-3 games only. It exists solely for use with RAM-constrained platforms, such as certain console or embedded platforms, that do not have the capacity to load the full core along with large games. Most users should use up-to-date FBNeo instead. + +The FB Alpha 2012 CPS-3 core has been authored by + +- Team FB Alpha + +The FB Alpha 2012 CPS-3 core is licensed under + +- Non-commercial + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the FB Alpha 2012 CPS-3 core have the following file extensions: + +- .iso +- .zip + +## Features + +Frontend-level settings or features that the FB Alpha 2012 CPS-3 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✔ | +| Rewind | ✔ | +| Core Options | ✔ | + +### Directories + +The FB Alpha 2012 CPS-3 core's library name is 'FB Alpha 2012 CPS-3' + +## Core options + +The FB Alpha 2012 CPS-3 core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Core-provided aspect ratio** [fbalpha2012_cps3_aspect] (**DAR**|PAR) + +- **Frameskip** [fbalpha2012_cps3_frameskip] (**0**|1|2|3|4|5) + +- **CPU overclock** [fbalpha2012_cps3_cpu_speed_adjust] (**100**|110|120|130|140|150|160|170|180|190|200) + +- **P1 control scheme** [fbalpha2012_cps3_controls_p1] (**gamepad**|arcade) + +- **P2 control scheme** [fbalpha2012_cps3_controls_p2] (**gamepad**|arcade) + +- **Hiscores** [fbalpha2012_cps3_hiscores] (**enabled**|disabled) + +- **Samplerate (need to quit retroarch)** [fbalpha2012_cps3_samplerate] (**48000**|44100|32000|22050|11025) + +- **L/R P1 gamepad scheme** [fbalpha2012_cps3_lr_controls_p1] (**normal**|remap to R1/R2) + +- **L/R P2 gamepad scheme** [fbalpha2012_cps3_lr_controls_p2] (**normal**|remap to R1/R2) + +## External Links + +- [FB Alpha 2012 CPS-3 Repository](https://github.com/libretro/fbalpha2012_cps3) +- [Report FB Alpha 2012 CPS-3 Core Issues Here](https://github.com/libretro/fbalpha2012_cps3/issues) + diff --git a/docs/library/fbalpha2012_neogeo.md b/docs/library/fbalpha2012_neogeo.md new file mode 100644 index 0000000000..1819231781 --- /dev/null +++ b/docs/library/fbalpha2012_neogeo.md @@ -0,0 +1,78 @@ +# Arcade (FB Alpha 2012 Neo Geo) + +## Background + +Based on a snapshot of the Final Burn Alpha codebase from circa 2012, 'FB Alpha 2012 Neo Geo' is compatible with FB Alpha v0.2.97.29 ROM sets. This core variant is for Neo-Geo games only. It exists solely for use with RAM-constrained platforms, such as certain console or embedded platforms, that do not have the capacity to load the full core along with large games. Most users should use up-to-date FBNeo instead. + +The FB Alpha 2012 Neo Geo core has been authored by + +- Team FB Alpha + +The FB Alpha 2012 Neo Geo core is licensed under + +- Non-commercial + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the FB Alpha 2012 Neo Geo core have the following file extensions: + +- .iso +- .zip +- .7z + +## Features + +Frontend-level settings or features that the FB Alpha 2012 Neo Geo core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✔ | +| Rewind | ✔ | + +### Directories + +The FB Alpha 2012 Neo Geo core's library name is 'FB Alpha 2012 Neo Geo' + +## Core options + +The FB Alpha 2012 Neo Geo core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. These options are set when content is loaded. **Diagnostic Input** is only shown for games that have a diagnostic input. Each game's DIP switches are added as further options. + +- **Core-Provided Aspect Ratio** [fbalpha2012_neogeo_aspect] (**DAR**|PAR) + + Choose the preferred content aspect ratio. This will only apply when RetroArch's aspect ratio is set to 'Core provided' in the Video settings. + +- **CPU Speed (%)** [fbalpha2012_neogeo_cpu_speed_adjust] (**100**|110|120|130|140|150|160|170|180|190|200) + + Enables overclocking of the emulated CPU. Can reduce slowdown, but may cause glitches. + +- **Diagnostic Input** [fbalpha2012_neogeo_diagnostic_input] (**None**|Hold Start|Start + A + B|Hold Start + A + B|Start + L + R|Hold Start + L + R|Hold Select|Select + A + B|Hold Select + A + B|Select + L + R|Hold Select + L + R) + + Enables access to the service menu via the selected key combination. + +- **Audio Filter** [fbalpha2012_neogeo_lowpass_filter] (**disabled**|enabled) + + Enables a low pass audio filter to soften the 'harsh' sound of some arcade games. + +- **Audio Filter Level (%)** [fbalpha2012_neogeo_lowpass_range] (5 to 95 in steps of 5, **60**) + + Specifies the cut-off frequency of the low pass audio filter. A higher value increases the perceived 'strength' of the filter, since a wider range of the high frequency spectrum is attenuated. + +- **Frameskip** [fbalpha2012_neogeo_frameskip] (**disabled**|Auto|Manual) + + Skip frames to avoid audio buffer under-run (crackling). Improves performance at the expense of visual smoothness. 'Auto' skips frames when advised by the frontend. 'Manual' utilises the 'Frameskip Threshold (%)' setting. + +- **Frameskip Threshold (%)** [fbalpha2012_neogeo_frameskip_threshold] (15 to 60 in steps of 3, **33**) + + When 'Frameskip' is set to 'Manual', specifies the audio buffer occupancy threshold (percentage) below which frames will be skipped. Higher values reduce the risk of crackling by causing frames to be dropped more frequently. + +- **Neo Geo Mode** [fbalpha2012_neogeo_neogeo_mode] (**MVS**|AES|UNIBIOS|DIPSWITCH) + + Choose operating mode by selecting which bios to load: MVS - Arcade; AES - Home; UNIBIOS - Hold A+B+C at UNIBIOS boot screen to configure system; DIPSWITCH - Use DIP switch setting. + +## External Links + +- [FB Alpha 2012 Neo Geo Repository](https://github.com/libretro/fbalpha2012_neogeo) +- [Report FB Alpha 2012 Neo Geo Core Issues Here](https://github.com/libretro/fbalpha2012_neogeo/issues) + diff --git a/docs/library/fixgb.md b/docs/library/fixgb.md new file mode 100644 index 0000000000..799f5db070 --- /dev/null +++ b/docs/library/fixgb.md @@ -0,0 +1,42 @@ +# Nintendo - Game Boy / Color (fixGB) + +## Background + +A preliminary Game Boy emulator written as a learning experience, this core still supports many of the games and features that are attractive to users, such as support for Game Boy Color palettes via BIOS and support for older colorization hacks by adding 'InvVRAM' to the filename (like this: foo.gb -> foo (InvVRAM).gb). However, users looking for a simple, turnkey GB/C emulator will probably have better luck with more mature options, such as SameBoy, Gambatte or GearBoy, depending on their use-case. + +The fixGB core has been authored by + +- FIX94 + +The fixGB core is licensed under + +- MIT + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the fixGB core have the following file extensions: + +- .gb +- .gbc +- .gbs + +RetroArch database(s) that are associated with the fixGB core: + +- [Nintendo - Game Boy](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Game%20Boy.rdb) +- [Nintendo - Game Boy Color](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Game%20Boy%20Color.rdb) + +### Directories + +The fixGB core's library name is 'fixGB' + +## Core options + +The fixGB core has no core options. + +## External Links + +- [fixGB Repository](https://github.com/libretro/fixGB) +- [Report fixGB Core Issues Here](https://github.com/libretro/fixGB/issues) + diff --git a/docs/library/fixnes.md b/docs/library/fixnes.md new file mode 100644 index 0000000000..369b4ecc84 --- /dev/null +++ b/docs/library/fixnes.md @@ -0,0 +1,43 @@ +# Nintendo - NES / Famicom (fixNES) + +## Background + +An alpha-stage emulator written as a learning experience, fixNES is a good, simple core for learning how NES emulators are written, but it's not a good choice for general use. Individuals who are looking for a feature-complete, accurate, easily-usable emulator should look instead to Mesen, Nestopia or FCEUmm, depending on their use-case. + +The fixNES core has been authored by + +- FIX94 + +The fixNES core is licensed under + +- MIT + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the fixNES core have the following file extensions: + +- .nes +- .fds +- .qd +- .nsf + +RetroArch database(s) that are associated with the fixNES core: + +- [Nintendo - Nintendo Entertainment System](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Nintendo%20Entertainment%20System.rdb) +- [Nintendo - Family Computer Disk System](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Family%20Computer%20Disk%20System.rdb) + +### Directories + +The fixNES core's library name is 'fixNES' + +## Core options + +The fixNES core has no core options. + +## External Links + +- [fixNES Repository](https://github.com/libretro/fixNES) +- [Report fixNES Core Issues Here](https://github.com/libretro/fixNES/issues) + diff --git a/docs/library/freechaf.md b/docs/library/freechaf.md new file mode 100644 index 0000000000..183ade1183 --- /dev/null +++ b/docs/library/freechaf.md @@ -0,0 +1,51 @@ +# Fairchild - ChannelF (FreeChaF) + +## Background + +A lightweight Fairchild ChannelF / Video Entertainment System designed for libretro. This core was written specifically for use with low-power devices, such as Raspberry Pi, and supports loading a 'no cart' ROM to play the built-in games, controller swapping and dual-analog controls. The core requires the sl31253 and sl31254 BIOS images but the sl90025 BIOS will supersede the sl31253 version if found. + +The FreeChaF core has been authored by + +- David Richardson + +The FreeChaF core is licensed under + +- GPLv3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the FreeChaF core have the following file extensions: + +- .bin +- .rom +- .chf + +RetroArch database(s) that are associated with the FreeChaF core: + +- [Fairchild - Channel F](https://github.com/libretro/libretro-database/blob/master/rdb/Fairchild%20-%20Channel%20F.rdb) + +## Features + +Frontend-level settings or features that the FreeChaF core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Core Options | ✔ | + +### Directories + +The FreeChaF core's library name is 'FreeChaF' + +## Core options + +The FreeChaF core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Clear screen in single frame** [freechaf_fast_scrclr] (**disabled**|enabled) + +## External Links + +- [FreeChaF Repository](https://github.com/libretro/FreeChaF) +- [Report FreeChaF Core Issues Here](https://github.com/libretro/FreeChaF/issues) + diff --git a/docs/library/frodo.md b/docs/library/frodo.md new file mode 100644 index 0000000000..639e1d288c --- /dev/null +++ b/docs/library/frodo.md @@ -0,0 +1,55 @@ +# Commodore - C64 (Frodo) + +## Background + +The Frodo core has been authored by + +- Frodo Team Members + +The Frodo core is licensed under + +- GPLv2 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Frodo core have the following file extensions: + +- .d64 +- .t64 +- .x64 +- .p00 +- .lnx +- .lyx +- .zip + +RetroArch database(s) that are associated with the Frodo core: + +- [Commodore - 64](https://github.com/libretro/libretro-database/blob/master/rdb/Commodore%20-%2064.rdb) + +## Features + +Frontend-level settings or features that the Frodo core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✔ | + +### Directories + +The Frodo core's library name is 'Frodo' + +## Core options + +The Frodo core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Internal Resolution** [frodo_resolution] (**384x288**|400x300|640x480|832x576|960x720|1024x768|1024x1024) + +## External Links + +- [Frodo Repository](https://github.com/libretro/frodo-libretro) +- [Report Frodo Core Issues Here](https://github.com/libretro/frodo-libretro/issues) + diff --git a/docs/library/fsuae.md b/docs/library/fsuae.md new file mode 100644 index 0000000000..af0a073df3 --- /dev/null +++ b/docs/library/fsuae.md @@ -0,0 +1,54 @@ +# Commodore - Amiga (FS-UAE) + +## Background + +A port of the FS-UAE Amiga emulator to libretro. The core expects a kickstart to be located in the user's 'saves' directory, in a subdirectory named fsue/Kickstarts. Most users will be better served by the PUAE core, which has received more work to integrate it with libretro and to make it usable with just a gamepad. + +The FS-UAE core has been authored by + +- FrodeSolheim + +The FS-UAE core is licensed under + +- GPLv2 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the FS-UAE core have the following file extensions: + +- .adf +- .ipf +- .fs-uae + +RetroArch database(s) that are associated with the FS-UAE core: + +- [Commodore - Amiga](https://github.com/libretro/libretro-database/blob/master/rdb/Commodore%20-%20Amiga.rdb) + +## Features + +Frontend-level settings or features that the FS-UAE core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✕ | +| Rewind | ✕ | + +## Core options + +The FS-UAE core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Internal resolution** [fsuaeresolution] (**640x400**|640x432|640x480|640x540|704x480|704x540|720x480|720x540|800x600|1024x768) + +- **Pixel Format** [fsuaefmt] (**RGB565**|XRGB8888) + +- **Use Analog** [analog] (**OFF**|ON) + +- **Leds** [leds] (**Standard**|Simplified|None) + +## External Links + +- [FS-UAE Repository](https://github.com/libretro/libretro-fsuae) +- [Report FS-UAE Core Issues Here](https://github.com/libretro/libretro-fsuae/issues) + diff --git a/docs/library/galaksija.md b/docs/library/galaksija.md new file mode 100644 index 0000000000..3bde1ef6e5 --- /dev/null +++ b/docs/library/galaksija.md @@ -0,0 +1,58 @@ +# Elektronika Inženjering - Galaksija (Galaksija) + +## Background + +Galaksija (Galaxy) was a low-cost home computer released in 1983 in the former Yugoslav countries as a build-it-yourself kit. The design, which was based on the Zilog Z80A CPU, was later mass produced for distribution to schools. + +The galaksija core has been authored by + +- nikp123 + +The galaksija core is licensed under + +- Public Domain + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the galaksija core have the following file extensions: + +- ..gal + +The galaksija core can also be started without content. + +## Features + +Frontend-level settings or features that the galaksija core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✕ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✕ | +| Subsystem | ✕ | +| Disk Control | ✕ | + +### Directories + +The galaksija core's library name is 'galaksija' + +## Core options + +The galaksija core has no core options. + +## Controllers + +The galaksija core supports the following device type(s): + + +## External Links + +- [galaksija Repository](https://github.com/libretro/galaxy-libretro) +- [Report galaksija Core Issues Here](https://github.com/libretro/galaxy-libretro/issues) + diff --git a/docs/library/gong.md b/docs/library/gong.md new file mode 100644 index 0000000000..7b0ca160a9 --- /dev/null +++ b/docs/library/gong.md @@ -0,0 +1,63 @@ +# Gong + +## Background + +A clone of Pong written for libretro. + +The gong core has been authored by + +- Brad Parker + +The gong core is licensed under + +- GPL v3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the gong core have the following file extensions: + +- .gong + +The gong core can also be started without content. + +## Features + +Frontend-level settings or features that the gong core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✔ | +| Rewind | ✔ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✔ | +| Subsystem | ✕ | +| Disk Control | ✕ | + +### Directories + +The gong core's library name is 'gong' + +## Core options + +The gong core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Player 2** [gong_player2] (**CPU**|Human) + +- **Video Refresh Rate (restart)** [gong_refresh] (**60**|70|72|75|100|119|120|140|144) + +## Controllers + +The gong core supports 2 port(s). Each can be set to one of the following device types: + +- Joypad + +## External Links + +- [gong Repository](https://github.com/libretro/gong) +- [Report gong Core Issues Here](https://github.com/libretro/gong/issues) + diff --git a/docs/library/hbmame.md b/docs/library/hbmame.md new file mode 100644 index 0000000000..016757a19b --- /dev/null +++ b/docs/library/hbmame.md @@ -0,0 +1,136 @@ +# Arcade (HBMAME) + +## Background + +'HBMAME' is compatible with HBMAME latest ROM sets. HBMAME (HomeBrew MAME) is a derivative of MAME, and contains various hacks and homebrews. For most users and use-cases (that is, anything that's not homebrew/hacks), the normal, up-to-date MAME or FBNeo cores are a better option. + +The MAME core has been authored by + +- Robbbert,MAMEdev + +The MAME core is licensed under + +- GPLv2+ + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the MAME core have the following file extensions: + +- .cmd +- .zip +- .7z + +RetroArch database(s) that are associated with the MAME core: + +- [HBMAME](https://github.com/libretro/libretro-database/blob/master/rdb/HBMAME.rdb) + +## Features + +Frontend-level settings or features that the MAME core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Core Options | ✔ | + +### Directories + +The MAME core's library name is 'MAME' + +## Core options + +The MAME core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +#### System + +Configure general MAME related options. + +- **Thread Mode** [mame_thread_mode] (disabled|**enabled**) + +- **Cheats** [mame_cheats_enable] (**disabled**|enabled) + +- **Throttle** [mame_throttle] (**disabled**|enabled) + +- **Boot to BIOS** [mame_boot_to_bios] (**disabled**|enabled) + +- **Boot to OSD** [mame_boot_to_osd] (**disabled**|enabled) + +- **Read Configuration** [mame_read_config] (**disabled**|enabled) + +- **Write Configuration** [mame_write_config] (**disabled**|enabled) + +- **MAME INI Paths** [mame_mame_paths_enable] (**disabled**|enabled) + +- **Save State Naming** [mame_saves] (**Game**|System) + +- **Auto Save/Load States** [mame_auto_save] (**disabled**|enabled) + +- **Softlists** [mame_softlists_enable] (disabled|**enabled**) + +- **Softlist Automatic Media Type** [mame_softlists_auto_media] (disabled|**enabled**) + +- **Media Type** [mame_media_type] (cart|cass|cdrm|flop|hard|prin|**rom**|serl) + +- **VFS Enabled** [mame_vfs_enabled] (disabled|**enabled**) + + Enable or disable RetroArch VFS interface. VFS interface v4 or higher is required. Restart core to take effect + +#### Input + +Configure input options. + +- **Joystick Deadzone** [mame_joystick_deadzone] (0.00 to 1.00 in steps of 0.05, **0.15**) + +- **Joystick Saturation** [mame_joystick_saturation] (0.05 to 1.00 in steps of 0.05, **0.85**) + +- **Joystick Threshold** [mame_joystick_threshold] (0.05 to 1.00 in steps of 0.05, **0.30**) + +- **Joystick 4-way Simulation** [mame_mame_4way_enable] (**disabled**|4way|strict|qbert) + +- **Profile Buttons Per Game** [mame_buttons_profiles] (**disabled**|enabled) + +- **Mouse** [mame_mouse_enable] (disabled|**enabled**) + +- **Lightgun Mode** [mame_lightgun_mode] (**None**|Lightgun|Touchscreen) + +- **Lightgun Offscreen Position** [mame_lightgun_offscreen_mode] (**Free**|Fixed (Top Left)|Fixed (Bottom Right)) + +#### Video + +Configure video options. + +- **Screen Rotation Mode** [mame_rotation_mode] (**Libretro**|Internal|TATE-ROL|TATE-ROR|None) + +- **Alternate Renderer** [mame_alternate_renderer] (**disabled**|enabled|Cropped) + +- **Alternate Renderer Resolution** [mame_altres] (640x360|**640x480**|800x450|800x600|960x540|960x720|1024x576|1024x768|1280x720|1280x960|1600x900|1600x1200|1440x1080|1920x1080|1920x1440|2560x1440|2880x2160|3840x2160) + +#### Emulation Hacks + +Configure emulation hack options. + +- **Main CPU Overclock %** [mame_cpu_overclock] (**Default (100%)**|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31|32|33|34|35|36|37|38|39|40|41|42|43|44|45|46|47|48|49|50|51|52|53|54|55|60|65|70|75|80|85|90|95|100|105|110|115|120|125|130|135|140|145|150|155|160|165|170|175|180|185|190|195|200|205|210|215|220|225|230|235|240|245|250|255|260|265|270|275|280|285|290|295|300|305|310|315|320|325|330|335|340|345|350|355|360|365|370|375|380|385|390|395|400) + +- **Sound CPU Overclock %** [mame_cpu_sound_overclock] (**Default (100%)**|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31|32|33|34|35|36|37|38|39|40|41|42|43|44|45|46|47|48|49|50|51|52|53|54|55|60|65|70|75|80|85|90|95|100|105|110|115|120|125|130|135|140|145|150|155|160|165|170|175|180|185|190|195|200|205|210|215|220|225|230|235|240|245|250|255|260|265|270|275|280|285|290|295|300|305|310|315|320|325|330|335|340|345|350|355|360|365|370|375|380|385|390|395|400) + +- **Automatic Load Fast-Forward** [mame_autoloadfastforward] (**disabled**|enabled) + + Experimental feature to automatically fast-forward during CD access. Works with: - Generic SCSI - Sega CD and Neo Geo CD + +- **Coin Limit** [mame_coin_limit] (**disabled**|1|2|3|4|5|6|7|8|9|10|11|12|13|14|15|16|17|18|19|20) + +## Controllers + +The MAME core supports the following device type(s): + +- RetroPad +- Keyboard +- None +- None + +## External Links + +- [MAME Repository](https://github.com/libretro/hbmame-libretro) +- [Report MAME Core Issues Here](https://github.com/libretro/hbmame-libretro/issues) + diff --git a/docs/library/irogb.md b/docs/library/irogb.md new file mode 100644 index 0000000000..ae31541514 --- /dev/null +++ b/docs/library/irogb.md @@ -0,0 +1,63 @@ +# Nintendo - Game Boy / Color (IroGB) + +## Background + +A libretro port of the IroGB Game Boy Color emulator. IroGB is a reasonably accurate CGB emulator core that operates on a clock-cycle-stepped model and passes over 95% of the test cases across three of the most widely used GB/GBC emulator test suites (mooneye/blargg/acid), with improved test coverage yet to come. The project was developed as a passion project, aiming to balance emulation accuracy with practical system requirements. + +The IroGB core has been authored by + +- Alex Sutila/Xuanli Lin + +The IroGB core is licensed under + +- GPLv3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the IroGB core have the following file extensions: + +- .gb +- .gbc +- .zip + +RetroArch database(s) that are associated with the IroGB core: + +- [Nintendo - Game Boy](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Game%20Boy.rdb) +- [Nintendo - Game Boy Color](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Game%20Boy%20Color.rdb) + +## Features + +Frontend-level settings or features that the IroGB core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✔ | +| Rewind | ✔ | +| Netplay | ✔ | +| Core Options | ✔ | + +### Directories + +The IroGB core's library name is 'IroGB' + +## Core options + +The IroGB core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Select which BIOS to use (if available).** [irogb_bios] (**Auto**|DMG BIOS|CGB BIOS|Skip BIOS) + +- **Disable re-coloring of DMG games (only applicable with CGB BIOS)** [irogb_monochrome_dmg] (enabled|**disabled**) + +## Controllers + +The IroGB core supports the following device type(s): + +- Game Boy Joypad + +## External Links + +- [IroGB Repository](https://github.com/AlexSutila/IroGB) +- [Report IroGB Core Issues Here](https://github.com/AlexSutila/IroGB/issues) + diff --git a/docs/library/mame2000.md b/docs/library/mame2000.md new file mode 100644 index 0000000000..cb8629cd10 --- /dev/null +++ b/docs/library/mame2000.md @@ -0,0 +1,91 @@ +# Arcade (MAME 2000) + +## Background + +Based on a snapshot of the MAME codebase circa 2000, 'MAME 2000' is compatible with the MAME 0.37b5 ROM set, which was used in the popular iMAME4All port. While this port is the fastest of the libretro cores, it also has the worst accuracy and compatibility, so it should only be used when speed is the utmost concern. If a device can run any of the later snapshots or FBNeo (or even FBA2012), those will all be better choices for most users. + +The MAME 2000 core has been authored by + +- MAMEdev + +The MAME 2000 core is licensed under + +- MAME + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the MAME 2000 core have the following file extensions: + +- .zip +- .ZIP + +RetroArch database(s) that are associated with the MAME 2000 core: + +- [MAME 2000](https://github.com/libretro/libretro-database/blob/master/rdb/MAME%202000.rdb) + +### Romsets + +Romsets must match MAME 0.37b5. The XML DAT describing them is kept in the core's repository: [MAME 0.37b5 XML.dat](https://github.com/libretro/mame2000-libretro/blob/master/metadata/MAME%200.37b5%20XML.dat). + +## Features + +Frontend-level settings or features that the MAME 2000 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✔ | +| Rewind | ✕ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✔ | +| Disk Control | ✕ | + +### Directories + +The MAME 2000 core's library name is 'MAME 2000' + +## Core options + +The MAME 2000 core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Frameskip** [mame2000-frameskip] (**disabled**|auto|threshold) + + Skip rendering frames to keep the audio output in sync when the host cannot run the game at full speed. 'auto' uses the frontend's audio-buffer hint; 'threshold' skips when the audio buffer drops below the percentage configured below. + +- **Frameskip Threshold (%)** [mame2000-frameskip_threshold] (**30**|40|50|60) + + When Frameskip is set to 'threshold', skip a frame whenever the audio output buffer falls below this percentage of full. Lower values skip more aggressively. + +- **Frameskip Interval** [mame2000-frameskip_interval] (**1**|2|3|4|5|6|7|8|9) + + Maximum number of consecutive frames that may be skipped. Lower values keep visual updates smoother at the cost of more audio drops when the host is overloaded. + +- **Skip Disclaimer** [mame2000-skip_disclaimer] (**enabled**|disabled) + + Hide MAME's legal disclaimer screen at game startup. + +- **Show Game Information** [mame2000-show_gameinfo] (**disabled**|enabled) + + Show MAME's driver-status and game-information screens at startup before the game begins running. + +- **Sample rate hint (Restart)** [mame2000-sample_rate] (Auto|Manual|8000|11025|**22050**|32000|44100|48000|96000) + + Output audio sample rate, in Hz. 22050 is the legacy MAME 0.78 default; higher rates increase audio fidelity at the cost of additional CPU. "Auto" asks the frontend for its target rate and rounds to the nearest standard rate, falling back to 48000 if the frontend does not report one. "Manual" currently behaves like "Auto". Changing this value requires a core restart. + +- **Stereo (Restart)** [mame2000-stereo] (**enabled**|disabled) + + Output stereo audio. Disable for slightly lower CPU on games that don't use stereo mixing. Changing this value requires a core restart. + +- **QSound Output Filter** [mame2000-qsound_output_filter] (**disabled**|enabled) + + Run the QSound voice mix through a 95-tap windowed-sinc low-pass FIR (8 kHz cutoff) and per-channel output delay line before sending it to the host. Smooths the upper-band aliasing the 8-bit ROM samples produce on transients and applies the algorithm's slight L/R offset for a wider stereo image. Costs roughly 15-20% extra CPU during active QSound audio. This option is hidden in the menu for games that don't use the QSound sound chip. + +## External Links + +- [MAME 2000 Repository](https://github.com/libretro/mame2000-libretro) +- [Report MAME 2000 Core Issues Here](https://github.com/libretro/mame2000-libretro/issues) + diff --git a/docs/library/mame2015.md b/docs/library/mame2015.md new file mode 100644 index 0000000000..44eba1f89a --- /dev/null +++ b/docs/library/mame2015.md @@ -0,0 +1,79 @@ +# Arcade (MAME 2015) + +## Background + +Based on a snapshot of the MAME codebase circa 2015, 'MAME 2015' is compatible with MAME 0.160 ROM sets. MAME is the most compatible emulator in the world, and it can run almost any game from any platform (though running console games through this core requires additional steps). If your device can run the up-to-date MAME - Current core (or any other newer snapshot) at full speed, most users will have a better experience with that core, while FBNeo is typically a better choice for speed vs accuracy, as long as it supports the game(s) in question. + +The MAME 2015 core has been authored by + +- MAMEdev + +The MAME 2015 core is licensed under + +- MAME + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the MAME 2015 core have the following file extensions: + +- .chd +- .cmd +- .zip +- .7z + +RetroArch database(s) that are associated with the MAME 2015 core: + +- [MAME 2015](https://github.com/libretro/libretro-database/blob/master/rdb/MAME%202015.rdb) + +## Features + +Frontend-level settings or features that the MAME 2015 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✕ | +| Disk Control | ✕ | + +### Directories + +The MAME 2015 core's library name is 'MAME 2015' + +## Core options + +The MAME 2015 core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Read configuration** [mame2015_read_config] (**disabled**|enabled) + +- **Auto save/load states** [mame2015_auto_save] (**disabled**|enabled) + +- **XY device (Restart)** [mame2015_mouse_mode] (**none**|lightgun|mouse) + +- **Enable throttle** [mame2015_throttle] (**disabled**|enabled) + +- **Enable cheats** [mame2015_cheats_enable] (**disabled**|enabled) + +- **Hide nag screen** [mame2015_hide_nagscreen] (**disabled**|enabled) + +- **Hide gameinfo screen** [mame2015_hide_infoscreen] (**disabled**|enabled) + +- **Hide warnings screen** [mame2015_hide_warnings] (**disabled**|enabled) + +- **Alternate render method** [mame2015_alternate_renderer] (**disabled**|enabled) + +- **Boot to OSD** [mame2015_boot_to_osd] (**disabled**|enabled) + +- **Boot from CLI** [mame2015_boot_from_cli] (**disabled**|enabled) + +## External Links + +- [MAME 2015 Repository](https://github.com/libretro/mame2015-libretro) +- [Report MAME 2015 Core Issues Here](https://github.com/libretro/mame2015-libretro/issues) + diff --git a/docs/library/mcsoftserve.md b/docs/library/mcsoftserve.md new file mode 100644 index 0000000000..3348997e6f --- /dev/null +++ b/docs/library/mcsoftserve.md @@ -0,0 +1,43 @@ +# McSoftServe + +## Background + +An experimental libretro core for the Taylor C713 soft-serve ice cream machine, popularized by a well-known American fast food chain. Provides an accurate user experience without the need for firmware dumps. + +The mcsoftserve core has been authored by + +- Jesse Talavera + +The mcsoftserve core is licensed under + +- MIT + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +The mcsoftserve core can also be started without content. + +## Features + +Frontend-level settings or features that the mcsoftserve core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✕ | +| Subsystem | ✕ | + +## Core options + +The mcsoftserve core has no core options. + +## External Links + +- [mcsoftserve Repository](https://github.com/JesseTG/McSoftServe) +- [Report mcsoftserve Core Issues Here](https://github.com/JesseTG/McSoftServe/issues) + diff --git a/docs/library/mednafen_pce.md b/docs/library/mednafen_pce.md new file mode 100644 index 0000000000..482344e067 --- /dev/null +++ b/docs/library/mednafen_pce.md @@ -0,0 +1,233 @@ +# NEC - PC Engine / SuperGrafx / CD (Beetle PCE) + +## Background + +A PC Engine (PCE) core forked from Mednafen's PCE-Accurate emulator, this core is a bit slower than the Fast core, but it is also more accurate, with support for a few extra games that are broken on the Fast core. In addition to PCE, PCE-CD, TurboGrafx 16 and TurboGrafx 16 CD, this core also differs from the Fast version in its support for the SuperGrafx console. + +The Beetle PCE core has been authored by + +- Mednafen Team + +The Beetle PCE core is licensed under + +- GPLv2 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Beetle PCE core have the following file extensions: + +- .pce +- .sgx +- .cue +- .ccd +- .chd +- .toc +- .m3u + +RetroArch database(s) that are associated with the Beetle PCE core: + +- [NEC - PC Engine SuperGrafx](https://github.com/libretro/libretro-database/blob/master/rdb/NEC%20-%20PC%20Engine%20SuperGrafx.rdb) +- [NEC - PC Engine - TurboGrafx 16](https://github.com/libretro/libretro-database/blob/master/rdb/NEC%20-%20PC%20Engine%20-%20TurboGrafx%2016.rdb) +- [NEC - PC Engine CD - TurboGrafx-CD](https://github.com/libretro/libretro-database/blob/master/rdb/NEC%20-%20PC%20Engine%20CD%20-%20TurboGrafx-CD.rdb) + +## Features + +Frontend-level settings or features that the Beetle PCE core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✔ | +| Rewind | ✔ | +| Netplay | ✔ | +| Core Options | ✔ | + +### Directories + +The Beetle PCE core's library name is 'Beetle PCE' + +## Core options + +The Beetle PCE core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +#### Video + +Configure aspect ratio, display cropping and other image output parameters. + +- **Color Palette** [pce_palette] (**RGB**|Composite) + + Composite tries to recreate the original console output and can show more details in some games. + +- **Aspect Ratio** [pce_aspect_ratio] (**Auto**|6:5|4:3|Uncorrected) + + Choose the preferred content aspect ratio. This will only apply when RetroArch's aspect ratio is set to 'Core provided' in the Video settings. + +- **Resolution Scaling** [pce_scaling] (**Auto**|Low Resolution|High Resolution) + + 'Auto' will allow the resolution to change. 'Low Resolution' can crush pixels. 'High Resolution' will stay on the maximum width. + +- **High Resolution Blending Strength** [pce_hires_blend] (**disabled**|1|2|3|4|5|6|7|8) + + Blend pixels together when in High Resolution mode. Higher values will blur the picture more. + +- **Show Horizontal Overscan** [pce_h_overscan] (**Auto**|disabled|enabled) + + 'Auto' will try to adapt to games, cropping empty areas. + +- **Initial Scanline** [pce_initial_scanline] (0|1|2|**3 (Default)**|4|5|6|7|8|9|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31|32|33|34|35|36|37|38|39|40) + + First rendered scanline. Higher values will crop the top of the image. + +- **Last Scanline** [pce_last_scanline] (208|209|210|211|212|213|214|215|216|217|218|219|220|221|222|223|224|225|226|227|228|229|230|231|232|233|234|235|236|237|238|239|240|241|**242 (Default)**) + + Last rendered scanline. Lower values will crop the bottom of the image. + +#### Audio + +Configure emulated audio devices. + +- **PSG Audio Chip (Restart Required)** [pce_psgrevision] (HuC6280|**HuC6280A**|Auto) + + HuC6280 represents the original PC Engine, HuC6280A the SuperGrafx and CoreGrafx I. + +- **Owl Resampler Quality** [pce_resamp_quality] (**0**|1|2|3 (Default)|4|5|6) + + Higher values give better signal-to-noise ratio and preservation of higher frequencies but increase the computation cost and may cause higher latency and clipping if the volume is set too high. + +- **Show Advanced Input/Turbo Settings** [pce_show_advanced_input_settings] (enabled|**disabled**) + + Show Multitap, Mouse, Turbo Buttons and advanced parameters. NOTE: You may need to go back in game and re-enter the menu to refresh the list. + +#### Input + +Configure light gun, mouse and controller input. + +- **Mouse Sensitivity** [pce_mouse_sensitivity] (0.125|0.250|0.375|0.500|0.625|0.750|0.875|1.000|1.125|**1.25**|1.50|1.75|2.00|2.25|2.50|2.75|3.00|3.25|3.50|3.75|4.00|4.25|4.50|4.75|5.00) + + Higher values will make the mouse cursor move faster. + +- **Allow Opposing Directions** [pce_up_down_allowed] (**disabled**|enabled) + + Enabling this will allow pressing / quickly alternating / holding both left and right (or up and down) directions at the same time. This may cause movement-based glitches. + +- **Disable Soft Reset (RUN+SELECT)** [pce_disable_softreset] (**disabled**|enabled) + + When RUN and SELECT are pressed simultaneously, disable both buttons temporarily instead of resetting. + +- **Multitap 5-port Controller** [pce_multitap] (**enabled**|disabled) + + Enable up to 5-player multitap emulation. Disabling this is only needed in some cases (e.g. Cho Aniki). + +- **P1 Default Joypad Type** [pce_default_joypad_type_p1] (**2 Buttons**|6 Buttons) + + Choose if port 1 joypad should be 2 or 6 buttons by default. This option is only applied when the core starts, if you want to switch while content is running, use the 'Mode Switch' button. NOTE: 6 buttons joypad can have weird behaviors in non compatible games. + +- **P2 Default Joypad Type** [pce_default_joypad_type_p2] (**2 Buttons**|6 Buttons) + + Choose if port 2 joypad should be 2 or 6 buttons by default. This option is only applied when the core starts, if you want to switch while content is running, use the 'Mode Switch' button. NOTE: 6 buttons joypad can have weird behaviors in non compatible games. + +- **P3 Default Joypad Type** [pce_default_joypad_type_p3] (**2 Buttons**|6 Buttons) + + Choose if port 3 joypad should be 2 or 6 buttons by default. This option is only applied when the core starts, if you want to switch while content is running, use the 'Mode Switch' button. NOTE: 6 buttons joypad can have weird behaviors in non compatible games. + +- **P4 Default Joypad Type** [pce_default_joypad_type_p4] (**2 Buttons**|6 Buttons) + + Choose if port 4 joypad should be 2 or 6 buttons by default. This option is only applied when the core starts, if you want to switch while content is running, use the 'Mode Switch' button. NOTE: 6 buttons joypad can have weird behaviors in non compatible games. + +- **P5 Default Joypad Type** [pce_default_joypad_type_p5] (**2 Buttons**|6 Buttons) + + Choose if port 5 joypad should be 2 or 6 buttons by default. This option is only applied when the core starts, if you want to switch while content is running, use the 'Mode Switch' button. NOTE: 6 buttons joypad can have weird behaviors in non compatible games. + +- **Turbo Hotkey Mode** [pce_Turbo_Toggling] (**disabled**|Toggle|Dedicated) + + Enable turbo buttons. Hotkeys (buttons III and IV) can behave as either toggle switches or dedicated (hold to use) turbo buttons. + +- **Alternate Turbo Hotkey** [pce_turbo_toggle_hotkey] (**disabled**|enabled) + + Assign RetroPad's L3/R3 buttons as turbo hotkeys instead of buttons III and IV. Works only in 'Toggle' mode and only as long as nothing is assigned to the L3/R3 buttons. You can avoid remapping buttons III and IV when switching to 6-button controller mode with this. + +- **Turbo Speed** [pce_Turbo_Delay] (**Fast**|Medium|Slow) + + Choose how fast button presses are repeated. + +- **P1 Turbo I** [pce_p0_turbo_I_enable] (**disabled**|enabled) + +- **P1 Turbo II** [pce_p0_turbo_II_enable] (**disabled**|enabled) + +- **P2 Turbo I** [pce_p1_turbo_I_enable] (**disabled**|enabled) + +- **P2 Turbo II** [pce_p1_turbo_II_enable] (**disabled**|enabled) + +- **P3 Turbo I** [pce_p2_turbo_I_enable] (**disabled**|enabled) + +- **P3 Turbo II** [pce_p2_turbo_II_enable] (**disabled**|enabled) + +- **P4 Turbo I** [pce_p3_turbo_I_enable] (**disabled**|enabled) + +- **P4 Turbo II** [pce_p3_turbo_II_enable] (**disabled**|enabled) + +- **P5 Turbo I** [pce_p4_turbo_I_enable] (**disabled**|enabled) + +- **P5 Turbo II** [pce_p4_turbo_II_enable] (**disabled**|enabled) + +#### PC Engine CD + +Configure settings related to the PC Engine CD emulation. + +- **CD Image Cache (Restart Required)** [pce_cdimagecache] (**disabled**|enabled) + + Load the complete image into memory at startup. Can potentially decrease loading times at the cost of an increased startup time. + +- **CD Bios (Restart Required)** [pce_cdbios] (Games Express|System Card 1|System Card 2|**System Card 3**|System Card 2 US|System Card 3 US) + + Most games can run on 'System Card 3'. 'Games Express' is needed for several unlicensed games. + +- **Arcade Card (Restart Required)** [pce_arcadecard] (**enabled**|disabled) + + Leave this option enabled to allow enhanced modes of ACD-enhanced SCD games. + +- **CD Speed** [pce_cdspeed] (**1**|2|4|8) + + Higher values enable faster loading times but can cause issues with a couple of games. + +- **ADPCM precision** [pce_adpcmextraprec] (**10-bit**|12-bit) + + Full precision of 12-bits for the MSM5205 ADPCM predictor can reduce whining noise during ADPCM playback. + +- **ADPCM Volume %** [pce_adpcmvolume] (0 to 200 in steps of 10, **100**) + + Setting this volume control too high may cause sample clipping. + +- **CDDA Volume %** [pce_cddavolume] (0 to 200 in steps of 10, **100**) + + Setting this volume control too high may cause sample clipping. + +- **CD PSG Volume %** [pce_cdpsgvolume] (0 to 200 in steps of 10, **100**) + + Setting this volume control too high may cause sample clipping. + +#### Emulation Hacks + +Configure processor overclocking and emulation accuracy parameters affecting low-level performance and compatibility. + +- **No Sprite Limit** [pce_nospritelimit] (**disabled**|enabled) + + Remove 16-sprites-per-scanline hardware limit. WARNING: May cause graphics glitching on some games (such as Bloody Wolf). + +- **CPU Overclock Multiplier** [pce_ocmultiplier] (**1**|2|3|4|5|6|7|8|9|10|20|30|40|50) + + Higher values can reduce slowdowns in games. WARNING: Can cause glitches and crashes. + +## Controllers + +The Beetle PCE core supports 5 port(s). Each can be set to one of the following device types: + +- PCE Joypad +- PCE Mouse + +## External Links + +- [Beetle PCE Repository](https://github.com/libretro/beetle-pce-libretro) +- [Report Beetle PCE Core Issues Here](https://github.com/libretro/beetle-pce-libretro/issues) + diff --git a/docs/library/mednafen_supafaust.md b/docs/library/mednafen_supafaust.md new file mode 100644 index 0000000000..dc2cfe3add --- /dev/null +++ b/docs/library/mednafen_supafaust.md @@ -0,0 +1,97 @@ +# Nintendo - SNES / SFC (Beetle Supafaust) + +## Background + +A port of Mednafen's Supafaust SNES emulator to libretro. This core is designed to be very fast and reasonably accurate. It is fastest on ARM hardware but should be quite speedy on typical x86 machines, as well. It is a very complete port, with support for many libretro features, including frontend features that depend on stable, deterministic savestates. + +The Beetle Supafaust core has been authored by + +- Mednafen team + +The Beetle Supafaust core is licensed under + +- GPLv2+ + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Beetle Supafaust core have the following file extensions: + +- .smc +- .swc +- .sfc +- .fig + +RetroArch database(s) that are associated with the Beetle Supafaust core: + +- [Nintendo - Super Nintendo Entertainment System](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Super%20Nintendo%20Entertainment%20System.rdb) + +## Features + +Frontend-level settings or features that the Beetle Supafaust core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✔ | +| States | ✔ | +| Rewind | ✔ | +| Netplay | ✔ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✔ | +| RetroArch Cheats | ✔ | +| Controls | ✔ | +| Subsystem | ✕ | +| Disk Control | ✕ | + +### Directories + +The Beetle Supafaust core's library name is 'Beetle Supafaust' + +## Core options + +The Beetle Supafaust core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Pixel format** [supafaust_pixel_format] (**rgb565**|xrgb8888|0rgb1555) + +- **Correct pixel aspect ratio** [supafaust_correct_aspect] (**enabled**|disabled|force_ntsc|force_pal) + +- **Horizontal blend/double filter** [supafaust_h_filter] (**phr256blend_auto512**|phr256blend_512|512_blend|512|phr256blend) + +- **Deinterlacer** [supafaust_deinterlacer] (**bob_offset**|weave|blend) + +- **First displayed scanline in NTSC mode** [supafaust_slstart] (0 to 16 in steps of 1, **0**) + +- **Last displayed scanline in NTSC mode** [supafaust_slend] (223 to 207 in steps of -1, **223**) + +- **First displayed scanline in PAL mode** [supafaust_slstartp] (0 to 24 in steps of 1, **0**) + +- **Last displayed scanline in PAL mode** [supafaust_slendp] (238 to 214 in steps of -1, **238**) + +- **Region/Type of SNES to emulate** [supafaust_region] (**auto**|ntsc|pal|ntsc_lie_auto|pal_lie_auto|ntsc_lie_pal|pal_lie_ntsc) + +- **Begin frame in SNES VBlank to lower latency** [supafaust_frame_begin_vblank] (**enabled**|disabled) + +- **Enable 1-frame run-ahead** [supafaust_run_ahead] (**disabled**|video|video+audio) + +- **Enable multitap** [supafaust_multitap] (**disabled**|port1|port2|port1+port2) + +- **CX4 clock rate %** [supafaust_cx4_clock_rate] (**100**|125|150|175|200|250|300|400|500) + +- **SuperFX clock rate %** [supafaust_superfx_clock_rate] (**100**|125|150|175|200|250|300|400|500|95) + +- **Emulate SuperFX instruction cache** [supafaust_superfx_icache] (**disabled**|enabled) + +- **Internal resampler(output rate)** [supafaust_audio_rate] (**disabled**|44100|48000|96000) + +- **Emulation thread affinity mask** [supafaust_thread_affinity_emu] (**0x2**|0x0|0x1|0x3|0x4|0x5|0x6|0x7|0x8|0x9|0xa|0xb|0xc|0xd|0xe|0xf) + +- **PPU render thread affinity mask** [supafaust_thread_affinity_ppu] (**0x1**|0x0|0x2|0x3|0x4|0x5|0x6|0x7|0x8|0x9|0xa|0xb|0xc|0xd|0xe|0xf) + +- **PPU renderer** [supafaust_renderer] (**mt**|st) + +## External Links + +- [Beetle Supafaust Repository](https://github.com/libretro/supafaust) +- [Report Beetle Supafaust Core Issues Here](https://github.com/libretro/supafaust/issues) + diff --git a/docs/library/mesen2.md b/docs/library/mesen2.md new file mode 100644 index 0000000000..df2040dddc --- /dev/null +++ b/docs/library/mesen2.md @@ -0,0 +1,462 @@ +# Nintendo - NES / FC / FDS / SNES / SFC / GB / GBC / GBA / NEC - PCE / PCE-CD / Sega - SMS / GG / Bandai - Wswan (MesenCE) + +## Background + +A port of MesenCE to the libretro API. This emulator is a combined effort of the original author, Sour, and the NESdev community. It is extremely accurate and covers a ton of great home gaming consoles. It even handles Super Game Boy through the libretro 'subsystem' mechanic. + +The Mesen2 core has been authored by + +- M. Bibaud (aka Sour) and NESdev community + +The Mesen2 core is licensed under + +- GPLv3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Mesen2 core have the following file extensions: + +- .nes +- .fds +- .unf +- .unif +- .sfc +- .smc +- .gb +- .gbc +- .gba +- .pce +- .sgx +- .cue +- .sms +- .gg +- .ws +- .wsc + +RetroArch database(s) that are associated with the Mesen2 core: + +- [Nintendo - Super Nintendo Entertainment System](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Super%20Nintendo%20Entertainment%20System.rdb) +- [Nintendo - Satellaview](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Satellaview.rdb) +- [Nintendo - Game Boy](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Game%20Boy.rdb) +- [Nintendo - Game Boy Color](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Game%20Boy%20Color.rdb) +- [Nintendo - Game Boy Advance](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Game%20Boy%20Advance.rdb) +- [Bandai - WonderSwan](https://github.com/libretro/libretro-database/blob/master/rdb/Bandai%20-%20WonderSwan.rdb) +- [Bandai - WonderSwan Color](https://github.com/libretro/libretro-database/blob/master/rdb/Bandai%20-%20WonderSwan%20Color.rdb) +- [NEC - PC Engine SuperGrafx](https://github.com/libretro/libretro-database/blob/master/rdb/NEC%20-%20PC%20Engine%20SuperGrafx.rdb) +- [NEC - PC Engine - TurboGrafx 16](https://github.com/libretro/libretro-database/blob/master/rdb/NEC%20-%20PC%20Engine%20-%20TurboGrafx%2016.rdb) +- [NEC - PC Engine CD - TurboGrafx-CD](https://github.com/libretro/libretro-database/blob/master/rdb/NEC%20-%20PC%20Engine%20CD%20-%20TurboGrafx-CD.rdb) +- [Nintendo - Nintendo Entertainment System](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Nintendo%20Entertainment%20System.rdb) +- [Nintendo - Family Computer Disk System](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Family%20Computer%20Disk%20System.rdb) + +## Features + +Frontend-level settings or features that the Mesen2 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✔ | +| States | ✔ | +| Rewind | ✔ | +| Netplay | ✔ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✔ | +| RetroArch Cheats | ✔ | +| Controls | ✔ | +| Subsystem | ✔ | +| Disk Control | ✕ | + +### Directories + +The Mesen2 core's library name is 'Mesen2' + +## Core options + +The Mesen2 core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +#### System + +System settings (region, RAM, overclock) + +- **Region** [mesen_region] (**Auto**|NTSC|PAL|Dendy) + + Select NES region + +- **RAM Power-On State** [mesen_ramstate] (**All 0s**|All 1s|Random) + + Default power-on state for RAM + +- **Overclock** [mesen_overclock] (**None**|Low|Medium|High|Very High) + + Overclock the NES CPU + +- **Overclock Type** [mesen_overclock_type] (**Before NMI**|After NMI) + + When to apply overclock + +- **FDS Auto Insert** [mesen_fdsautoinsertdisk] (**Off**|On) + + Automatically insert disks on FDS games + +- **FDS Fast Forward** [mesen_fdsfastforwardload] (**Off**|On) + + Fast forward while FDS is loading + +- **Allow Invalid Input** [mesen_allow_invalid_input] (**Off**|On) + + Allow invalid input combinations + +- **Randomize Mapper Power-On** [mesen_randomize_mapper_power_on_state] (**Off**|On) + + Randomize mapper power-on state (for testing) + +- **Randomize CPU/PPU Alignment** [mesen_randomize_cpu_ppu_alignment] (**Off**|On) + + Randomize CPU/PPU alignment (for testing) + +- **Disable Frame Skipping** [mesen_snes_disable_frame_skipping] (**Off**|On) + + Disable SNES frame skipping + +- **Strict Board Mappings** [mesen_snes_enable_strict_board_mappings] (**Off**|On) + + Use strict SNES board mappings + +- **Randomize Power-On** [mesen_snes_randomize_power_on_state] (**Off**|On) + + Randomize the SNES power-on state + +- **Game Boy Model** [mesen_gameboy_model] (Auto (Best)|**Auto (GBC)**|Auto (SGB)|Auto (GB)|Game Boy|Game Boy Color|Super Game Boy) + + Select the Game Boy model to emulate + +- **Skip Boot Screen** [mesen_gba_skip_boot_screen] (**Off**|On) + + Skip the GBA boot screen + +- **Disable Frame Skipping** [mesen_gba_disable_frame_skipping] (**Off**|On) + + Disable GBA frame skipping + +- **Save Type** [mesen_gba_save_type] (**Auto Detect**|None|SRAM|EEPROM 512|EEPROM 8192|Flash 64|Flash 128) + + Select the GBA save type + +- **RTC Type** [mesen_gba_rtc_type] (**Auto Detect**|Enabled|Disabled) + + Select the GBA RTC emulation mode + +- **Console Type** [mesen_pce_console_type] (**Auto**|PC Engine|SuperGrafx|TurboGrafx) + + Select the PC Engine console model + +- **CD-ROM Type** [mesen_pce_cdrom_type] (CD-ROM|Super CD-ROM|**Arcade**) + + Select the PCE CD-ROM emulation type + +- **Disable Frame Skipping** [mesen_pce_disable_frame_skipping] (**Off**|On) + + Disable PCE frame skipping + +- **Model** [mesen_ws_model] (**Auto**|Monochrome|Color|SwanCrystal|PocketChallenge) + + Select the WonderSwan model + +#### Video + +Video settings (palette, filters, overscan) + +- **Palette** [mesen_palette] (**Default**|Composite Direct (by FirebrandX)|NES Classic|Nestopia RGB|Original Hardware|PVM Style|Sony CXA2025AS|Unsaturated v6|YUV v3|Wavebeam|Custom) + + Select color palette + +- **NTSC Filter** [mesen_ntsc_filter] (**Disabled**|Composite (Blargg)) + + NTSC video filter + +- **PAL Borders** [mesen_enable_pal_borders] (**Off**|On) + + Show borders in PAL mode + +- **Color Correction** [mesen_snes_color_correction] (**None**|NTSC Black Level|Deep Black Boost) + + Select SNES color correction mode + +- **High-Res Blend Mode** [mesen_snes_high_res_blend_mode] (**None**|Blend All|Blend Even/Odd) + + Select the SNES high-resolution blend mode + +- **Deinterlace Mode** [mesen_snes_deinterlace_mode] (**Weave**|Bob Blend|Bob|Current Field) + + Select the SNES deinterlace mode + +- **Force Fixed Resolution** [mesen_snes_force_fixed_resolution] (**Off**|On) + + Force a fixed SNES resolution + +- **Blend Frames** [mesen_gameboy_blend_frames] (**On**|Off) + + Blend Game Boy frames for a smoother image + +- **Adjust Colors** [mesen_gameboy_adjust_colors] (**On**|Off) + + Enable Game Boy color correction + +- **Hide SGB Borders** [mesen_gameboy_hide_sgb_borders] (**Off**|On) + + Hide Super Game Boy borders + +- **Blend Frames** [mesen_gba_blend_frames] (**On**|Off) + + Blend GBA frames + +- **Adjust Colors** [mesen_gba_adjust_colors] (**On**|Off) + + Enable GBA color correction + +- **Force Fixed Resolution** [mesen_pce_force_fixed_resolution] (**Off**|On) + + Force a fixed pixel resolution + +- **Use SG Palette** [mesen_sms_use_sg_palette] (**Off**|On) + + Use the Sega Game Gear palette + +- **GG Blend Frames** [mesen_sms_gg_blend_frames] (**On**|Off) + + Blend frames on the Game Gear display + +- **Auto Rotate** [mesen_ws_auto_rotate] (**Off**|On) + + Rotate the WonderSwan display automatically + +- **Blend Frames** [mesen_ws_blend_frames] (**Off**|On) + + Blend WonderSwan frames + +- **Adjust Colors** [mesen_ws_lcd_adjust_colors] (**Off**|On) + + Adjust colors for the WonderSwan LCD + +- **Show Icons** [mesen_ws_lcd_show_icons] (**Off**|On) + + Show the WonderSwan status icons + +#### Audio + +Audio settings (filters, channels, sample rate) + +- **Fake Stereo** [mesen_fake_stereo] (**Off**|On) + + Enable fake stereo effect + +- **Reduce Triangle Popping** [mesen_mute_triangle_ultrasonic] (**On**|Off) + + Mute Triangle channel ultrasonic frequencies + +- **Reduce DMC Popping** [mesen_reduce_dmc_popping] (**On**|Off) + + Reduce popping on DMC channel + +- **Swap Duty Cycles** [mesen_swap_duty_cycle] (**Off**|On) + + Swap Square channel duty cycles + +- **Disable Noise Mode** [mesen_disable_noise_mode_flag] (**Off**|On) + + Disable Noise channel mode flag + +- **Sample Rate** [mesen_audio_sample_rate] (48000 Hz|96000 Hz|11025 Hz|22050 Hz|**44100 Hz**) + + Audio output sample rate + +- **Use HuC6280 Audio** [mesen_pce_use_huc6280_audio] (**On**|Off) + + Use the HuC6280 audio engine + +- **FM Audio** [mesen_sms_fm_audio] (**On**|Off) + + Enable FM audio on SMS systems + +- **Audio Mode** [mesen_ws_audio_mode] (**Headphones**|Speakers) + + Select the WonderSwan audio output mode + +#### Enhancements + +Enhancement options (HD packs, sprite limit) + +- **Hide BG Layer 1** [mesen_snes_hide_bg_layer_1] (**Off**|On) + + Hide SNES background layer 1 + +- **Hide BG Layer 2** [mesen_snes_hide_bg_layer_2] (**Off**|On) + + Hide SNES background layer 2 + +- **Hide BG Layer 3** [mesen_snes_hide_bg_layer_3] (**Off**|On) + + Hide SNES background layer 3 + +- **Hide BG Layer 4** [mesen_snes_hide_bg_layer_4] (**Off**|On) + + Hide SNES background layer 4 + +- **Hide Sprites** [mesen_snes_hide_sprites] (**Off**|On) + + Hide SNES sprite rendering + +- **Remove Sprite Limit** [mesen_snes_remove_sprite_limit] (**Off**|On) + + Remove the SNES sprite limit + +- **Disable Background** [mesen_gameboy_disable_background] (**Off**|On) + + Disable Game Boy background rendering + +- **Disable Sprites** [mesen_gameboy_disable_sprites] (**Off**|On) + + Disable Game Boy sprite rendering + +- **Remove Sprite Limit** [mesen_gameboy_remove_sprite_limit] (**Off**|On) + + Remove the Game Boy sprite limit + +- **Disable Sprites** [mesen_gba_disable_sprites] (**Off**|On) + + Disable GBA sprite rendering + +- **Disable Background** [mesen_gba_disable_background] (**Off**|On) + + Disable GBA background rendering + +- **Hide BG Layer 1** [mesen_gba_hide_bg_layer_1] (**Off**|On) + + Hide GBA background layer 1 + +- **Hide BG Layer 2** [mesen_gba_hide_bg_layer_2] (**Off**|On) + + Hide GBA background layer 2 + +- **Hide BG Layer 3** [mesen_gba_hide_bg_layer_3] (**Off**|On) + + Hide GBA background layer 3 + +- **Hide BG Layer 4** [mesen_gba_hide_bg_layer_4] (**Off**|On) + + Hide GBA background layer 4 + +- **Disable Sprites** [mesen_pce_disable_sprites] (**Off**|On) + + Disable sprite rendering on PCE + +- **Disable VDC2 Sprites** [mesen_pce_disable_sprites_vdc2] (**Off**|On) + + Disable VDC2 sprite rendering + +- **Disable Background** [mesen_pce_disable_background] (**Off**|On) + + Disable background rendering on PCE + +- **Disable VDC2 Background** [mesen_pce_disable_background_vdc2] (**Off**|On) + + Disable VDC2 background rendering + +- **Remove Sprite Limit** [mesen_pce_remove_sprite_limit] (**Off**|On) + + Remove the PCE sprite limit + +- **Disable Sprites** [mesen_sms_disable_sprites] (**Off**|On) + + Disable sprite rendering on SMS + +- **Disable Background** [mesen_sms_disable_background] (**Off**|On) + + Disable background rendering on SMS + +- **Remove Sprite Limit** [mesen_sms_remove_sprite_limit] (**Off**|On) + + Remove the SMS sprite limit + +- **Disable Sprites** [mesen_ws_disable_sprites] (**Off**|On) + + Disable WonderSwan sprite rendering + +- **Sprites Enabled** [mesen_sprites_enabled] (**On**|Off) + + Enable sprite rendering + +- **Background Enabled** [mesen_background_enabled] (**On**|Off) + + Enable background rendering + +- **Game Genie Bus Conflicts** [mesen_disable_game_genie_bus_conflicts] (**Off**|On) + + Disable Game Genie bus conflicts + +- **Sprite Limit** [mesen_sprite_limit] (**Normal**|Adaptive|Off) + + 8-sprite scanline limit + +#### Input + +Input controller settings + +- **Turbo Speed** [mesen_controllerturbospeed] (Fast|Very Fast|Disabled|Slow|**Normal**) + + Turbo button speed + +## Controllers + +### Port 1 + +- Auto +- Standard Controller +- Zapper +- Power Pad +- Arkanoid +- SNES Controller +- SNES Mouse + +### Port 2 + +- Auto +- Standard Controller +- Zapper +- Power Pad +- Arkanoid +- SNES Controller +- SNES Mouse + +### Port 3 + +- Auto +- Standard Controller + +### Port 4 + +- Auto +- Standard Controller + +### Port 5 + +- Auto +- Arkanoid +- Ascii Turbo File +- Bandai Hypershot +- Battle Box +- Exciting Boxing +- Family Trainer +- Four Player Adapter +- Hori Track +- Konami Hypershot +- Pachinko +- Partytap +- Oeka Kids Tablet + +## External Links + +- [Mesen2 Repository](https://github.com/libretro/MesenCE) +- [Report Mesen2 Core Issues Here](https://github.com/libretro/MesenCE/issues) + diff --git a/docs/library/mojozork.md b/docs/library/mojozork.md new file mode 100644 index 0000000000..61e5b110c3 --- /dev/null +++ b/docs/library/mojozork.md @@ -0,0 +1,60 @@ +# Infocom Z-Machine (MojoZork) + +## Background + +A Z-Machine emulator for playing text-based interactive fiction. + +The mojozork core has been authored by + +- Ryan C. Gordon + +The mojozork core is licensed under + +- zlib + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the mojozork core have the following file extensions: + +- .dat +- .z1 +- .z3 + +RetroArch database(s) that are associated with the mojozork core: + +- [Infocom - Z-Machine](https://github.com/libretro/libretro-database/blob/master/rdb/Infocom%20-%20Z-Machine.rdb) + +## Features + +Frontend-level settings or features that the mojozork core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✔ | +| Rewind | ✔ | +| Core Options | ✔ | +| RetroArch Cheats | ✕ | + +### Directories + +The mojozork core's library name is 'mojozork' + +## Core options + +The mojozork core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Visual style to use for gameplay** [style] (**Standard**|AppleII|MS-DOS|Commodore-64) + +## Controllers + +The mojozork core supports the following device type(s): + +- Generic game controller + +## External Links + +- [mojozork Repository](https://github.com/icculus/mojozork) +- [Report mojozork Core Issues Here](https://github.com/icculus/mojozork/issues) + diff --git a/docs/library/nekop2.md b/docs/library/nekop2.md new file mode 100644 index 0000000000..5a3cbcc99c --- /dev/null +++ b/docs/library/nekop2.md @@ -0,0 +1,105 @@ +# NEC - PC-98 (Neko Project II) + +## Background + +An emulator for NEC's PC-9801 (aka PC-98) personal computer platform, ported to libretro. This core has been completely superseded by the Neko Project II Kai core. + +The Neko Project II core has been authored by + +- Neko Project II Team + +The Neko Project II core is licensed under + +- MIT + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Neko Project II core have the following file extensions: + +- .d98 +- .zip +- .98d +- .fdi +- .fdd +- .2hd +- .tfd +- .d88 +- .88d +- .hdm +- .xdf +- .dup +- .cmd +- .hdi +- .thd +- .nhd +- .hdd + +RetroArch database(s) that are associated with the Neko Project II core: + +- [NEC - PC-98](https://github.com/libretro/libretro-database/blob/master/rdb/NEC%20-%20PC-98.rdb) + +## Features + +Frontend-level settings or features that the Neko Project II core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✔ | +| Rewind | ✔ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✕ | +| Subsystem | ✕ | +| Disk Control | ✔ | + +### Directories + +The Neko Project II core's library name is 'Neko Project II' + +## Core options + +The Neko Project II core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **PC Model (Restart)** [np2_model] (**VX**|EPSON|VM) + +- **CPU Base Clock (Restart)** [np2_clk_base] (**2.4576 MHz**|1.9968 MHz) + +- **CPU Clock Multiplier (Restart)** [np2_clk_mult] (**4**|5|6|7|8|9|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31|32|1|2|3) + +- **RAM Size (Restart)** [np2_ExMemory] (**2**|3|4|5|6|7|8|9|10|11|12|13|14|15|16|24|32|48|64|1) + +- **Skipline Revisions** [np2_skipline] (**Full 255 lines**|ON|OFF) + +- **Sound Board (Restart)** [np2_SNDboard] (**PC9801-86**|PC9801-26K + 86|PC9801-86 + Chibi-Oto|PC9801-118|Speak Board|Spark Board|Sound Orchestra|Sound Orchestra-V|AMD-98|None|PC9801-14|PC9801-26K) + +- **JastSound** [np2_jast_snd] (**OFF**|ON) + +- **Volume FM** [np2_volume_F] (**64**|68|72|76|80|84|88|92|96|100|104|108|112|116|120|124|128|0|4|8|12|16|20|24|28|32|36|40|44|48|52|56|60) + +- **Volume SSG** [np2_volume_S] (**64**|68|72|76|80|84|88|92|96|100|104|108|112|116|120|124|128|0|4|8|12|16|20|24|28|32|36|40|44|48|52|56|60) + +- **Volume ADPCM** [np2_volume_A] (**64**|68|72|76|80|84|88|92|96|100|104|108|112|116|120|124|128|0|4|8|12|16|20|24|28|32|36|40|44|48|52|56|60) + +- **Volume PCM** [np2_volume_P] (**64**|68|72|76|80|84|88|92|96|100|104|108|112|116|120|124|128|0|4|8|12|16|20|24|28|32|36|40|44|48|52|56|60) + +- **Volume RHYTHM** [np2_volume_R] (**64**|68|72|76|80|84|88|92|96|100|104|108|112|116|120|124|128|0|4|8|12|16|20|24|28|32|36|40|44|48|52|56|60) + +- **Floppy Seek Sound (Restart)** [np2_Seek_Snd] (**OFF**|ON) + +- **Volume Floppy Seek (Restart)** [np2_Seek_Vol] (**80**|84|88|92|96|100|104|108|112|116|120|124|128|0|4|8|12|16|20|24|28|32|36|40|44|48|52|56|60|64|68|72|76) + +- **Volume Beep** [np2_BEEP_vol] (**3**|0|1|2) + +- **Gui Controller** [np2_GUI_controller] (**MOUSE**|JOY0) + +- **Gui Joy0 PAS** [np2_GUIJOY_PAS] (**3**|4|5|1|2) + +## External Links + +- [Neko Project II Repository](https://github.com/libretro/libretro-meowPC98) +- [Report Neko Project II Core Issues Here](https://github.com/libretro/libretro-meowPC98/issues) + diff --git a/docs/library/neocd.md b/docs/library/neocd.md new file mode 100644 index 0000000000..21aad045fd --- /dev/null +++ b/docs/library/neocd.md @@ -0,0 +1,68 @@ +# SNK - Neo Geo CD (NeoCD) + +## Background + +A rewrite of the original NeoCD emulator for SNK's NeoGeo CD console, ported to libretro. This core is intended to improve the accuracy of the original project, while still maintaining full/usable speed on low-powered hardware, such as the Raspberry Pi. It is easier to load games with than some of the other, more complex cores that support the NeoGeo CD platform, such as MAME and FBNeo. + +The NeoCD core has been authored by + +- Elta + +The NeoCD core is licensed under + +- LGPLv3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the NeoCD core have the following file extensions: + +- .cue +- .chd + +RetroArch database(s) that are associated with the NeoCD core: + +- [SNK - Neo Geo CD](https://github.com/libretro/libretro-database/blob/master/rdb/SNK%20-%20Neo%20Geo%20CD.rdb) + +## Features + +Frontend-level settings or features that the NeoCD core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Core Options | ✔ | + +### Directories + +The NeoCD core's library name is 'NeoCD' + +## Core options + +The NeoCD core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +#### System + +- **Console Region** [neocd_region] (**Japan**|USA|Europe) + +- **Per-Game Saves (Restart)** [neocd_per_content_saves] (On|**Off**) + +#### Video + +- **Horizontal Overscan Mask** [neocd_overscan_h] (**8**|4|0|12|16) + +- **Aspect Ratio** [neocd_aspect_ratio] (**1:1 PAR**|45:44 PAR|4:3 DAR) + +#### Advanced + +- **CD Speed Hack** [neocd_cdspeedhack] (On|**Off**) + +- **Skip CD Loading** [neocd_loadskip] (**On**|Off) + +- **CPU Overclock** [neocd_cpu_overclock] (**100%**|110%|125%|150%|200%) + +## External Links + +- [NeoCD Repository](https://github.com/libretro/neocd_libretro) +- [Report NeoCD Core Issues Here](https://github.com/libretro/neocd_libretro/issues) + diff --git a/docs/library/noods.md b/docs/library/noods.md new file mode 100644 index 0000000000..c36b7812a4 --- /dev/null +++ b/docs/library/noods.md @@ -0,0 +1,92 @@ +# Nintendo - DS (NooDS) + +## Background + +Unofficial libretro port of NooDS, the speedy DS emulator + +The NooDS core has been authored by + +- Hydr8gon +- Jonian Guveli + +The NooDS core is licensed under + +- GPLv3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the NooDS core have the following file extensions: + +- .nds +- .gba + +The NooDS core can also be started without content. + +RetroArch database(s) that are associated with the NooDS core: + +- [Nintendo - Nintendo DS](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Nintendo%20DS.rdb) +- [Nintendo - Nintendo DS (Download Play)](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Nintendo%20DS%20(Download%20Play).rdb) + +## Features + +Frontend-level settings or features that the NooDS core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✔ | +| Rewind | ✔ | +| Core Options | ✔ | +| RetroArch Cheats | ✔ | +| Subsystem | ✔ | +| Disk Control | ✕ | + +## Core options + +The NooDS core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Direct Boot** [noods_directBoot] (**enabled**|disabled) + +- **FPS Limiter** [noods_fpsLimiter] (**disabled**|enabled) + +- **Keep ROM in RAM** [noods_romInRam] (**disabled**|enabled) + +- **Threaded 2D** [noods_threaded2D] (**enabled**|disabled) + +- **Threaded 3D** [noods_threaded3D] (**1 Thread**|2 Threads|3 Threads|4 Threads|Disabled) + +- **High Resolution 3D** [noods_highRes3D] (**disabled**|enabled) + +- **Screen Arrangement** [noods_screenArrangement] (**Automatic**|Vertical|Horizontal|Single Screen) + +- **Screen Rotation** [noods_screenRotation] (**Normal**|Rotated Left|Rotated Right) + +- **Screen Sizing** [noods_screenSizing] (**Even**|Enlarge Top|Enlarge Bottom) + +- **Screen Position** [noods_screenPosition] (**Center**|Top|Bottom|Left|Right) + +- **Screen Gap** [noods_screenGap] (**None**|Quarter|Half|Full) + +- **Crop GBA Screen** [noods_gbaCrop] (**enabled**|disabled) + +- **Screen Filter** [noods_screenFilter] (**Nearest**|Upscaled|Linear) + +- **Simulate Ghosting** [noods_screenGhost] (**disabled**|enabled) + +- **Swap Screen Mode** [noods_swapScreenMode] (**Toggle**|Hold) + +- **Touch Mode** [noods_touchMode] (**Auto**|Pointer|Joystick|None) + +- **Show Touch Cursor** [noods_touchCursor] (**enabled**|disabled) + +- **Microphone Input Mode** [noods_micInputMode] (**Silence**|Noise|Microphone) + +- **Microphone Button Mode** [noods_micButtonMode] (**Toggle**|Hold|Always) + +## External Links + +- [NooDS Repository](https://github.com/jonian/libretro-noods) +- [Report NooDS Core Issues Here](https://github.com/jonian/libretro-noods/issues) +- [NooDS Repository](https://github.com/Hydr8gon/NooDS) + diff --git a/docs/library/nuance.md b/docs/library/nuance.md new file mode 100644 index 0000000000..19f9e635ad --- /dev/null +++ b/docs/library/nuance.md @@ -0,0 +1,63 @@ +# VM Labs - NUON (Nuance) + +## Background + +Nuance is a NUON (VM Labs) emulator. NUON was a media-processing architecture embedded in a handful of DVD players (Samsung DVD-N501/N2000, Toshiba SD-2300, RCA DRC-480N) and used to ship a small number of games (Ballistic, Tempest 3000, Merlin Racing, Iron Soldier 3, Freefall 3050 A.D., Space Invaders XL, etc.) on standard DVD discs. The Linux/libretro port adds an OpenGL render path, miniaudio output, FUSE/ISO9660 disc reading, and an asmjit-based 64-bit JIT (x86_64; other architectures run the interpreter) on top of the original Windows codebase. Considered experimental. Games are loaded from raw ISO/BIN/CUE disc images, from CHD, or from individual .run/.cof program files dumped out of the disc filesystem. + +The Nuance core has been authored by + +- Mike Perry +- Carsten Waechter +- WizzardSK + +The Nuance core is licensed under + +- Non-commercial + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Nuance core have the following file extensions: + +- .run +- .cof +- .nuon +- .cd +- .iso +- .img +- .chd + +RetroArch database(s) that are associated with the Nuance core: + +- [VM Labs - NUON](https://github.com/libretro/libretro-database/blob/master/rdb/VM%20Labs%20-%20NUON.rdb) + +## Features + +Frontend-level settings or features that the Nuance core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✕ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✔ | +| Subsystem | ✕ | +| Disk Control | ✕ | + +### Directories + +The Nuance core's library name is 'Nuance' + +## Core options + +The Nuance core has no core options. + +## External Links + +- [Nuance Repository](https://github.com/andkrau/NuanceResurrection) +- [Report Nuance Core Issues Here](https://github.com/andkrau/NuanceResurrection/issues) + diff --git a/docs/library/oberon.md b/docs/library/oberon.md new file mode 100644 index 0000000000..f4d2209d42 --- /dev/null +++ b/docs/library/oberon.md @@ -0,0 +1,42 @@ +# Oberon RISC Emulator + +## Background + +An emulator for the Oberon RISC machine, ported to libretro. Oberon System was designed and implemented in 1990 as an example of a modern, interactive operating system with windows and mouse, and it was designed to be simple and well-structured enough to be published in its entirety for teaching purposes. More information on Oberon is available at the website of its creator, Niklaus Wirth (https://people.inf.ethz.ch/wirth/). + +The Oberon core has been authored by + +- Peter De Wachter +- Emery Hemingway + +The Oberon core is licensed under + +- ISC + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Oberon core have the following file extensions: + +- .dsk + +### Directories + +The Oberon core's library name is 'Oberon' + +## Core options + +The Oberon core has no core options. + +## Controllers + +The Oberon core supports the following device type(s): + +- Keyboard + Mouse + +## External Links + +- [Oberon Repository](https://github.com/libretro/oberon-risc-emu) +- [Report Oberon Core Issues Here](https://github.com/libretro/oberon-risc-emu/issues) + diff --git a/docs/library/omicron.md b/docs/library/omicron.md new file mode 100644 index 0000000000..48b6d80f82 --- /dev/null +++ b/docs/library/omicron.md @@ -0,0 +1,51 @@ +# Omicron + +## Background + +Omicron is an open source game engine for Java built on libGDX and inspired by fantasy consoles: a small API for drawing, sound and input, with no resource management - assets are referred to by number. Games are packaged as .omicron cartridges. The libretro core is the engine's experimental frontend; it starts a JVM through JNI and renders through the frontend's OpenGL or OpenGL ES context, so a Java runtime has to be present on the machine and reachable through JAVA_HOME. Save states and core options are not implemented. + +The Omicron core has been authored by + +- msx80 + +The Omicron core is licensed under + +- Apache-2.0 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Omicron core have the following file extensions: + +- .omicron + +## Features + +Frontend-level settings or features that the Omicron core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✕ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✕ | +| Subsystem | ✕ | +| Disk Control | ✕ | + +### Directories + +The Omicron core's library name is 'Omicron' + +## Core options + +The Omicron core has no core options. + +## External Links + +- [Omicron Repository](https://github.com/libretro/Omicron) +- [Report Omicron Core Issues Here](https://github.com/libretro/Omicron/issues) + diff --git a/docs/library/panda3ds.md b/docs/library/panda3ds.md new file mode 100644 index 0000000000..6c19958782 --- /dev/null +++ b/docs/library/panda3ds.md @@ -0,0 +1,95 @@ +# Nintendo - 3DS (Panda3DS) + +## Background + +Panda3DS is an HLE, red-panda-themed Nintendo 3DS emulator. Panda3DS is still in the early stages of development. + +The Panda3DS core has been authored by + +- Panda3DS Authors (tm) + +The Panda3DS core is licensed under + +- GPLv3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Panda3DS core have the following file extensions: + +- .3ds +- .3dsx +- .elf +- .axf +- .cci +- .cxi +- .app + +RetroArch database(s) that are associated with the Panda3DS core: + +- [Nintendo - Nintendo 3DS](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Nintendo%203DS.rdb) + +## Features + +Frontend-level settings or features that the Panda3DS core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✔ | +| States | ✔ | +| Rewind | ✕ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✔ | +| Controls | ✔ | +| Subsystem | ✕ | +| Disk Control | ✕ | + +## Core options + +The Panda3DS core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. Defaults shown are those of desktop builds. **Enable shader JIT** defaults to disabled on CPUs other than x86-64 and ARM64, and **Use ubershaders** to disabled on Android and Apple platforms. + +- **Enable fastmem** [panda3ds_use_fastmem] (**enabled**|disabled) + +- **Enable shader JIT** [panda3ds_use_shader_jit] (**enabled**|disabled) + +- **Run 3DS shaders on the GPU** [panda3ds_accelerate_shaders] (**enabled**|disabled) + +- **Enable accurate shader multiplication** [panda3ds_accurate_shader_mul] (**disabled**|enabled) + +- **Use ubershaders (No stutter, maybe slower)** [panda3ds_use_ubershader] (**enabled**|disabled) + +- **Enable VSync** [panda3ds_use_vsync] (**enabled**|disabled) + +- **Hash textures (Better graphics, maybe slower)** [panda3ds_hash_textures] (**enabled**|disabled) + +- **System language** [panda3ds_system_language] (**En**|Fr|Es|De|It|Pt|Nl|Ru|Ja|Zh|Ko|Tw) + +- **DSP emulation** [panda3ds_dsp_emulation] (**HLE**|LLE|Null) + +- **Enable audio** [panda3ds_use_audio] (**enabled**|disabled) + +- **Audio volume** [panda3ds_audio_volume] (**100**|0|10|20|40|60|80|90|**100**|120|140|150|180|200) + +- **Mute audio** [panda3ds_mute_audio] (**disabled**|enabled) + +- **Enable AAC audio** [panda3ds_enable_aac] (**enabled**|disabled) + +- **Force shadergen when rendering lights** [panda3ds_ubershader_lighting_override] (**enabled**|disabled) + +- **Light threshold for forcing shadergen** [panda3ds_ubershader_lighting_override_threshold] (**1**|2|3|4|5|6|7|8) + +- **Enable virtual SD card** [panda3ds_use_virtual_sd] (**enabled**|disabled) + +- **Write protect virtual SD card** [panda3ds_write_protect_virtual_sd] (**disabled**|enabled) + +- **Battery percentage** [panda3ds_battery_level] (**5**|10|20|30|50|70|90|100) + +- **Charger plugged** [panda3ds_use_charger] (**enabled**|disabled) + +## External Links + +- [Panda3DS Repository](https://github.com/wheremyfoodat/Panda3DS) +- [Report Panda3DS Core Issues Here](https://github.com/wheremyfoodat/Panda3DS/issues) + diff --git a/docs/library/parallel_n64.md b/docs/library/parallel_n64.md new file mode 100644 index 0000000000..25e514d8b3 --- /dev/null +++ b/docs/library/parallel_n64.md @@ -0,0 +1,524 @@ +# Nintendo - Nintendo 64 (ParaLLEl N64) + +## Background + +An N64 emulator based originally on Mupen64Plus, but with extensive changes that have caused the codebases to diverge significantly. This core was the first N64 emulator core available for libretro and has served as an experimental testbed for many features that were later included in the Mupen64plus-Next core, including the advanced Vulkan-based ParaLLEl-RDP and ParaLLEl-RSP plugins (hence the name). However, Mupen64plus-Next is a better choice for most users/usecases, and ParaLLEl-N64 mostly exists for further experimentation and for users that cannot run Mupen64plus-Next's GLideN64 plugin at full speed, as this core includes legacy Glide64, glN64 and Rice plugins, which have lower hardware/driver requirements. + +The ParaLLEl N64 core has been authored by + +- Hacktarux +- Mupen64Plus Team +- TinyTiger +- Libretro + +The ParaLLEl N64 core is licensed under + +- GPLv2 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the ParaLLEl N64 core have the following file extensions: + +- .n64 +- .v64 +- .z64 +- .bin +- .u1 +- .ndd +- .zip + +RetroArch database(s) that are associated with the ParaLLEl N64 core: + +- [Nintendo - Nintendo 64](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Nintendo%2064.rdb) +- [Nintendo - Nintendo 64DD](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Nintendo%2064DD.rdb) + +## Features + +Frontend-level settings or features that the ParaLLEl N64 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✔ | +| Rewind | ✔ | +| Core Options | ✔ | + +### Directories + +The ParaLLEl N64 core's library name is 'ParaLLEl N64' + +## Core options + +The ParaLLEl N64 core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Upscaling factor (restart)** [parallel-n64-upscaling] (**1x**|2x|4x|8x) + + Render at a multiple of the console's resolution. ParaLLEl-RDP honours every factor; Angrylion renders at up to 4x and treats 8x as 4x. + +- **Use native texture LOD when upscaling** [parallel-n64-parallel-rdp-native-texture-lod] (enabled|**disabled**) + + Pick texture mip levels as the console would, from a console pixel's footprint rather than an upscaled pixel's. Without it an upscaled render selects sharper levels, and games that use the level as a switch show the wrong image (the painting at the end of the castle corridor in Super Mario 64). Honoured by ParaLLEl-RDP and Angrylion. + +- **CPU Core** [parallel-n64-cpucore] (Cached Interpreter|Pure Interpreter|**Dynamic Recompiler (Ari64)**) + + Select CPU Core + +- **Enable Expansion Pak RAM** [parallel-n64-disable_expmem] (**enabled**|disabled) + + Give the console 8MB of RAM instead of 4MB, as the Expansion Pak does. Games that require the Pak (Donkey Kong 64, Majora's Mask) will not boot with this disabled. Applied when content starts. + +- **GFX Accuracy** [parallel-n64-gfxplugin-accuracy] (low|medium|high|**veryhigh**) + + GFX Accuracy, required restart + +- **Audio Processing** [parallel-n64-send_allist_to_hle_rsp] (**Same as RSP Plugin**|Fast (HLE)|Accurate (LLE)) + + Which RSP runs the audio microcode, independently of the one running graphics. 'Same as RSP Plugin' follows the RSP Plugin setting. 'Fast (HLE)' emulates audio lists at a high level instead of cycle-by-cycle, which is faster but glitches in some games. 'Accurate (LLE)' keeps audio cycle-accurate even when graphics run on the HLE RSP, which is the pairing to use if you want HLE speed for graphics without HLE audio glitches. + +- **Enhanced RSP HLE Audio** [parallel-n64-enhanced-hle-audio] (**disabled**|enabled) + + Replace the audio microcode's four-tap voice interpolator with a windowed-sinc resampler. The microcode's kernel cannot band-limit a sample that is played back faster than it was recorded, so its image folds back into the audible range - the grain and grit on high-pitched sounds. This removes most of that and is slightly less muffled besides. Only affects the HLE RSP audio path. Deliberately not bit-accurate to the hardware, so leave it off if you want the exact output the console produced. + +- **Enhanced RSP HLE Audio Quality** [parallel-n64-enhanced-hle-audio-quality] (16 taps|**32 taps**|64 taps) + + How many taps the enhanced resampler uses. More taps reject more of the folded-back image and cost a little more CPU and memory: 16 taps is already a large improvement over the microcode's four, 32 and 64 taps tighten the filter further. Has no effect unless Enhanced RSP HLE Audio is enabled. + +- **GFX Plugin** [parallel-n64-gfxplugin] (**gliden64**|glide64|gln64|rice|angrylion|parallel) + + Graphics plugin + +- **RSP Plugin** [parallel-n64-rspplugin] (**auto**|hle|cxd4|parallel) + + RSP Plugin + +- **Resolution** [parallel-n64-screensize] (320x240|**640x480**|960x720|1280x960|1440x1080|1600x1200|1920x1440|2240x1680|2880x2160|5760x4320) + + Resolution (restart) + +- **Aspect ratio hint** [parallel-n64-aspectratiohint] (**normal**|widescreen) + + Aspect ratio hint (reinit) + +- **VI Refresh (Overclock)** [parallel-n64-virefresh] (**auto**|1500|2200) + + VI Refresh + +- **Boot Device** [parallel-n64-boot-device] (**Default**|64DD IPL) + + Boot Device + +- **64DD Hardware** [parallel-n64-64dd-hardware] (**disabled**|enabled) + + Treat content without a recognised cartridge or disk header as a 64DD disk. Development disks and MAME/SDK dumps carry no header marker; regular cartridges and retail D64 images are identified by their header and unaffected by this setting. + +- **GoldenEye TLB Mapping Hack (Restart)** [parallel-n64-goldeneye-tlb-hack] (**enabled**|disabled) + + Map GoldenEye's demand-paged 0x7F000000 code segment directly onto the ROM, bypassing the game's own TLB pager (ari64 dynarec only). Historically required for GoldenEye to run at all; on desktop-class hosts the accurate path now measures just as fast. Disable for hardware-faithful TLB behaviour or for modified ROMs that relocate the game segment, which the mapping would corrupt. + +- **Unaligned DMA Behaviour** [parallel-n64-allow-unaligned-dma] (**Allow Unaligned**|Force Alignment) + + 'Allow Unaligned' causes minor issues on Taz Express; 'Force Alignment' is accurate to N64, but breaks some romhacks. + +- **Allow Large Roms** [parallel-n64-allow-large-roms] (**Yes**|No) + + Enable support for roms that are larger than 64 MiB. + +- **Save type for unknown ROMs** [parallel-n64-OverrideSaveType] (Do not force savetype|EEPROM (4kB)|EEPROM (16kB)|SRAM|FlashRAM|MemPak|**Guess**) + + Sets the save type used by unknown ROMs + +- **Emulate flashcart SD drive** [parallel-n64-sdcard] (**Disabled**|SummerCart64) + +- **Rollback N64 system clock on savestate load** [parallel-n64-rtc-savestate] (Yes|**No**) + +#### Aleck64 + +Aleck64 arcade dipswitches (only used by Aleck64 MAME romsets). + +- **Test Mode** [parallel-n64-aleck64-testmode] (**disabled**|enabled) + + Boot the arcade board's test menu instead of the game. + +- **Coinage** [parallel-n64-aleck64-coinage] (**1 Coin 1 Credit**|1 Coin 2 Credits|1 Coin 3 Credits|1 Coin 4 Credits|2 Coins 1 Credit|3 Coins 1 Credit|4 Coins 1 Credit|5 Coins 1 Credit) + + Coins needed per credit (Star Soldier, Vivid Dolls, Hi Pai Paradise 1/2). + +- **Difficulty** [parallel-n64-aleck64-difficulty] (**Normal**|Easy|Hard|Hardest) + + Game difficulty (Star Soldier, Vivid Dolls, Hi Pai Paradise 1/2). + +- **Demo Sounds** [parallel-n64-aleck64-demosound] (**enabled**|disabled) + + Play sound in attract mode (Star Soldier, Hi Pai Paradise 1/2). + +- **Language (Star Soldier)** [parallel-n64-aleck64-language] (**English**|Japanese) + + In-game language for Star Soldier: Vanishing Earth. + +- **Players (Star Soldier)** [parallel-n64-aleck64-players] (**3**|4|2|1) + + Number of players supported by the cabinet. + +- **Joystick Type (Star Soldier)** [parallel-n64-aleck64-joystick] (**2D**|3D) + + Cabinet joystick type. + +- **Auto Level (Star Soldier)** [parallel-n64-aleck64-autolevel] (**Normal**|Slow|Fast1|Fast2) + + Auto level speed. + +- **Rapid Fire (Star Soldier)** [parallel-n64-aleck64-rapid] (**disabled**|enabled) + + Enable rapid fire. + +- **Extend (Star Soldier)** [parallel-n64-aleck64-extend] (**30,000,000**|50,000,000|70,000,000|None) + + Score for an extra life. + +- **Lives (Vivid Dolls)** [parallel-n64-aleck64-lives] (**4**|3|2|1) + + Number of lives. + +- **Free Play (Hi Pai Paradise)** [parallel-n64-aleck64-freeplay] (**disabled**|enabled) + + Play without credits. + +- **Allow Continue (Hi Pai Paradise)** [parallel-n64-aleck64-continue] (**disabled**|enabled) + + Allow continuing after a loss. + +- **Kuitan (Hi Pai Paradise)** [parallel-n64-aleck64-kuitan] (**disabled**|enabled) + + Mahjong kuitan rule. + +#### Pak/Controller Options + +Configure Core Pak/Controller Options. + +- **Analog Deadzone** [parallel-n64-astick-deadzone] (0|5|10|**15**|20|25|30) + + Analog Deadzone (percent) + +- **Analog Sensitivity** [parallel-n64-astick-sensitivity] (50|55|60|65|70|75|80|85|90|95|**100**|105|110|115|120|125|130|135|140|145|150|200) + + Analog Sensitivity (percent) + +- **Mouse to Analog Stick** [parallel-n64-mouse-mode] (**Disabled**|Enabled) + + Use mouse input to control the N64 analog stick with player 1. The mouse takes over whenever the real stick is neutral. Useful for FPS games. + +- **Mouse Sensitivity X (percent)** [parallel-n64-mouse-sensitivity-x] (-500|-400|-300|-250|-200|-175|-150|-125|-100|-75|-50|0|50|75|**100**|125|150|175|200|250|300|400|500) + + Horizontal mouse sensitivity. Negative values invert the axis. Set to 0 to disable horizontal movement. + +- **Mouse Sensitivity Y (percent)** [parallel-n64-mouse-sensitivity-y] (-500|-400|-300|-250|-200|-175|-150|-125|**-100**|-75|-50|0|50|75|100|125|150|175|200|250|300|400|500) + + Vertical mouse sensitivity. Negative values invert the axis; the default is negative because positive mouse Y points down. Set to 0 for Doom-like horizontal-only control. + +- **Mouse Left Click** [parallel-n64-mouse-left] (**Z Trigger**|A Button|B Button|L Trigger|R Trigger|Start|C-Up|C-Down|C-Left|C-Right|Disabled) + + Map mouse left click to an N64 button. + +- **Mouse Right Click** [parallel-n64-mouse-right] (**A Button**|B Button|Z Trigger|L Trigger|R Trigger|Start|C-Up|C-Down|C-Left|C-Right|Disabled) + + Map mouse right click to an N64 button. + +- **Mouse Middle Click** [parallel-n64-mouse-middle] (**Disabled**|A Button|B Button|Z Trigger|L Trigger|R Trigger|Start|C-Up|C-Down|C-Left|C-Right) + + Map mouse middle click to an N64 button. + +- **Mouse Wheel Up** [parallel-n64-mouse-wheel-up] (**L Trigger**|R Trigger|A Button|B Button|Z Trigger|Start|C-Up|C-Down|C-Left|C-Right|Disabled) + + Map mouse wheel up to an N64 button. + +- **Mouse Wheel Down** [parallel-n64-mouse-wheel-down] (**R Trigger**|L Trigger|A Button|B Button|Z Trigger|Start|C-Up|C-Down|C-Left|C-Right|Disabled) + + Map mouse wheel down to an N64 button. + +- **Snap Controller Angle** [parallel-n64-astick-snap-angle-active] (**disabled**|enabled) + + Snap analog stick angle to multiples of 45 degrees, to better support circular design controllers that should behave like classic N64 controllers. + +- **Maximum Snap Angle** [parallel-n64-astick-snap-max-angle] (1 to 21 in steps of 1, **15**) + + Maximum deviation from a 45-degree multiple at which snapping is applied (e.g. value of 5 means 85 to 95 degrees are snapped to 90). + +- **Snap Minimum Displacement (%)** [parallel-n64-astick-snap-min-displacement-percent] (0|10|20|30|40|50|60|65|**70**|75|80|85|90|95) + + Percentage of stick displacement from the center required before snapping activates (0 means always). + +- **Player 1 Pak** [parallel-n64-pak1] (**none**|memory|rumble|biosensor) + + Player 1 Pak + +- **Player 2 Pak** [parallel-n64-pak2] (**none**|memory|rumble|biosensor) + + Player 2 Pak + +- **Player 3 Pak** [parallel-n64-pak3] (**none**|memory|rumble|biosensor) + + Player 3 Pak + +- **Player 4 Pak** [parallel-n64-pak4] (**none**|memory|rumble|biosensor) + + Player 4 Pak + +- **Independent C-button Controls** [parallel-n64-alt-map] (**disabled**|enabled) + + Independent C-button Controls + +#### ParaLLEl + +Configure ParaLLEl Options. + +- **ParaLLEl Synchronous RDP** [parallel-n64-parallel-rdp-synchronous] (**enabled**|disabled) + + Make the CPU wait for the GPU to finish rendering at RDP full sync. Disabling can improve performance but breaks games that read rendered frames back from memory (e.g. Resident Evil 2 never starts its intro FMV); such games force this on automatically. + +- **Crop pixel border pixels** [parallel-n64-parallel-rdp-overscan] (0 to 64 in steps of 2, **0**) + + Crop pixel border pixels + +- **VI divot filter** [parallel-n64-parallel-rdp-divot-filter] (**enabled**|disabled) + + VI divot filter + +- **VI gamma dither** [parallel-n64-parallel-rdp-gamma-dither] (**enabled**|disabled) + + VI gamma dither + +- **VI AA** [parallel-n64-parallel-rdp-vi-aa] (**enabled**|disabled) + + VI AntiAliasing + +- **VI bilinear** [parallel-n64-parallel-rdp-vi-bilinear] (**enabled**|disabled) + + VI bilinear filtering + +- **VI dither filter** [parallel-n64-parallel-rdp-dither-filter] (**enabled**|disabled) + + VI dither filter + +- **Downsampling** [parallel-n64-parallel-rdp-downscaling] (**disable**|1/2|1/4|1/8) + + Downsampling + +- **Use native resolution for TEX_RECT** [parallel-n64-parallel-rdp-native-tex-rect] (**enabled**|disabled) + + Use native resolution for TEX_RECT + +#### Glide64 + +Configure Glide64 Options. + +- **Texture Filtering** [parallel-n64-filtering] (**automatic**|N64 3-point|bilinear|nearest) + + Texture Filtering + +- **Polygon Offset Factor** [parallel-n64-polyoffset-factor] (-5.0 to 5.0 in steps of 0.5, **-3.0**) + + Polygon Offset Factor + +- **Polygon Offset Units** [parallel-n64-polyoffset-units] (-5.0 to 5.0 in steps of 0.5, **-3.0**) + + Polygon Offset Units + +- **Vertex cache VBO** [parallel-n64-vcache-vbo] (**disabled**|enabled) + + Vertex cache VBO (restart) + +#### Angrylion + +Configure Angrylion Options. + +- **Dithering** [parallel-n64-dithering] (**enabled**|disabled) + + Dithering + +- **VI Overlay** [parallel-n64-angrylion-vioverlay] (**Filtered**|AA+Blur|AA+Dedither|AA only|Unfiltered|Depth|Coverage) + + VI Overlay + +- **Deinterlacing** [parallel-n64-angrylion-deinterlace] (**weave**|bob) + + How interlaced (480i) content is displayed. 'weave' merges both fields (sharp but combs on motion), 'bob' line-doubles the current field (no combing, slight shimmer). Affects 480i games like Kuru Kuru Fever or Hanabi de Doon and hi-res title screens. + +- **Thread sync level** [parallel-n64-angrylion-sync] (**Low**|Medium|High) + + Thread sync level + +- **Multi-threading** [parallel-n64-angrylion-multithread] (off|**all threads**|1|2|3|4|5|6|7|8) + + 'off' renders synchronously on the emulator thread: no worker pool, no command buffering, no thread synchronization. Numeric values use the threaded renderer with that many worker threads ('1' keeps the threaded pipeline with a single worker). 'all threads' uses the host's physical cores, at most 8. Every worker replays the whole command stream, so past 8 the duplicated work outweighs what more workers take off the spans, and a second thread on the same core only adds contention; that is where the list stops. + +- **Hide overscan** [parallel-n64-angrylion-overscan] (**disabled**|enabled) + + Hide overscan + +#### GLideN64 + +Configure GLideN64 Options. + +- **Widescreen Hack** [parallel-n64-gliden64-viewport-hack] (enabled|**disabled**|Steam Deck (16:10)) + + Hack that adjusts the viewport to allow unstretched 16:9 + +- **Native Resolution Factor** [parallel-n64-gliden64-EnableNativeResFactor] (**Disabled**|1x|2x|3x|4x|5x|6x|7x|8x) + + Render at N times the native resolution. + +- **Bilinear filtering mode** [parallel-n64-gliden64-BilinearMode] (3point|**standard**) + + Select a Bilinear filtering method, 3point is the original system specific way. + +- **MSAA level** [parallel-n64-gliden64-MultiSampling] (**0**|2|4|8|16) + + Anti-Aliasing level (0 = disabled). + +- **FXAA** [parallel-n64-gliden64-FXAA] (**0**|1) + + Fast Approximate Anti-Aliasing shader, moderately blur textures (0 = disabled). + +- **LOD Emulation** [parallel-n64-gliden64-EnableLODEmulation] (False|**True**) + + Calculate per-pixel Level Of Details to select texture mip levels and blend them with each other using LOD fraction. + +- **Framebuffer Emulation** [parallel-n64-gliden64-EnableFBEmulation] (False|**True**) + + Frame/depth buffer emulation. Disabling it can shorten input lag for particular games, but also break some special effects. + +- **Copy auxiliary buffers to RDRAM** [parallel-n64-gliden64-EnableCopyAuxToRDRAM] (**False**|True) + + Copy auxiliary buffers to RDRAM (fixes some Game artifacts like Paper Mario Intro). + +- **Color buffer to RDRAM** [parallel-n64-gliden64-EnableCopyColorToRDRAM] (Off|Sync|**DoubleBuffer**|TripleBuffer) + + Color buffer copy to RDRAM (Off will trade compatibility for Performance). + +- **Color buffer from RDRAM** [parallel-n64-gliden64-EnableCopyColorFromRDRAM] (**False**|True) + + Always copy the color buffer from RDRAM, for the titles GLideN64's own CPU-write detection misses. Needs Framebuffer Emulation on. Default off for the performance cost. + +- **Depth buffer to RDRAM** [parallel-n64-gliden64-EnableCopyDepthToRDRAM] (Off|**Software**|FromMem) + + Depth buffer copy to RDRAM (Off will trade compatibility for Performance). + +- **Per-game settings** [parallel-n64-gliden64-GLideN64IniBehaviour] (**late**|early|disabled) + + When to apply GLideN64's built-in per-game settings. 'late' lets them override your choices below, 'early' lets your choices win, 'disabled' ignores them entirely. + +- **Background Mode** [parallel-n64-gliden64-BackgroundMode] (Stripped|**OnePiece**) + + Render backgrounds mode (HLE only). One piece (fast), Stripped (precise). + +- **Hardware per-pixel lighting** [parallel-n64-gliden64-EnableHWLighting] (**False**|True) + + Standard per-vertex lighting when disabled. Slightly different rendering. + +- **Continuous texrect coords** [parallel-n64-gliden64-CorrectTexrectCoords] (**Off**|Auto|Force) + + Make texrect coordinates continuous to avoid black lines between them. + +- **Enable inaccurate texture coordinates** [parallel-n64-gliden64-EnableInaccurateTextureCoordinates] (**False**|True) + + Enables inaccurate texture coordinate calculations. This can improve performance and texture pack compatibility at the cost of accuracy. + +- **Native res. 2D texrects** [parallel-n64-gliden64-EnableNativeResTexrects] (**Disabled**|Unoptimized|Optimized) + + Render 2D texrects in native resolution to fix misalignment between parts of 2D image (example: Mario Kart driver selection portraits). + +- **Less accurate blending mode** [parallel-n64-gliden64-EnableLegacyBlending] (**False**|True) + + Do not use shaders to emulate N64 blending modes. Works faster on slow GPU. Can cause glitches. + +- **GPU shader depth write** [parallel-n64-gliden64-EnableFragmentDepthWrite] (False|**True**) + + Enable writing of fragment depth. Some mobile GPUs do not support it, thus it's optional. Leave enabled. + +- **N64 Depth Compare** [parallel-n64-gliden64-EnableN64DepthCompare] (**Off**|Fast|Compatible) + + Enable N64 depth compare instead of OpenGL standard one. Experimental, Fast mode will have more glitches. + +- **Cache GPU Shaders** [parallel-n64-gliden64-EnableShadersStorage] (False|**True**) + + Use persistent storage for compiled shaders. + +- **Cache Textures** [parallel-n64-gliden64-EnableTextureCache] (False|**True**) + + Save texture cache to hard disk. + +- **Overscan** [parallel-n64-gliden64-EnableOverscan] (**Disabled**|Enabled) + + Crop black borders from the overscan region around the screen. + +- **Overscan Offset (Top)** [parallel-n64-gliden64-OverscanTop] (0 to 50 in steps of 1, **0**) + + Overscan Top Offset. + +- **Overscan Offset (Left)** [parallel-n64-gliden64-OverscanLeft] (0 to 50 in steps of 1, **0**) + + Overscan Left Offset. + +- **Overscan Offset (Right)** [parallel-n64-gliden64-OverscanRight] (0 to 50 in steps of 1, **0**) + + Overscan Right Offset. + +- **Overscan Offset (Bottom)** [parallel-n64-gliden64-OverscanBottom] (0 to 50 in steps of 1, **0**) + + Overscan Bottom Offset. + +- **Texture filter** [parallel-n64-gliden64-txFilterMode] (**None**|Smooth filtering 1|Smooth filtering 2|Smooth filtering 3|Smooth filtering 4|Sharp filtering 1|Sharp filtering 2) + + Select Texture Filtering mode. + +- **Texture Enhancement** [parallel-n64-gliden64-txEnhancementMode] (**None**|As Is|X2|X2SAI|HQ2X|HQ2XS|LQ2X|LQ2XS|HQ4X|2xBRZ|3xBRZ|4xBRZ|5xBRZ|6xBRZ) + + Various Texture Filters ('As-Is' will just cache). + +- **Don't filter background textures** [parallel-n64-gliden64-txFilterIgnoreBG] (False|**True**) + + Ignore filtering for Background Textures. + +- **Use High-Res textures** [parallel-n64-gliden64-txHiresEnable] (**False**|True) + + Enable High-Res Texture packs if available. + +- **Use High-Res Texture Cache Compression** [parallel-n64-gliden64-txCacheCompression] (False|**True**) + + Compress created texture caches. + +- **Use High-Res Full Alpha Channel** [parallel-n64-gliden64-txHiresFullAlphaChannel] (**False**|True) + + This should be enabled unless it's a old RICE Texture pack. + +- **Use alternative method for High-Res Checksums** [parallel-n64-gliden64-EnableHiResAltCRC] (**False**|True) + + Use an alternative method for High-Res paletted textures CRC calculations. + +- **INI Behaviour** [parallel-n64-gliden64-IniBehaviour] (**Prioritize INI over Core Options**|Prioritize Core Options over INI|Disable INI) + + Specifies INI Settings behaviour. This should really only contain essential options. Changing this can and will break ROM's, if the correct options aren't set manually. Some options may only be set via INI (fbInfoDisabled). + +- **Patch SM64 Hacks made with SM64 Editor** [parallel-n64-gliden64-LegacySm64ToolsHacks] (**enabled**|disabled) + + Make plugin behave like Jabo in certain case to fix compatibility with legacy SM64 hacks. It adds undocumented behavior that may interfere with real N64 games (unlikely). + +- **Fix VI Resolution** [parallel-n64-gliden64-RemoveFBBlackBars] (**enabled**|disabled) + + Remove the black bars added by VI emulation of the FrameBuffer. + +## Controllers + +The ParaLLEl N64 core supports 4 port(s). Each can be set to one of the following device types: + +- Controller +- Mouse +- RetroPad +- Analog + +## External Links + +- [ParaLLEl N64 Repository](https://github.com/libretro/parallel-n64) +- [Report ParaLLEl N64 Core Issues Here](https://github.com/libretro/parallel-n64/issues) + diff --git a/docs/library/pcem.md b/docs/library/pcem.md new file mode 100644 index 0000000000..6c6427ca31 --- /dev/null +++ b/docs/library/pcem.md @@ -0,0 +1,69 @@ +# PC (PCem) + +## Background + +A port of the PCem IBM/PC emulator to libretro. This core is still very preliminary and most users will have better luck with the DOSBox-SVN/Pure cores in most cases. + +The PCem core has been authored by + +- PCem Team + +The PCem core is licensed under + +- GPLv2 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the PCem core have the following file extensions: + +- .exe +- .com +- .bat +- .conf + +The PCem core can also be started without content. + +## Features + +Frontend-level settings or features that the PCem core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✕ | +| Rewind | ✕ | + +## Core options + +The PCem core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **CPU Core** [pcem_cpucore] (**interpreter**|dynarec) + +- **Model (restart)** [pcem_model] (**auto**|IBM PC|IBM XT|IBM PCjr|Generic XT clone|AMI XT clone|DTK XT clone|VTech Laser Turbo XT|VTech Laser XT3|Phoenix XT clone|Juko XT clone|Tandy 1000|Tandy 1000 HX|Tandy 1000 SL/2|Amstrad PC1512|Sinclair PC200|Euro PC|Olivetti M24|Amstrad PC1640|Amstrad PC2086|Amstrad PC3086|IBM AT|Commodore PC 30 III|AMI 286 clone|DELL System 200|IBM PS/1 model 2011|Compaq Deskpro 386|Acer 386SX25/N|DTK 386SX clone|Phoenix 386 clone|Amstrad MegaPC|AMI 386 clone|AMI 486 clone|AMI WinBIOS 486|DTK PKM-0038S E-2|Award SiS 496/497|Rise Computer R418|Intel Premiere/PCI|Intel Premiere/PCI II|Intel Advanced/EV|PC Partner MB500N|ASUS P/I-P53TP4XE|Acer M3a|Acer V35N|ASUS P/I-P55T2P4|Award 430VX PCI|Epox P55-VA) + +- **Graphics card (restart)** [pcem_gfxcard] (**auto**|CGA|New CGA|MDA|Hercules|EGA|Compaq EGA|Super EGA|Trident TVGA8900D|Tseng ET4000|Tseng ET4000/W32p (Diamond Stealth 32)|S3 Vision864 (Paradise Bahamas 64)|S3 764/Trio64 (Number Nine 9FX)|S3 Virge|Trident TGUI9440|IBM VGA|Compaq/Paradise VGA|ATI VGA Edge-16|ATI VGA Charger|Oak OTI-067|ATI Graphics Pro Turbo (Mach64)|Cirrus Logic CL-GD5429|S3 Virge/DX|S3 732/Trio32 (Phoenix)|S3 764/Trio64 (Phoenix)|nVidia Riva TNT|Incolor|nVidia Riva 128) + +- **Sound card (restart)** [pcem_sndcard] (**auto**|AdLib (No DSP)|Soundblaster 1 (DSP v1.05)|Soundblaster 1.5 (DSP v2.00)|Soundblaster 2 (DSP v2.01)|Soundblaster Pro (DSP v3.00)|Soundblaster Pro 2 (DSP v3.02 + OPL3)|Soundblaster 16 (DSP v4.05 + OPL3)|AdLib Gold|Windows Sound System|Pro Audio Spectrum 16) + +- **Video timing speed** [pcem_video_timing_speed] (**Slow VLB/PCI**|Mid VLB/PCI|Fast VLB/PCI|8-bit|Slow 16-bit|Fast 16-bit) + +- **Enable overscan** [pcem_overscan_enable] (**disabled**|enabled) + +- **Enable flash** [pcem_flash_enable] (**enabled**|disabled) + +- **CPU Floating Point Unit support (restart)** [pcem_fpu_enabled] (**disabled**|enabled) + +- **Gravis UltraSound audiocard (restart)** [pcem_gus_enabled] (**disabled**|enabled) + +- **SSI 2001 add-on audiocard (restart)** [pcem_ssi2001_enabled] (**disabled**|enabled) + +- **GameBlaster audiocard (restart)** [pcem_gameblaster_enabled] (**disabled**|enabled) + +- **3Dfx Voodoo add-on card (restart)** [pcem_voodoo_enabled] (**disabled**|enabled) + +## External Links + +- [PCem Repository](https://github.com/libretro/libretro-pcem) +- [Report PCem Core Issues Here](https://github.com/libretro/libretro-pcem/issues) + diff --git a/docs/library/pokketstation.md b/docs/library/pokketstation.md new file mode 100644 index 0000000000..80180a0cc5 --- /dev/null +++ b/docs/library/pokketstation.md @@ -0,0 +1,55 @@ +# Sony - PocketStation (pokketstation) + +## Background + +An open-source Sony PocketStation emulator core, written in portable C. It is meant for reuse across a libretro core, a standalone Windows desktop app, and a PS Vita homebrew port. The emulator is stable, broadly tested by the community, and as cycle-accurate as possible. Loads and saves PlayStation memory card dumps. + +The pokketstation core has been authored by + +- mentalfoundry + +The pokketstation core is licensed under + +- GPLv3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the pokketstation core have the following file extensions: + +- .mcr +- .mcs +- .pss +- .mcd +- .bin +- .gme + +RetroArch database(s) that are associated with the pokketstation core: + +- [Sony - PocketStation](https://github.com/libretro/libretro-database/blob/master/rdb/Sony%20-%20PocketStation.rdb) + +## Features + +Frontend-level settings or features that the pokketstation core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✔ | +| States | ✔ | +| Rewind | ✕ | +| RetroArch Cheats | ✔ | + +### Directories + +The pokketstation core's library name is 'pokketstation' + +## Core options + +The pokketstation core has no core options. + +## External Links + +- [pokketstation Repository](https://github.com/mentalfoundry/pokketstation) +- [Report pokketstation Core Issues Here](https://github.com/mentalfoundry/pokketstation/issues) + diff --git a/docs/library/potator.md b/docs/library/potator.md new file mode 100644 index 0000000000..d6603af213 --- /dev/null +++ b/docs/library/potator.md @@ -0,0 +1,68 @@ +# Watara - Supervision (Potator) + +## Background + +The Potator core has been authored by + +- Normmatt +- Cal2 +- infval +- Alekmaul + +The Potator core is licensed under + +- Public Domain + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Potator core have the following file extensions: + +- .bin +- .sv + +RetroArch database(s) that are associated with the Potator core: + +- [Watara - Supervision](https://github.com/libretro/libretro-database/blob/master/rdb/Watara%20-%20Supervision.rdb) + +## Features + +Frontend-level settings or features that the Potator core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✔ | +| Rewind | ✔ | +| Netplay | ✔ | +| Core Options | ✔ | + +### Directories + +The Potator core's library name is 'Potator' + +## Core options + +The Potator core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Internal Palette** [potator_palette] (**Greyscale**|Potator Amber|Potator Green|Potator Blue|Potator BGB|Potator Wataroo|Game Boy DMG|Game Boy Pocket|Game Boy Light|Blossom Pink|Bubbles Blue|Buttercup Green|Digivice|Game.com|GameKing|Game Master|Golden Wild|Greenscale|Hokage Orange|Labo Fawn|Legendary Super Saiyan|Microvision|Million Live Gold|Odyssey Gold|Shiny Sky Blue|Slime Blue|TI-83|Travel Wood|Virtual Boy|TV-Link|TV-Link Inverted) + + Enables colorization of Supervision games. + +- **LCD Ghosting** [potator_lcd_ghosting] (**disabled**|1 Frame|2 Frames|3 Frames|4 Frames|5 Frames|6 Frames|7 Frames|8 Frames) + + Simulates LCD ghosting by blending pixels from multiple successive frames. Can help to alleviate the flickering that is common in Supervision games. + +- **Frameskip** [potator_frameskip] (**disabled**|Auto|Manual) + + Skip frames to avoid audio buffer under-run (crackling). Improves performance at the expense of visual smoothness. 'Auto' skips frames when advised by the frontend. 'Manual' utilises the 'Frameskip Threshold (%)' setting. + +- **Frameskip Threshold (%)** [potator_frameskip_threshold] (15 to 60 in steps of 3, **33**) + + When 'Frameskip' is set to 'Manual', specifies the audio buffer occupancy threshold (percentage) below which frames will be skipped. Higher values reduce the risk of crackling by causing frames to be dropped more frequently. + +## External Links + +- [Potator Repository](https://github.com/libretro/potator) +- [Report Potator Core Issues Here](https://github.com/libretro/potator/issues) + diff --git a/docs/library/qemu.md b/docs/library/qemu.md new file mode 100644 index 0000000000..28280bd35f --- /dev/null +++ b/docs/library/qemu.md @@ -0,0 +1,52 @@ +# QEMU + +## Background + +A port of the QEMU emulator to libretro. + +The QEMU core has been authored by + +- QEMU devs +- io12 + +The QEMU core is licensed under + +- GPLv2 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the QEMU core have the following file extensions: + +- .qemu_cmd_line +- .iso +- .img +- .qcow +- .qcow2 + +## Features + +Frontend-level settings or features that the QEMU core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✕ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✕ | +| Subsystem | ✕ | +| Disk Control | ✕ | + +## Core options + +The QEMU core has no core options. + +## External Links + +- [QEMU Repository](https://github.com/io12/qemu-libretro) +- [Report QEMU Core Issues Here](https://github.com/io12/qemu-libretro/issues) + diff --git a/docs/library/radio.md b/docs/library/radio.md new file mode 100644 index 0000000000..453e60b0ab --- /dev/null +++ b/docs/library/radio.md @@ -0,0 +1,69 @@ +# Internet Radio (Radio) + +## Background + +Streams internet radio stations over the network, and plays local MP3 and WAV files. Stations are read from an .m3u or .txt playlist, with up to 100 presets selectable from the core options; the core also starts with no content at all. Draws a spectrum analyser, oscilloscope, VU meters and other visualisers while it plays. Needs a working network connection for streaming. + +The Radio core has been authored by + +- fpscan +- gadsby + +The Radio core is licensed under + +- MIT + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Radio core have the following file extensions: + +- .m3u +- .txt +- .mp3 +- .wav + +The Radio core can also be started without content. + +## Features + +Frontend-level settings or features that the Radio core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✕ | +| Subsystem | ✕ | +| Disk Control | ✕ | + +### Directories + +The Radio core's library name is 'Radio' + +## Core options + +The Radio core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Active Preset** [radio_station] (**Preset 1**|Preset 2|Preset 3|Preset 4|Preset 5|Preset 6|Preset 7|Preset 8|Preset 9|Preset 10|Preset 11|Preset 12|Preset 13|Preset 14|Preset 15|Preset 16|Preset 17|Preset 18|Preset 19|Preset 20|Preset 21|Preset 22|Preset 23|Preset 24|Preset 25|Preset 26|Preset 27|Preset 28|Preset 29|Preset 30|Preset 31|Preset 32|Preset 33|Preset 34|Preset 35|Preset 36|Preset 37|Preset 38|Preset 39|Preset 40|Preset 41|Preset 42|Preset 43|Preset 44|Preset 45|Preset 46|Preset 47|Preset 48|Preset 49|Preset 50|Preset 51|Preset 52|Preset 53|Preset 54|Preset 55|Preset 56|Preset 57|Preset 58|Preset 59|Preset 60|Preset 61|Preset 62|Preset 63|Preset 64|Preset 65|Preset 66|Preset 67|Preset 68|Preset 69|Preset 70|Preset 71|Preset 72|Preset 73|Preset 74|Preset 75|Preset 76|Preset 77|Preset 78|Preset 79|Preset 80|Preset 81|Preset 82|Preset 83|Preset 84|Preset 85|Preset 86|Preset 87|Preset 88|Preset 89|Preset 90|Preset 91|Preset 92|Preset 93|Preset 94|Preset 95|Preset 96|Preset 97|Preset 98|Preset 99|Preset 100) + +- **Visualizer Mode** [radio_visualizer] (**FFT Spectrum Bars**|LED Pharmacy Grid|Phosphor Oscilloscope|Circular Audio Radar|Analog VU Meters) + +- **Volume Level** [radio_volume] (**80%**|100%|90%|70%|60%|50%|40%|30%|20%|10%|0%) + +- **Auto-Hide UI** [radio_ui_autohide] (**Never**|10 seconds|30 seconds|1 minute|5 minutes) + +- **UI Color Theme** [radio_ui_theme] (**Classic Blue**|Matrix Green|Retro Amber|Synthwave Pink|Cyberpunk Orange) + +- **Visualizer Palette** [radio_vis_palette] (**Neon Cyan-Pink**|Acid Green|Fire & Brimstone|Rainbow Rave|Deep Space Purple) + +## External Links + +- [Radio Repository](https://github.com/fpscan/libretro-radio) +- [Report Radio Core Issues Here](https://github.com/fpscan/libretro-radio/issues) + diff --git a/docs/library/remotejoy.md b/docs/library/remotejoy.md new file mode 100644 index 0000000000..9283d79faf --- /dev/null +++ b/docs/library/remotejoy.md @@ -0,0 +1,37 @@ +# PSP RemotePlay (RemoteJoy) + +## Background + +An old, experimental libretro core designed to stream inputs to/from a Playstation Portable console. It exists only for historical and research purposes and should not be used to actually try to play games. + +The RemoteJoy core has been authored by + +- Themaister + +The RemoteJoy core is licensed under + +- GPLv2 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the RemoteJoy core have the following file extensions: + +- .exe + +The RemoteJoy core can also be started without content. + +### Directories + +The RemoteJoy core's library name is 'RemoteJoy' + +## Core options + +The RemoteJoy core has no core options. + +## External Links + +- [RemoteJoy Repository](https://github.com/libretro/libretro-remotejoy) +- [Report RemoteJoy Core Issues Here](https://github.com/libretro/libretro-remotejoy/issues) + diff --git a/docs/library/retro8.md b/docs/library/retro8.md new file mode 100644 index 0000000000..4f2101674b --- /dev/null +++ b/docs/library/retro8.md @@ -0,0 +1,49 @@ +# PICO-8 (Retro8) + +## Background + +A port of the Retro8 open-source reimplementation of the PICO-8 fantasy console to libretro. This core can load both p8 'cart' files and embedded png images, and much of the PICO-8 API is working with good performance, including basic sound and music, though it is still missing some obscure Lua extension quirks and fixed arithmetic support. + +The retro-8 (alpha) core has been authored by + +- jakz + +The retro-8 (alpha) core is licensed under + +- GPLv3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the retro-8 (alpha) core have the following file extensions: + +- .p8 +- .png + +RetroArch database(s) that are associated with the retro-8 (alpha) core: + +- [PICO-8](https://github.com/libretro/libretro-database/blob/master/rdb/PICO-8.rdb) + +## Features + +Frontend-level settings or features that the retro-8 (alpha) core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✕ | +| Rewind | ✕ | + +### Directories + +The retro-8 (alpha) core's library name is 'retro-8 (alpha)' + +## Core options + +The retro-8 (alpha) core has no core options. + +## External Links + +- [retro-8 (alpha) Repository](https://github.com/libretro/retro8) +- [Report retro-8 (alpha) Core Issues Here](https://github.com/libretro/retro8/issues) + diff --git a/docs/library/romcleaner.md b/docs/library/romcleaner.md new file mode 100644 index 0000000000..36de197eec --- /dev/null +++ b/docs/library/romcleaner.md @@ -0,0 +1,84 @@ +# ROM Cleaner + +## Background + +A utility core for removing dust and dirt from your ROM collection. + +The romcleaner core has been authored by + +- Jesse Talavera + +The romcleaner core is licensed under + +- MIT + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the romcleaner core have the following file extensions: + +- .sfc +- .smc +- .st +- .swc +- .bs +- .cgb +- .dmg +- .gb +- .gbc +- .sgb +- .a52 +- .nes +- .3ds +- .3dsx +- .cart +- .rom +- .sms +- .bms +- .int +- .col +- .cv +- .md +- .mdx +- .smd +- .gen +- .gg +- .sg +- .gba +- .nds +- .lnx +- .lyx +- .pce +- .sgx +- .ws +- .wsc +- .vb +- .vboy +- .n64 +- .z64 +- .v64 +- .vec + +## Features + +Frontend-level settings or features that the romcleaner core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✕ | +| Subsystem | ✕ | + +## Core options + +The romcleaner core has no core options. + +## External Links + +- [romcleaner Repository](https://git.libretro.com/libretro/rom-cleaner) + diff --git a/docs/library/skyemu.md b/docs/library/skyemu.md new file mode 100644 index 0000000000..5d63bed7e4 --- /dev/null +++ b/docs/library/skyemu.md @@ -0,0 +1,77 @@ +# Nintendo - Game Boy/GBA/NDS (SkyEmu) + +## Background + +SkyEmu is a multi-system emulator, supporting Game Boy, Game Boy Color and Nintendo DS cores. + +The SkyEmu core has been authored by + +- Team SkyEmu + +The SkyEmu core is licensed under + +- MIT + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the SkyEmu core have the following file extensions: + +- .gb +- .gbc +- .gba +- .nds + +RetroArch database(s) that are associated with the SkyEmu core: + +- [Nintendo - Nintendo DS](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Nintendo%20DS.rdb) +- [Nintendo - Game Boy](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Game%20Boy.rdb) +- [Nintendo - Game Boy Advance](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Game%20Boy%20Advance.rdb) + +## Features + +Frontend-level settings or features that the SkyEmu core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✔ | +| States | ✔ | +| Rewind | ✔ | +| Netplay | ✔ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✔ | +| RetroArch Cheats | ✔ | +| Controls | ✔ | + +### Directories + +The SkyEmu core's library name is 'SkyEmu' + +## Core options + +The SkyEmu core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +#### System Settings + +- **Core Override** [system_core_override] (**Automatic**|Game Boy|Game Boy Advance|Nintendo DS) + + Determines which core is used + +- **Game Boy Firmware** [system_gb_bios_enable] (**ON**|OFF) + + Game Boy Firmware Enabled + +- **Game Boy Advance Firmware** [system_gba_bios_enable] (**ON**|OFF) + + Game Boy Advance Firmware Enabled + +- **Nintendo DS Firmware** [system_nds_bios_enable] (**ON**|OFF) + + Nintendo DS Firmware Enabled + +## External Links + +- [SkyEmu Repository](https://github.com/skylersaleh/SkyEmu) +- [Report SkyEmu Core Issues Here](https://github.com/skylersaleh/SkyEmu/issues) + diff --git a/docs/library/squirreljme.md b/docs/library/squirreljme.md new file mode 100644 index 0000000000..e7bed75bfd --- /dev/null +++ b/docs/library/squirreljme.md @@ -0,0 +1,55 @@ +# Java ME (SquirrelJME) + +## Background + +A port of the SquirrelJME Java ME 8 Virtual Machine emulator to libretro. Intended to be small, fast and maintain high compatibility, the core also supports older J2ME software and games designed for flip-phones. + +The SquirrelJME core has been authored by + +- Stephanie Gawroriski (Xer Shadow Tail) + +The SquirrelJME core is licensed under + +- MPL-2.0 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the SquirrelJME core have the following file extensions: + +- .jar +- .sqc +- .jam +- .jad +- .kjx +- .adf +- .sec +- .sto +- .sp +- .sp0 +- .sp1 +- .sp2 +- .sp3 +- .sp4 +- .sp5 +- .sp6 +- .sp7 +- .sp8 +- .sp9 + +The SquirrelJME core can also be started without content. + +RetroArch database(s) that are associated with the SquirrelJME core: + +- [J2ME](https://github.com/libretro/libretro-database/blob/master/rdb/J2ME.rdb) + +## Core options + +The SquirrelJME core has no core options. + +## External Links + +- [SquirrelJME Repository](https://github.com/SquirrelJME/SquirrelJME) +- [Report SquirrelJME Core Issues Here](https://github.com/SquirrelJME/SquirrelJME/issues) + diff --git a/docs/library/superbroswar.md b/docs/library/superbroswar.md new file mode 100644 index 0000000000..9f91dd0db3 --- /dev/null +++ b/docs/library/superbroswar.md @@ -0,0 +1,51 @@ +# Super Bros War + +## Background + +A fan-made multiplayer style deathmatch game. + +The Super Bros War core has been authored by + +- Philippe Simons + +The Super Bros War core is licensed under + +- GPLv2 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Super Bros War core have the following file extensions: + +- .game + +## Features + +Frontend-level settings or features that the Super Bros War core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✕ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✕ | +| RetroArch Cheats | ✕ | +| Controls | ✔ | +| Subsystem | ✕ | +| Disk Control | ✕ | + +### Directories + +The Super Bros War core's library name is 'Super Bros War' + +## Core options + +The Super Bros War core has no core options. + +## External Links + +- [Super Bros War Repository](https://github.com/libretro/superbroswar-libretro) +- [Report Super Bros War Core Issues Here](https://github.com/libretro/superbroswar-libretro/issues) + diff --git a/docs/library/tamalibretro.md b/docs/library/tamalibretro.md new file mode 100644 index 0000000000..fe87c2018a --- /dev/null +++ b/docs/library/tamalibretro.md @@ -0,0 +1,59 @@ +# Bandai - Tamagotchi P1 (TamaLIBretro) + +## Background + +A port of the TamaLIB emulator for first-generation Tamagotchi handhelds to libretro. + +The TamaLIBretro core has been authored by + +- Jean-Christophe Rona, Keith Bourdon + +The TamaLIBretro core is licensed under + +- GPL-2.0 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the TamaLIBretro core have the following file extensions: + +- .b +- .rom +- .bin + +## Features + +Frontend-level settings or features that the TamaLIBretro core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✕ | +| States | ✔ | +| Rewind | ✕ | +| Core Options | ✕ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✔ | +| RetroArch Cheats | ✔ | +| Controls | ✔ | +| Subsystem | ✕ | +| Disk Control | ✕ | + +### Directories + +The TamaLIBretro core's library name is 'TamaLIBretro' + +## Core options + +The TamaLIBretro core has no core options. + +## Controllers + +The TamaLIBretro core supports the following device type(s): + +- Tamagotchi + +## External Links + +- [TamaLIBretro Repository](https://github.com/celerizer/tamalibretro) +- [Report TamaLIBretro Core Issues Here](https://github.com/celerizer/tamalibretro/issues) + diff --git a/docs/library/vitaquake2.md b/docs/library/vitaquake2.md new file mode 100644 index 0000000000..562d162534 --- /dev/null +++ b/docs/library/vitaquake2.md @@ -0,0 +1,216 @@ +# Quake II (vitaQuake 2) + +## Background + +A port of the VitaQuake 2 source port of iD's Quake 2 engine to libretro. There is a separate core for each of the Quake 2 mission packs, 'Rogue', 'Zaero' and 'Xatrix'. This core is for the main game. This core loads games in the *.pak format. + +The vitaQuakeII core has been authored by + +- Rinnegatamante + +The vitaQuakeII core is licensed under + +- GPLv2 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the vitaQuakeII core have the following file extensions: + +- .pak + +RetroArch database(s) that are associated with the vitaQuakeII core: + +- [Quake II](https://github.com/libretro/libretro-database/blob/master/rdb/Quake%20II.rdb) + +## Features + +Frontend-level settings or features that the vitaQuakeII core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✔ | + +### Directories + +The vitaQuakeII core's library name is 'vitaQuakeII' + +## Core options + +The vitaQuakeII core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Internal Resolution (Restart)** [vitaquakeii_resolution] (320x240|400x240|480x272|512x384|640x368|640x480|720x408|800x600|**960x544**|1024x768|1280x720|1280x800|1280x1024 (OpenGL Only)|1360x768|1366x768|1440x900|1600x900|1680x1050|1920x1080|1920x1200|2560x1080 (OpenGL Only)|2560x1440 (OpenGL Only)|2560x1600 (OpenGL Only)|3440x1440 (OpenGL Only)|3840x2160 (OpenGL Only)|5120x2880 (OpenGL Only)|7680x4320 (OpenGL Only)|15360x8640 (OpenGL Only)) + + Set the in-game rendering resolution. Higher values improve clarity at the expense of increased performance requirements. + +- **Framerate (Restart)** [vitaquakeii_framerate] (**Auto**|30 fps|50 fps|60 fps|72 fps|75 fps|90 fps|100 fps|119 fps|120 fps|144 fps|155 fps|160 fps|165 fps|180 fps|200 fps|240 fps|244 fps|300 fps|320 fps|360 fps|380 fps|400 fps|420 fps|440 fps|460 fps|480 fps|500 fps|520 fps|540 fps|560 fps|580 fps|600 fps) + + Set internal framerate. 'Auto' will attempt to match the refresh rate of the connected display. + +- **Renderer (Restart)** [vitaquakeii_renderer] (**OpenGL**|Software) + + Choose between fast hardware-accelerated (OpenGL) rendering or the slower software-based renderer. + +- **[Software] Truecolor Sky** [vitaquakeii_sw_truecolor_sky] (**Enabled**|Disabled) + + Composite a high-colour RGB565 sky over the paletted frame when truecolor env/*.tga skybox textures are present. Has no effect on the OpenGL renderer or on skies that ship only as 8-bit PCX. + +- **[Software] Colored Lighting** [vitaquakeii_sw_colored_lighting] (**Enabled**|Disabled) + + Use the map's 24-bit RGB lightmaps to tint the paletted software renderer, snapping each lit texel to the nearest palette entry via an inverse-palette lookup. Has no effect on the OpenGL renderer. When disabled, lighting collapses to the original monochrome intensity. + +- **[GL] Brightness (Restart)** [vitaquakeii_gl_modulate] (1.0 to 5.0 in steps of 0.2, **2.0**) + + Set the overall brightness of in-game environments. (Only supported by the OpenGL renderer) + +- **[GL] Texture Filtering** [vitaquakeii_gl_texture_filtering] (Nearest|Linear|**Nearest (HQ)**|Linear (HQ)) + + Set hardware-based filtering method for in-game textures. 'Nearest' is sharp, 'Linear' is smooth. 'HQ' versions improve mipmap handling, reducing 'shimmer' in floor/ceiling textures. (Only supported by the OpenGL renderer) + +- **[GL] Dynamic Shadows** [vitaquakeii_gl_shadows] (**disabled**|enabled) + + Enable the casting of dynamic shadows from in-game objects. (Only supported by the OpenGL renderer) + +- **[GL] Mirror Mode** [vitaquakeii_gl_xflip] (**disabled**|enabled) + + Mirror each level by flipping the X coordinate of the display, providing an alternative experience for veteran players. (Only supported by the OpenGL renderer) + +- **[GL] HUD Scale Factor** [vitaquakeii_gl_hud_scale] (0.00 to 1.00 in steps of 0.02, **0.50**) + + Adjust the scale of on-screen HUD icons/text and in-game menus. A value of '1.00' will draw elements at the size expected when running the original game at a native resolution of 320x240. A value of '0.00' will draw elements with 1:1 (pixel perfect) scaling. (Only supported by the OpenGL renderer) + +- **[SW] Dithered Filtering** [vitaquakeii_sw_dithered_filtering] (**disabled**|enabled) + + Reduce pixelation of in-game textures at the expense of increased performance requirements. (Only supported by the Software renderer) + +- **Weapon Position** [vitaquakeii_hand] (**Right**|Left|Center|Hidden) + + Set the on-screen location of the currently held weapon. + +- **Show Crosshair** [vitaquakeii_xhair] (disabled|**White Cross**|Red Dot|Red Angle) + + Enable an in-game crosshair to facilitate aiming. + +- **Force 4:3 for Cinematics** [vitaquakeii_cin_force43] (**enabled**|disabled) + + When enabled, all videos (introductions, cutscenes) will be displayed at the correct aspect ratio of 4:3. If disabled, videos will be stretched to fill the screen. + +- **Sound Samplerate (Hint)** [vitaquakeii_sound_samplerate] (**Auto**|32 kHz|44 kHz|48 kHz|96 kHz) + + Audio output rate. The engine mixes sound effects and the music stream directly at the chosen rate, so higher rates lower latency, push aliasing above the audible range, avoid the frontend resampler's low-pass smearing, and give the resamplers finer time resolution. 'Auto' queries the frontend's target rate and snaps to the nearest supported value. A core restart is required for a change to take effect. + +- **Play Music** [vitaquakeii_cdaudio_enabled] (**enabled**|disabled) + + Enable playback of original CD audio tracks at the expense of increased performance requirements. Music must be in OGG format, placed inside the '/music' folder. Files may be named either 'XX.ogg' or 'trackXX.ogg'. + +#### Input + +Configure auto run, Y axis inversion, camera sensitivity, analog deadzone, rumble settings and keyboard mapping. + +- **Auto Run** [vitaquakeii_cl_run] (**disabled**|enabled) + + When enabled, the player character will run by default instead of walking. + +- **Accurate Aiming** [vitaquakeii_aimfix] (**disabled**|enabled) + + When enabled, weapons will target the exact centre of the aiming crosshair. This modifies the behaviour of the original game, where shooting is slightly inaccurate and projectiles intentionally drift. + +- **Invert Y Axis** [vitaquakeii_invert_y_axis] (disabled|**enabled**) + + Invert the Y axis of the gamepad's right analog stick. When disabled, pressing 'up' will make the player character look down (i.e. flight sim camera controls). + +- **Camera Sensitivity** [vitaquakeii_mouse_sensitivity] (0.4 to 5.0 in steps of 0.2, **3.0**) + + Set the base speed of camera movements when using the gamepad's right analog stick or the mouse. + +- **Analog Deadzone** [vitaquakeii_analog_deadzone] (0%|3%|5%|7%|10%|13%|**15%**|17%|20%|23%|25%|27%|30%) + + Set the deadzone of the gamepad's analog sticks. May be used to eliminate controller drift. + +- **Rumble Effects** [vitaquakeii_rumble] (**disabled**|enabled) + + Enable gamepad force feedback when receiving damage. + +- **Keyboard Mapping: Forwards/Menu Up** [vitaquakeii_kb_map_up] (Backspace|Tab|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|**w**|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to move forwards and navigate upwards in menus when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Backwards/Menu Down** [vitaquakeii_kb_map_down] (Backspace|Tab|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|**s**|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to move backwards and navigate downwards in menus when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Strafe Left** [vitaquakeii_kb_map_left] (Backspace|Tab|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|**a**|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to strafe left when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Strafe Right** [vitaquakeii_kb_map_right] (Backspace|Tab|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|**d**|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to strafe right when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Show Menu** [vitaquakeii_kb_map_menu_show] (Backspace|Tab|Clear|Return|Pause|**Esc**|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to open the menu when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Menu Select** [vitaquakeii_kb_map_menu_select] (Backspace|Tab|Clear|**Return**|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to select menu items when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Menu Cancel** [vitaquakeii_kb_map_menu_cancel] (**Backspace**|Tab|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to cancel menu selections when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Show/Hide Help Computer** [vitaquakeii_kb_map_menu_help] (Backspace|Tab|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|**F1**|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to open and close the 'help computer' when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Open/Close Inventory** [vitaquakeii_kb_map_inventory_show] (Backspace|**Tab**|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to open and close the inventory when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Previous Inventory Item** [vitaquakeii_kb_map_inventory_prev] (Backspace|Tab|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|**q**|r|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to select the previous inventory item when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Next Inventory Item** [vitaquakeii_kb_map_inventory_next] (Backspace|Tab|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|**e**|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to select the next inventory item when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Use Inventory Item** [vitaquakeii_kb_map_inventory_use] (Backspace|Tab|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|**r**|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to activate current inventory item when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Drop Inventory Item** [vitaquakeii_kb_map_inventory_drop] (Backspace|Tab|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|**v**|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to drop current inventory item when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Next Weapon** [vitaquakeii_kb_map_weapon_next] (Backspace|Tab|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|**f**|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to switch to the next available weapon when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Run** [vitaquakeii_kb_map_run] (Backspace|Tab|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|**Left Shift**|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to enable running when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Jump/Climb** [vitaquakeii_kb_map_jump] (Backspace|Tab|Clear|Return|Pause|Esc|**Space**|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|Left Ctrl|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to jump and climb/ascend when input device type is 'Keyboard + Mouse'. + +- **Keyboard Mapping: Crouch/Descend** [vitaquakeii_kb_map_crouch] (Backspace|Tab|Clear|Return|Pause|Esc|Space|#|'|,|-|.|/|0|1|2|3|4|5|6|7|8|9|;|<|=|>|[|\|]|`|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|Delete|Keypad 0|Keypad 1|Keypad 2|Keypad 3|Keypad 4|Keypad 5|Keypad 6|Keypad 7|Keypad 8|Keypad 9|Keypad .|Keypad /|Keypad *|Keypad -|Keypad +|Keypad Enter|Keypad =|Cursor Up|Cursor Down|Cursor Right|Cursor Left|Insert|Home|End|PgUp|PgDn|F1|F2|F3|F4|F5|F6|F7|F8|F9|F10|F11|F12|F13|F14|F15|Num Lock|Caps Lock|Scroll Lock|Left Shift|Right Shift|**Left Ctrl**|Right Ctrl|Left Alt|Right Alt|Left Meta|Right Meta|Left Super|Right Super) + + Set key used to crouch and descend when input device type is 'Keyboard + Mouse'. + +## Controllers + +The vitaQuakeII core supports the following device type(s): + +- Analog Gamepad +- Keyboard + Mouse + +## External Links + +- [vitaQuakeII Repository](https://github.com/libretro/vitaquake2) +- [Report vitaQuakeII Core Issues Here](https://github.com/libretro/vitaquake2/issues) + diff --git a/docs/library/vitaquake3.md b/docs/library/vitaquake3.md new file mode 100644 index 0000000000..3fe12821bf --- /dev/null +++ b/docs/library/vitaquake3.md @@ -0,0 +1,100 @@ +# Quake III: Arena (vitaQuake 3) + +## Background + +A port of the VitaQuake 3 source port of iD's ioquake3 engine to libretro. This core loads games in the *.pk3 format. + +The vitaQuakeIII core has been authored by + +- Rinnegatamante + +The vitaQuakeIII core is licensed under + +- GPLv2 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the vitaQuakeIII core have the following file extensions: + +- .pk3 + +RetroArch database(s) that are associated with the vitaQuakeIII core: + +- [Quake III](https://github.com/libretro/libretro-database/blob/master/rdb/Quake%20III.rdb) + +## Features + +Frontend-level settings or features that the vitaQuakeIII core respects. + +| Feature | Supported | +|-------------------|:---------:| +| States | ✕ | +| Rewind | ✕ | +| Core Options | ✔ | + +### Directories + +The vitaQuakeIII core's library name is 'vitaQuakeIII' + +## Core options + +The vitaQuakeIII core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Framerate (restart)** [vitaquakeiii_framerate] (**Auto**|50fps|60fps|72fps|75fps|90fps|100fps|119fps|120fps|144fps|155fps|160fps|165fps|180fps|200fps|240fps|244fps|300fps|360fps) + + Modify framerate. Requires a restart. + +- **Sound Samplerate (Hint) (restart)** [vitaquakeiii_audio_samplerate] (**Auto**|32 kHz|44 kHz|48 kHz|96 kHz) + + Audio output rate. 'Auto' matches the frontend's target rate, which avoids the frontend resampler's extra filtering and group delay; that rate-matching, not a higher number, is what helps latency. Higher fixed rates give the music-stream resampler finer time resolution, but do little for Quake's own low-rate sound effects. Falls back to 48 kHz when the frontend can't report a target rate. Requires a restart. + +- **Internal resolution (restart)** [vitaquakeiii_resolution] (480x272|640x368|640x480|720x408|856x480|800x600|**960x544**|1024x768|1152x864|1280x720|1280x960|1400x1050|1600x1200|1920x1080|2048x1536|2560x1440|3840x2160) + + Configure the resolution. Requires a restart. + +- **Overbrights** [vitaquakeiii_overbrights] (Disabled|**Enabled**) + + Increases the range of lighting while comprimising color precision. Requires a restart. + +- **Widescreen** [vitaquakeiii_wide] (Vert-|**Hor+**) + +- **Invert Y Axis** [vitaquakeiii_invert_y_axis] (Disabled|**Enabled**) + + Invert the gamepad right analog stick's Y axis. + +- **Strict Pak Checking** [vitaquakeiii_strict_paks] (**Disabled**|Enabled) + + Disabled (default): allow partial or CD installs (e.g. only pak0-pak6) to boot. Some content may be missing or incorrect, and online play against pure servers may be refused. Enabled: require a complete, checksum-verified id pak set (pak0-pak8, the 1.32 point release). pak0.pk3 is always required. + +- **2D Pickups Rendering** [vitaquakeiii_pickups] (**Disabled**|Enabled) + + Makes pickups (medkits, weapons, quad damage, etc.) be rendered with 2D icons. + +- **Show Equipped Weapon** [vitaquakeiii_weapon] (Disabled|**Enabled**) + + Shows equipped weapon on screen. + +- **Shadows Quality** [vitaquakeiii_shadows] (Disabled|**Low**|High) + + Configure the quality of shadows rendering. + +- **Textures Filter** [vitaquakeiii_filter] (Disabled|Linear|**Bilinear**|Trilinear) + + Configure the textures filter to use. + +## Controllers + +The vitaQuakeIII core supports the following device type(s): + +- Gamepad Classic +- Gamepad Classic Alt +- Gamepad Modern +- RetroKeyboard + Mouse + +## External Links + +- [vitaQuakeIII Repository](https://github.com/libretro/vitaquake3) +- [Report vitaQuakeIII Core Issues Here](https://github.com/libretro/vitaquake3/issues) + diff --git a/docs/library/x1.md b/docs/library/x1.md new file mode 100644 index 0000000000..ac19ed83a7 --- /dev/null +++ b/docs/library/x1.md @@ -0,0 +1,89 @@ +# Sharp X1 (X Millennium) + +## Background + +A port of the X Millennium Sharp X1 emulator to libretro. IPLROM BIOS images are expected in a subdirectory of 'system' named 'xmil'. Opening disk images from the GUI does not currently work. + +The x1 core has been authored by + +- yui + +The x1 core is licensed under + +- BSD + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the x1 core have the following file extensions: + +- .dx1 +- .zip +- .2d +- .2hd +- .tfd +- .d88 +- .88d +- .hdm +- .xdf +- .dup +- .cmd + +RetroArch database(s) that are associated with the x1 core: + +- [Sharp - X1](https://github.com/libretro/libretro-database/blob/master/rdb/Sharp%20-%20X1.rdb) + +## Features + +Frontend-level settings or features that the x1 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Core Options | ✔ | + +### Directories + +The x1 core's library name is 'x1' + +## Core options + +The x1 core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +- **Resolution** [X1_RESOLUTE] (**LOW**|HIGH) + +- **Boot media** [X1_BOOTMEDIA] (**2HD**|2D) + +- **ROM type** [X1_ROMTYPE] (**X1**|TURBO|TURBOZ) + +- **FPS** [X1_FPS] (**AUTO**|60|30|20|15) + +- **Disp Vsync** [X1_DISPSYNC] (**OFF**|ON) + +- **Raster** [X1_RASTER] (**OFF**|ON) + +- **No wait** [X1_NOWAIT] (**OFF**|ON) + +- **Joy Reverse** [X1_BTN_MODE] (**OFF**|ON) + +- **Joy Rapid** [X1_BTN_RAPID] (**OFF**|ON) + +- **Audio sampling rate** [X1_AUDIO_RATE] (**44100**|22050|11025) + +- **Seek Sound** [X1_SEEKSND] (**OFF**|ON) + +- **Scanlines in low-res** [X1_SCANLINES] (**OFF**|ON) + +- **Key mode** [X1_KEY_MODE] (**Keyboard**|JoyKey-1|JoyKey-2|Mouse-Key) + +- **FM Board** [X1_FMBOARD] (**ON**|OFF) + +- **Audio buffer (ms)** [X1_AUDIO_DELAYMS] (**250**|100|150|200|300|350|500|750|1000) + +- **Cpu clock (MHz)** [X1_CPU_CLOCK] (**4**|1|2|3|**4**|5|6|7|8|9|10|11|12|13|14|15|16|17|18|19|20) + +## External Links + +- [x1 Repository](https://github.com/libretro/xmil-libretro) +- [Report x1 Core Issues Here](https://github.com/libretro/xmil-libretro/issues) + diff --git a/docs/library/ymir.md b/docs/library/ymir.md new file mode 100644 index 0000000000..2c562c9f76 --- /dev/null +++ b/docs/library/ymir.md @@ -0,0 +1,133 @@ +# Sega - Saturn (Emir) + +## Background + +A port of the Ymir Sega Saturn emulator to libretro. Ymir is a work-in-progress Saturn emulator focused on accuracy and compatibility. It features software rendering, SH2 emulation with optional cache emulation, and a modern codebase. A young but rapidly maturing alternative to Beetle Saturn. + +The Emir core has been authored by + +- StrikerX3 + +The Emir core is licensed under + +- GPLv3 + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Extensions + +Content that can be loaded by the Emir core have the following file extensions: + +- .cue +- .chd +- .mds +- .ccd +- .iso +- .m3u + +RetroArch database(s) that are associated with the Emir core: + +- [Sega - Saturn](https://github.com/libretro/libretro-database/blob/master/rdb/Sega%20-%20Saturn.rdb) + +## Features + +Frontend-level settings or features that the Emir core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Saves | ✔ | +| States | ✔ | +| Rewind | ✔ | +| Netplay | ✔ | +| Core Options | ✔ | +| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✔ | +| RetroArch Cheats | ✔ | +| Controls | ✔ | +| Subsystem | ✕ | +| Disk Control | ✔ | + +## Core options + +The Emir core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. + +#### System + +System-level emulation settings. + +- **Region** [ymir_region] (**Auto**|Japan|North America|Europe) + + Set the Saturn region. 'Auto' detects from the disc. + +- **SH-2 Cache** [ymir_sh2_cache] (**Disabled**|Enabled) + + Improves accuracy for specific games at a small performance cost. + +- **SH-2 Clock** [ymir_sh2_clock] (25%|50%|75%|**100% (Recommended)**|125%|150%|200%|300%|400%|500%) + + Adjusts the SH-2 CPU clock speed. Lower values improve performance but may cause slowdowns; higher values may reduce lag in CPU-heavy games. Values other than 100% may lower compatibility with some games. + +- **RTC** [ymir_rtc_mode] (**Virtual (Recommended)**|Host) + + Virtual: clock advances with emulation (correct for fast-forward/save states). Host: syncs to real time. + +- **Cartridge** [ymir_cartridge] (**Auto (Recommended)**|None|1 MB DRAM Expansion|4 MB DRAM Expansion|ROM: King of Fighters '95|ROM: Ultraman) + + Select the cartridge to insert. 'Auto' uses the game database to pick the correct one. DRAM carts are required by many fighting games. + +#### Video + +Graphics rendering settings. + +- **Threaded VDP1** [ymir_threaded_vdp1] (**Enabled**|Disabled) + + Run the VDP1 renderer in a dedicated thread for improved performance. + +- **Threaded VDP2** [ymir_threaded_vdp2] (**Enabled**|Disabled) + + Run the VDP2 renderer in a dedicated thread. Highly recommended for performance. + +- **Deinterlace** [ymir_deinterlace] (**Disabled**|Enabled) + + Render interlaced high-res modes in progressive mode. May cause artifacts in some games. + +- **Threaded Deinterlace** [ymir_threaded_deinterlacer] (**Enabled**|Disabled) + + Run the deinterlacer in a dedicated thread. Requires threaded VDP2 and deinterlace enabled. + +- **Transparent Meshes** [ymir_transparent_meshes] (**Disabled**|Enabled) + + Render mesh patterns as semi-transparent instead of checkerboard. + +#### Audio + +Audio emulation settings. + +- **Interpolation** [ymir_audio_interpolation] (**Linear (Accurate)**|Nearest Neighbor) + + Linear interpolation matches real hardware. Nearest neighbor is harsher. + +- **Threaded SCSP** [ymir_threaded_scsp] (**Disabled**|Enabled) + + Run the SCSP and its MC68EC000 sound CPU in a dedicated thread for improved performance. + +- **SCSP Granularity** [ymir_audio_step_granularity] (**0 - Fastest**|1|2|3|4|5 - Most Accurate) + + Controls SCSP emulation accuracy. Higher values are more accurate but slower. + +#### CD Drive + +CD Block emulation settings. + +- **CD Speed** [ymir_cd_speed] (**2x (Accurate)**|4x|8x) + + Higher values reduce loading times. + +- **CD Block LLE** [ymir_cdblock_lle] (**Disabled**|Enabled) + + Use low-level CD block emulation for improved accuracy. Requires CD block ROM in system directory. + +## External Links + +- [Emir Repository](https://git.libretro.com/libretro/emir) +- [Ymir Repository](https://github.com/ymir-emu/Ymir) + diff --git a/mkdocs.yml b/mkdocs.yml index 06005bda69..5ba6797db0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -118,16 +118,26 @@ nav: - 'Amstrad - CPC (Caprice32)': 'library/caprice32.md' - 'Amstrad - CPC (CrocoDS)': 'library/crocods.md' - 'Apple': + - 'Apple - II (AppleWin)': 'library/applewin.md' - 'Apple - Macintosh (minivmac)': 'library/minivmac.md' - 'Arcade Emulation': - 'Arcade (DICE)': 'library/dice.md' + - 'Arcade (FB Alpha 2012 CPS-1)': 'library/fbalpha2012_cps1.md' + - 'Arcade (FB Alpha 2012 CPS-2)': 'library/fbalpha2012_cps2.md' + - 'Arcade (FB Alpha 2012 CPS-3)': 'library/fbalpha2012_cps3.md' + - 'Arcade (FB Alpha 2012 Neo Geo)': 'library/fbalpha2012_neogeo.md' + - 'Arcade (FB Alpha 2012)': 'library/fbalpha2012.md' - 'Arcade (FinalBurn Neo)': 'library/fbneo.md' + - 'Arcade (HBMAME)': 'library/hbmame.md' + - 'Arcade (MAME 2000)': 'library/mame2000.md' - 'Arcade (MAME 2003)': 'library/mame_2003.md' - 'Arcade (MAME 2003-Plus)': 'library/mame2003_plus.md' - 'Arcade (MAME 2010)': 'library/mame_2010.md' + - 'Arcade (MAME 2015)': 'library/mame2015.md' - 'Arcade (SAME_CDI)': 'library/same_cdi.md' - 'Arduboy': - 'Ardens': 'library/ardens.md' + - 'Arduboy (Arduous)': 'library/arduous.md' - 'Atari Emulation': - 'Atari - Jaguar Compatibility List': 'library/compatibility/jaguar.md' - 'Atari - Lynx Compatibility List:': 'library/compatibility/lynx.md' @@ -143,21 +153,28 @@ nav: - 'Atari - ST/STE/TT/Falcon (hatariB)': 'library/hatarib.md' - 'Bandai Emulation': - 'Bandai - Playdia (PlaydiaEmu)': 'library/playdiaemu.md' + - 'Bandai - Tamagotchi P1 (TamaLIBretro)': 'library/tamalibretro.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' + - 'BBK - electronic dictionaries (BBKEmu)': 'library/bbkemu.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 (Amiberry)': 'library/amiberry.md' + - 'Commodore - Amiga (FS-UAE)': 'library/fsuae.md' - 'Commodore - Amiga (PUAE)': 'library/puae.md' + - 'Commodore - C64 (Frodo)': 'library/frodo.md' - 'DOS Emulation': - 'MS - DOS (DOSBox)': 'library/dosbox.md' - 'MS - DOS (DOSBox Pure)': 'library/dosbox_pure.md' - 'MS - DOS (VirtualXT)': 'library/virtualxt.md' + - 'PC (PCem)': 'library/pcem.md' + - 'PC (QEMU)': 'library/qemu.md' - 'Dingoo Emulation': - 'Dingoo - A320 (DingooEmu)': 'library/dingooemu.md' - 'Emerson': @@ -169,6 +186,10 @@ nav: - 'Epoch Emulation': - 'Epoch - Cassette Vision (PD777)': 'library/pd777.md' - 'Epoch - Super Cassette Vision (EmuSCV)': 'library/emuscv.md' + - 'Fairchild Emulation': + - 'Fairchild - Channel F (FreeChaF)': 'library/freechaf.md' + - 'Galaksija Emulation': + - 'Elektronika Inženjering - Galaksija (Galaksija)': 'library/galaksija.md' - 'GCE Emulation': - 'GCE - Vectrex (vecx)': 'library/vecx.md' - 'Magnavox Emulation': @@ -181,11 +202,23 @@ nav: - 'Mobile Emulation': - 'Mobile - J2ME (FreeJ2ME)': 'library/freej2me.md' - 'Mobile - J2ME (FreeJ2ME-Plus)': 'library/freej2me_plus.md' + - 'Mobile - J2ME (SquirrelJME)': 'library/squirreljme.md' - 'Nintendo Emulation': + - 'Nintendo - 3DS (Citra 2018)': 'library/citra2018.md' + - 'Nintendo - 3DS (Panda3DS)': 'library/panda3ds.md' + - 'Nintendo - DS (NooDS)': 'library/noods.md' - 'Nintendo - DS Compatibility List': 'library/compatibility/ds.md' + - 'Nintendo - Game Boy / Color (fixGB)': 'library/fixgb.md' + - 'Nintendo - Game Boy / Color (IroGB)': 'library/irogb.md' + - 'Nintendo - Game Boy / GBA / DS (SkyEmu)': 'library/skyemu.md' - 'Nintendo - Game Boy Advance Compatibility List': 'library/compatibility/gba.md' - 'Nintendo - Game Boy Color Compatibility List': 'library/compatibility/gbc.md' + - 'Nintendo - NES / Famicom (fixNES)': 'library/fixnes.md' + - 'Nintendo - NES / SNES / GB / GBA, NEC - PCE, Sega - SMS / GG, Bandai - WonderSwan (MesenCE)': 'library/mesen2.md' - 'Nintendo - NES Compatibility List': 'library/compatibility/nes.md' + - 'Nintendo - Nintendo 64 (ParaLLEl N64)': 'library/parallel_n64.md' + - 'Nintendo - SNES / SFC (Beetle Supafaust)': 'library/mednafen_supafaust.md' + - 'Nintendo - SNES / SFC (bsnes-hd beta)': 'library/bsnes_hd_beta.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' @@ -235,6 +268,8 @@ nav: - 'Nintendo - SNES / Famicom (Snes9x)': 'library/snes9x.md' - 'Nintendo - Virtual Boy (Beetle VB)': 'library/beetle_vb.md' - 'NEC Emulation': + - 'NEC - PC Engine / SuperGrafx / CD (Beetle PCE)': 'library/mednafen_pce.md' + - 'NEC - PC-98 (Neko Project II)': 'library/nekop2.md' - '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' @@ -242,20 +277,25 @@ nav: - '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' + - 'Oberon Emulation': + - 'Oberon RISC Emulator': 'library/oberon.md' - 'Palm Emulation': - 'Palm OS (Mu)': 'library/mu.md' - 'Philips Emulation': - 'Magnavox - Odyssey2 / Philips Videopac+ (O2EM)': 'library/o2em.md' + - 'Philips - CD-i (CDi 2015)': 'library/cdi2015.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 CD (NeoCD)': 'library/neocd.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 (Emir)': 'library/ymir.md' - 'Sega - Saturn Compatibility List': 'library/compatibility/saturn.md' - 'Sega - Dreamcast (flycast)': 'library/flycast.md' - 'Sega - Dreamcast (redream)': 'library/redream.md' @@ -274,11 +314,13 @@ nav: - 'Sega - Model 3 (Supermodel)': 'library/supermodel.md' - 'MSX/SVI/ColecoVision/SG-1000 (blueMSX)': 'library/bluemsx.md' - 'Sharp Emulation': + - 'Sharp - X1 (X Millennium)': 'library/x1.md' - '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 2 (ARMSX2)': 'library/armsx2.md' - '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' @@ -286,6 +328,7 @@ nav: - 'Sony - PlayStation 2 (PCSX2)': 'library/lrps2.md' - 'Sony - PlayStation 2 (Play!)': 'library/play.md' - 'Sony - PlayStation Portable (PPSSPP)': 'library/ppsspp.md' + - 'Sony - PocketStation (pokketstation)': 'library/pokketstation.md' - 'SpectraVision Emulation': - 'MSX/SVI/ColecoVision/SG-1000 (blueMSX)': 'library/bluemsx.md' - 'Sunplus Emulation': @@ -297,6 +340,10 @@ nav: - 'Texas Instruments - TI-83 (Numero)': 'library/numero.md' - 'Thomson Emulation': - 'Thomson - MO/TO (Theodore)': 'library/theodore.md' + - 'VM Labs Emulation': + - 'VM Labs - NUON (Nuance)': 'library/nuance.md' + - 'Watara Emulation': + - 'Watara - Supervision (Potator)': 'library/potator.md' - 'Wenquxing Emulation': - 'Wenquxing - Electronic Dictionary (WQXEmu)': 'library/wqxemu.md' - 'MegaDuck Emulation': @@ -317,19 +364,27 @@ nav: - 'Doom 3 (Boom3)': 'library/boom3.md' - 'Dungeon Crawl Stone Soup': 'library/stone_soup.md' - 'Flashback (REminiscence)': 'library/reminiscence.md' + - 'Gong': 'library/gong.md' - 'Handheld Electronic (GW)': 'library/gw.md' - 'Jump n Bump': 'library/jumpnbump.md' + - 'Laserdisc (DirkSimple)': 'library/dirksimple.md' - 'LowRes NX': 'library/lowres_nx.md' - 'Lua Engine (Lutro)': 'library/lutro.md' + - 'McSoftServe': 'library/mcsoftserve.md' - 'MicroW8': 'library/microw8.md' - 'Minecraft (Craft)': 'library/craft.md' - 'Mr.Boom (Bomberman)': 'library/mr_boom.md' + - 'Omicron': 'library/omicron.md' + - 'PICO-8 (Retro8)': 'library/retro8.md' - 'Quake 1 (TyrQuake)': 'library/tyrquake.md' + - 'Quake 2 (vitaQuake 2)': 'library/vitaquake2.md' + - 'Quake 3 (vitaQuake 3)': 'library/vitaquake3.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' + - 'Super Bros War': 'library/superbroswar.md' - 'The Powder Toy': 'library/the_powder_toy.md' - 'TIC-80': 'library/tic80.md' - 'Tomb Raider (OpenLara)': 'library/openlara.md' @@ -338,15 +393,19 @@ nav: - 'Vircon32': 'library/vircon32.md' - 'WebAssembly (WASM-4)': 'library/wasm-4.md' - 'Wolfenstein 3D (ECWolf)': 'library/ecwolf.md' + - 'Z-Machine (MojoZork)': 'library/mojozork.md' - 'Core Library: Media': - 'Imageviewer': 'library/imageviewer.md' - 'FFmpeg': 'library/ffmpeg.md' - 'Game Music Emu': 'library/game_music_emu.md' + - 'Internet Radio (Radio)': 'library/radio.md' - 'PocketCDG': 'library/pocketcdg.md' - 'Video Processor': 'library/video_processor.md' - 'Core Library: Special-Purpose': - 'Dummy Core': 'library/dummy.md' + - 'PSP RemotePlay (RemoteJoy)': 'library/remotejoy.md' - 'Remote RetroPad': 'library/remote_retropad.md' + - 'ROM Cleaner': 'library/romcleaner.md' - 'Shader Library': - 'Introduction': 'shader/introduction.md' - '3dfx': 'shader/3dfx.md' From da084d5bbe82ee747b62eb9005a89556e9e565c0 Mon Sep 17 00:00:00 2001 From: WizzardSK <42868978+WizzardSK@users.noreply.github.com> Date: Tue, 29 Sep 2026 20:18:03 +0200 Subject: [PATCH 2/3] Note that ROM Cleaner and McSoftServe were April Fools' Day jokes --- docs/library/mcsoftserve.md | 2 ++ docs/library/romcleaner.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/library/mcsoftserve.md b/docs/library/mcsoftserve.md index 3348997e6f..dc90c0ae0f 100644 --- a/docs/library/mcsoftserve.md +++ b/docs/library/mcsoftserve.md @@ -4,6 +4,8 @@ An experimental libretro core for the Taylor C713 soft-serve ice cream machine, popularized by a well-known American fast food chain. Provides an accurate user experience without the need for firmware dumps. +This core was released as an April Fools' Day joke in 2024. + The mcsoftserve core has been authored by - Jesse Talavera diff --git a/docs/library/romcleaner.md b/docs/library/romcleaner.md index 36de197eec..91e7a94825 100644 --- a/docs/library/romcleaner.md +++ b/docs/library/romcleaner.md @@ -4,6 +4,8 @@ A utility core for removing dust and dirt from your ROM collection. +This core was released as an April Fools' Day joke in 2025. + The romcleaner core has been authored by - Jesse Talavera From aeddfc4832a472d595d21065d966fa9428b4e1cb Mon Sep 17 00:00:00 2001 From: WizzardSK <42868978+WizzardSK@users.noreply.github.com> Date: Tue, 29 Sep 2026 20:30:38 +0200 Subject: [PATCH 3/3] typos: drop the second wizzard entry, master already has it --- _typos.toml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/_typos.toml b/_typos.toml index f614942c5c..9242e45d29 100644 --- a/_typos.toml +++ b/_typos.toml @@ -12,7 +12,6 @@ kernal = "kernal" # Commodore's low-level Operating System gam = "gam" # GAM4980 core name / .gam file extension noo = "noo" # NooDS core name (library/noods.md) wirth = "wirth" # Niklaus Wirth, designer of Oberon (library/oberon.md) -wizzard = "wizzard" # WizzardSK, a core author (library/armsx2.md, library/nuance.md) bload = "bload" # MSX-BASIC BLOAD command (library/bluemsx.md) consol = "consol" # Atari 8-bit CONSOL_SELECT/CONSOL_START hardware register (library/atari800.md) pn = "pn" # UPnP substring (ppsspp.md, netplay-faq.md, netplay-getting-started.md) @@ -38,6 +37,6 @@ ba = "ba" # part of the "ba4980-c-sdk" tool-repo URL slug (library/ga thq = "thq" # THQ, a real video game publisher (library/compatibility/gba.md) mis = "mis" # part of the valid "mis-matched" hyphenation (guides/softwarelist-getting-started.md) informations = "informations" # only remaining match is the quick-informations.md FILENAME itself (kept as-is: many other pages link to it by this exact path); every genuine prose occurrence of this typo was fixed -wizzard = "wizzard" # WizzardSK, a real GitHub username (library/cemu.md, library/pcee2.md) +wizzard = "wizzard" # WizzardSK, a real GitHub username (library/cemu.md, library/pcee2.md, library/armsx2.md, library/nuance.md) ahd = "ahd" # a real Hatari option value (library/hatarib.md) langage = "langage" # LANGAGE, a real EmuSCV core option name (library/emuscv.md)