From 2684666527053b353ff52a5a977fc6b228d88065 Mon Sep 17 00:00:00 2001 From: gouchi Date: Sun, 10 Sep 2023 18:21:32 +0200 Subject: [PATCH] Add Vircon32 libretro core --- docs/development/licenses.md | 1 + docs/library/bios.md | 3 +- docs/library/vircon32.md | 111 +++++++++++++++++++++++++++++++++++ docs/meta/core-list.md | 1 + mkdocs.yml | 25 ++++---- 5 files changed, 128 insertions(+), 13 deletions(-) create mode 100644 docs/library/vircon32.md diff --git a/docs/development/licenses.md b/docs/development/licenses.md index 3b1d43b65a..82720973e2 100644 --- a/docs/development/licenses.md +++ b/docs/development/licenses.md @@ -206,6 +206,7 @@ See below for a summary of the licenses behind RetroArch and its cores: | VICE PLUS4 | [GPLv2](https://github.com/r-type/vice3.0-libretro/blob/master/vice/COPYING) | | | VICE VIC20 | [GPLv2](https://github.com/r-type/vice3.0-libretro/blob/master/vice/COPYING) | | | Video Processor | [BSD-2-Clause](https://github.com/jaredmcneill/libretro-v4l2/blob/master/LICENSE) | | +| [Vircon32](../library/vircon32.md) | [BSD-3-Clause](https://github.com/vircon32/vircon32-libretro/blob/main/LICENSE.md) | | | [Virtual Jaguar](../library/virtual_jaguar.md) | [GPLv3](https://github.com/libretro/virtualjaguar-libretro/blob/master/docs/GPLv3) | | | [VirtualXT](../library/virtualxt.md) | [zlib-acknowledgement](https://github.com/andreas-jonsson/virtualxt/blob/develop/LICENSE) | | | [XRick](../library/xrick.md) | [GPLv3](https://github.com/libretro/xrick-libretro/blob/master/README) | | diff --git a/docs/library/bios.md b/docs/library/bios.md index 77d2ce9105..32c3f615e6 100644 --- a/docs/library/bios.md +++ b/docs/library/bios.md @@ -103,7 +103,8 @@ SNES/Super Famicom | higan Accuracy | [BIOS information](higan_ac SNES/Super Famicom | Mesen-S | [BIOS information](mesen-s.md#bios) Super Cassette Vision | EmuSCV | [BIOS information](emuscv.md#bios) ST/STE/TT/Falcon | Hatari | [BIOS information](hatari.md#bios) -Texas Instruments TI-83 | Numero | [BIOS information](numero.md#bios) +Texas Instruments TI-83 | Numero | [BIOS information](numero.md#bios) Thomson - MO/TO | Theodore | [BIOS information](theodore.md#bios) Vectrex | vecx | [BIOS information](vecx.md#bios) +Vircon32 | Vircon32 | [BIOS information](vircon32.md#bios) ZX Spectrum | Fuse | [BIOS information](fuse.md#bios) diff --git a/docs/library/vircon32.md b/docs/library/vircon32.md new file mode 100644 index 0000000000..796aa2d887 --- /dev/null +++ b/docs/library/vircon32.md @@ -0,0 +1,111 @@ +# Vircon32 + +## Background + +- Vircon32 is a virtual game console, inspired by classic 16 & 32 bit systems as well as the arcade era. + +The Vircon32 core has been authored by + +- [Carra](https://github.com/vircon32) + +The Vircon32 core is licensed under + +- [3-clause BSD](https://github.com/vircon32/vircon32-libretro/blob/main/LICENSE.md) + +A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Requirements + +- OpenGL 3.0 or Open GL ES 2.0 or higher for the OpenGL renderer. + +## BIOS + +Required firmware file go in the frontend's system directory. + +| Filename | Description | md5sum | +|:-----------------:|:-------------------------------:|:--------------------------------:| +| StandardBios.v32 | Vircon32 BIOS 1.1 | 1ad96946bce7bd0422b7d9340735b248 | + +## Extensions + +Content that can be loaded by the Vircon32 core have the following file extensions: + +- .v32 +- .V32 + + +RetroArch database that are associated with the Vircon32 core: + +- [Vircon32](https://github.com/libretro/libretro-database/blob/master/rdb/Vircon32.rdb) + +## Features + +Frontend-level settings or features that the Vircon32 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Restart | ✔ | +| Saves | ✕ | +| States | ✕ | +| Rewind | ✕ | +| Netplay | ✕ | +| Core Options | ✕ | +| RetroAchievements | ✕ | +| RetroArch Cheats | ✕ | +| Native Cheats | ✕ | +| Controls | ✔ | +| Remapping | ✔ | +| Multi-Mouse | ✕ | +| Rumble | ✕ | +| Sensors | ✕ | +| Camera | ✕ | +| Location | ✕ | +| Subsystem | ✕ | +| [Softpatching](../guides/softpatching.md) | - | +| Disk Control | ✕ | +| Username | ✕ | +| Language | ✕ | +| Crop Overscan | ✕ | +| LEDs | ✕ | + +## Geometry and timing + +- The Vircon32 core's core provided FPS is 60. +- The Vircon32 core's core provided sample rate is 44100. +- The Vircon32 core's base width is 640. +- The Vircon32 core's base height is 480. +- The Vircon32 core's max width is 640. +- The Vircon32 core's max height is 480. +- The Vircon32 core's core provided aspect ratio is 4/3. + +## User 1 - 4 device types + +The Vircon32 core supports the following device type(s) in the controls menu, bolded device types are the default for the specified user(s): + +- None +- **Vircon32 gamepad** + +## Joypad + +| RetroPad Inputs | Vircon32 inputs | +|------------------------------------------------|--------------------------| +| ![](../image/retropad/retro_start.png) | Button Start | +| ![](../image/retropad/retro_dpad_up.png) | D-Pad Up | +| ![](../image/retropad/retro_dpad_down.png) | D-Pad Down | +| ![](../image/retropad/retro_dpad_left.png) | D-Pad Left | +| ![](../image/retropad/retro_dpad_right.png) | D-Pad Right | +| ![](../image/retropad/retro_x.png) | Button X | +| ![](../image/retropad/retro_y.png) | Button Y | +| ![](../image/retropad/retro_a.png) | Button A | +| ![](../image/retropad/retro_b.png) | Button B | +| ![](../image/retropad/retro_l1.png) | Button L | +| ![](../image/retropad/retro_r1.png) | Button R | + +## External Links + +- [Official Website](http://www.vircon32.com) +- [Libretro Vircon32 Core repository](https://github.com/vircon32/vircon32-libretro/) +- [Libretro Vircon32 Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/vircon32.info) +- [Report Libretro Vircon32 Core issues here](https://github.com/vircon32/vircon32-libretro/issues) +- [Vircon32 games](http://www.vircon32.com/games.html) +- [Vircon32 test roms](http://www.vircon32.com/testroms.html) diff --git a/docs/meta/core-list.md b/docs/meta/core-list.md index bdedaf25a2..29e94f49e9 100644 --- a/docs/meta/core-list.md +++ b/docs/meta/core-list.md @@ -206,6 +206,7 @@ | VICE xplus4 | Commodore Plus/4 | | | VICE xscpu64 | Commodore C64 SuperCPU | | | VICE xvic | Commodore VIC-20 | | +| Vircon32 | Game engine | A port of Vircon32 game console to libretro | | Virtual Jaguar | Atari Jaguar | | | VirtualXT | DOS | Runns 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'. | diff --git a/mkdocs.yml b/mkdocs.yml index 7cf03aab13..046d276f7a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -42,7 +42,7 @@ nav: - 'Steam Link': 'guides/install-steamlink.md' - 'Web Player': 'guides/web-player.md' - 'Sega Genesis Mini': 'guides/install-genesismini.md' - - 'Facebook Portal': 'guides/install-facebookportal.md' + - 'Facebook Portal': 'guides/install-facebookportal.md' - 'User Guides': - 'User Interface': 'guides/navigating.md' - 'Input and Controls': 'guides/input-and-controls.md' @@ -98,7 +98,7 @@ nav: - 'Amstrad - CPC (Caprice32)': 'library/caprice32.md' - 'Amstrad - CPC (CrocoDS)': 'library/crocods.md' - 'Apple': - - 'Apple - Macintosh (minivmac)': 'library/minivmac.md' + - 'Apple - Macintosh (minivmac)': 'library/minivmac.md' - 'Arcade Emulation': - 'Arcade (FinalBurn Neo)': 'library/fbneo.md' - 'Arcade (MAME 2003)': 'library/mame_2003.md' @@ -131,7 +131,7 @@ nav: - 'Enterprise Emulation': - 'Enterprise 128 (ep128emu)': 'library/ep128emu.md' - 'Elektronika': - - 'Elektronika - BK-0010/BK-0011 (bk)': 'library/bk.md' + - 'Elektronika - BK-0010/BK-0011 (bk)': 'library/bk.md' - 'GCE Emulation': - 'GCE - Vectrex (vecx)': 'library/vecx.md' - 'Magnavox Emulation': @@ -211,7 +211,7 @@ nav: - 'Sega - Saturn Compatibility List': 'library/compatibility/saturn.md' - 'Sega - Dreamcast (flycast)': 'library/flycast.md' - 'Sega - Dreamcast (redream)': 'library/redream.md' - - 'Sega - Dreamcast VMU (VeMUlator)': 'library/vemulator.md' + - 'Sega - Dreamcast VMU (VeMUlator)': 'library/vemulator.md' - 'Sega - Master System (Emux SMS)': 'library/emux_sms.md' - 'Sega - MS/GG (SMS Plus GX)': 'library/smsplus.md' - 'Sega - MS/GG/SG-1000 (Gearsystem)': 'library/gearsystem.md' @@ -221,7 +221,7 @@ nav: - 'Sega - Saturn (Beetle Saturn)': 'library/beetle_saturn.md' - 'Sega - Saturn/ST-V (Kronos)': 'library/kronos.md' - 'Sega - Saturn (Yabause)': 'library/yabause.md' - - 'Sega - Saturn (YabaSanshiro)': 'library/yabasanshiro.md' + - 'Sega - Saturn (YabaSanshiro)': 'library/yabasanshiro.md' - 'MSX/SVI/ColecoVision/SG-1000 (blueMSX)': 'library/bluemsx.md' - 'Sharp Emulation': - 'Sharp - X68000 (PX68k)': 'library/px68k.md' @@ -237,7 +237,7 @@ nav: - 'Sony - PlayStation 2 (Play!)': 'library/play.md' - 'Sony - PlayStation Portable (PPSSPP)': 'library/ppsspp.md' - 'Super Cassette Vision': - - 'Super Cassette Vision (EmuSCV)': 'library/emuscv.md' + - 'Super Cassette Vision (EmuSCV)': 'library/emuscv.md' - 'SpectraVision Emulation': - 'MSX/SVI/ColecoVision/SG-1000 (blueMSX)': 'library/bluemsx.md' - 'Texas Instruments Emulation': @@ -245,7 +245,7 @@ nav: - 'Thomson Emulation': - 'Thomson - MO/TO (Theodore)': 'library/theodore.md' - 'MegaDuck Emulation': - - 'Welback Holdings - Mega Duck (SameDuck)': 'library/sameduck.md' + - 'Welback Holdings - Mega Duck (SameDuck)': 'library/sameduck.md' - 'Core Library: Game and Scripting Engines': - '2048': 'library/2048.md' - '3D Engine': 'library/3d_engine.md' @@ -254,7 +254,7 @@ nav: - 'ChaiLove': 'library/chailove.md' - 'CHIP-8 Emulation': - 'XO-CHIP/CHIP-8 (JAXE)': 'library/jaxe.md' - - 'CHIP-8 (Emux)': 'library/emux_chip8.md' + - 'CHIP-8 (Emux)': 'library/emux_chip8.md' - 'Dinothawr': 'library/dinothawr.md' - 'Doom (PrBoom)': 'library/prboom.md' - 'Doom 3 (Boom3)': 'library/boom3.md' @@ -262,7 +262,7 @@ nav: - 'Flashback (REminiscence)': 'library/reminiscence.md' - 'Handheld Electronic (GW)': 'library/gw.md' - 'Jump n Bump': 'library/jumpnbump.md' - - 'LowRes NX': 'library/lowres_nx.md' + - 'LowRes NX': 'library/lowres_nx.md' - 'Lua Engine (Lutro)': 'library/lutro.md' - 'MicroW8': 'library/microw8.md' - 'Minecraft (Craft)': 'library/craft.md' @@ -275,9 +275,10 @@ nav: - 'TIC-80': 'library/tic80.md' - 'Tomb Raider (OpenLara)': 'library/openlara.md' - 'Uzebox (Uzem)': 'library/uzem.md' - - 'VaporSpec': 'library/vaporspec.md' + - 'VaporSpec': 'library/vaporspec.md' + - 'Vircon32': 'library/vircon32.md' - 'WebAssembly (WASM-4)': 'library/wasm-4.md' - - 'Wolfenstein 3D (ECWolf)': 'library/ecwolf.md' + - 'Wolfenstein 3D (ECWolf)': 'library/ecwolf.md' - 'Core Library: Media': - 'Imageviewer': 'library/imageviewer.md' - 'FFmpeg': 'library/ffmpeg.md' @@ -448,7 +449,7 @@ theme: icon: material/weather-night name: Switch to dark mode primary: black - accent: deep purple + accent: deep purple # 404 page static_templates: - 404.html