Skip to main content

MiSTer FPGA

MiSTer is fully supported by Zaparoo as a platform, and originally started as a project on MiSTer. Zaparoo has several MiSTer-exclusive commands because of this.

ItemPath
Data directory/media/fat/zaparoo
Mappings directory/media/fat/zaparoo/mappings
Config file/media/fat/zaparoo/config.toml
Log file/tmp/zaparoo/core.log
The /media/fat directory is the top level of the SD card.
The /tmp directory is not accessible from the SD card and is deleted when MiSTer is powered off.

Install

Zaparoo Core is available in Update All by enabling the MiSTer Extensions repository in the Tools & Scripts menu.

If you only want Zaparoo Core or don't have Update All, add the following text to the downloader.ini file on your MiSTer's SD card:

[mrext/tapto]
db_url = https://github.com/ZaparooProject/zaparoo-core/raw/main/scripts/mister/repo/tapto.json

This is supported by the downloader script which ships with the official MiSTer image.

Once installed, run zaparoo from the MiSTer Scripts menu, a prompt will offer to enable Zaparoo as a startup service, then the service will be started in the background.

After the initial setup is complete, a status display will be shown. It's OK to exit this screen, the service will continue to run in the background.

From this point, Zaparoo is now set up! You should be able to connect a reader and set up cards using the Zaparoo App.

Manual Install

Download Zaparoo Core for MiSTer from the Downloads page and copy the zaparoo.sh file to the Scripts folder on your MiSTer's SD card.

warning

Using FileZilla to transfer the file? Make sure binary transfer mode is enabled by following these steps. FileZilla incorrectly detects zaparoo.sh as a text file and will corrupt it, resulting in confusing errors.

Supported Readers

ReaderStatus
PN532
ACR122U
File Reader
Simple Serial
TTY2OLED

Supported Launchers

Console Systems

SystemFoldersExtensionsNotes
Adventure VisionAVision.binEntex Adventure Vision
Arcadia 2001Arcadia.binEmerson Arcadia 2001
Amiga CD32AmigaCD32.cue, .chd, .isoCommodore Amiga CD32
AstrocadeAstrocade.binBally Astrocade
Atari 2600ATARI7800, Atari2600.a26Also supports LLAPI variant
Atari 5200ATARI5200.a52
Atari 7800ATARI7800.a78Also supports LLAPI variant
Atari LynxAtariLynx.lnx
Casio PV-1000Casio_PV-1000.bin
CD-iCD-i.cue, .chdPhilips CD-i
Channel FChannelF.rom, .binFairchild Channel F
ColecoVisionColeco.col, .bin, .rom
CreatiVisionCreatiVision.rom, .bin, .bas
Famicom Disk SystemNES, FDS.fdsNintendo FDS
GamateGamate.binBit Corporation Gamate
Game BoyGAMEBOY.gbAlso supports LLAPI variant
Game Boy ColorGAMEBOY, GBC.gbc
Game Boy 2PGAMEBOY2P.gb, .gbcTwo-player Game Boy
Game GearSMS, GameGear.gg
Game & WatchGameNWatch, Game and Watch.bin, .gnwNintendo handheld games
Game Boy AdvanceGBA.gbaAlso supports LLAPI and 2P variants
Genesis/Mega DriveMegaDrive, Genesis.gen, .bin, .mdSupports Sinden and LLAPI variants
IntellivisionIntellivision.int, .bin
JaguarJaguar.jag, .j64, .rom, .binAtari Jaguar
Master SystemSMS.smsSupports Sinden and LLAPI variants
Mega CDMegaCD.cue, .chdSupports Sinden and LLAPI variants
Mega DuckGAMEBOY, MegaDuck.bin
Neo Geo CDNeoGeo-CD, NEOGEO.cue, .chdAlso supports LLAPI for cart Neo Geo
NESNES.nesSupports Sinden and LLAPI variants
NES MusicNES.nsfNintendo Sound Format player
Nintendo 64N64.n64, .z64Multiple variants: LLAPI, 80MHz, PWM
Odyssey²ODYSSEY2.binMagnavox Odyssey²
Pocket Challenge V2WonderSwan, PocketChallengeV2.pc2
Pokemon MiniPokemonMini.min
PlayStationPSX.cue, .chd, .exeMultiple variants: LLAPI, Sinden, 2X, PWM
Sega 32XS32X.32xAlso supports LLAPI variant
SG-1000SG1000, Coleco, SMS.sg
Super Game BoySGB.sgb, .gb, .gbcAlso supports LLAPI variant
SuperVisionSuperVision.bin, .svWatara SuperVision
SaturnSaturn.cue, .chdSupports LLAPI and PWM variants
SNESSNES.sfc, .smc, .bin, .bsSupports LLAPI and Sinden variants
SNES MusicSNES.spcSuper Nintendo Sound Format player
SuperGrafxTGFX16.sgxNEC SuperGrafx
TurboGrafx-16TGFX16.pce, .binAlso supports LLAPI variant
TurboGrafx-CDTGFX16-CD.cue, .chd
VC 4000VC4000.binInterton VC 4000
VectrexVECTREX.vec, .bin, .rom
WonderSwanWonderSwan.ws
WonderSwan ColorWonderSwan, WonderSwanColor.wsc

Computer Systems

SystemFoldersExtensionsNotes
Acorn AtomAcornAtom.vhd
Acorn ElectronAcornElectron.vhd
Alice MC-10AliceMC10.c10
Amstrad CPCAmstrad.dsk, .cdt
Amstrad PCWAmstrad PCW.dsk
AO486 (DOS)AO486, /media/fat/_DOS Games.img, .ima, .vhd, .vfd, .iso, .cue, .chd, .mglPC-compatible
Apogee BK-01APOGEE.rka, .rkr, .gam
Apple IApple-I.txt
Apple IIApple-II.dsk, .do, .po, .nib, .hdv
AquariusAQUARIUS.bin, .caqMattel Aquarius
Atari 800ATARI800.atr, .xex, .xfd, .atx, .car, .rom, .bin
BBC MicroBBCMicro.ssd, .dsd, .vhd
BK0011MBK0011M.bin, .dsk, .vhd
C16C16.d64, .g64, .prg, .tap, .binCommodore 16
C64C64.d64, .g64, .t64, .d81, .prg, .crt, .reu, .tapCommodore 64
Casio PV-2000Casio_PV-2000.bin
CoCo2CoCo2.dsk, .cas, .ccc, .romTRS-80 Color Computer
EDSACEDSAC.tapElectronic Delay Storage Automatic Calculator
GalaksijaGalaksija.tap
InteractInteract.cin, .k7
Jupiter AceJupiter.ace
Laser 310Laser.vzVTech Laser 310
Lynx 48Lynx48.tapCamputers Lynx
Macintosh PlusMACPLUS.dsk, .img, .vhd
MSXMSX.vhd
MSX1MSX1.dsk, .rom
MultiCompMultiComp.img
OraoORAO.tap
OricOric.dskOric Atmos
PC XTPCXT.img, .vhd, .ima, .vfdIBM PC XT compatible
PDP-1PDP1.bin, .rim, .pdp
PET 2001PET2001.prg, .tapCommodore PET
PMD 85PMD85.rmm
QLQL.mdv, .winSinclair QL
RX-78RX78.binBandai RX-78
SAM CoupéSAMCOUPE.dsk, .mgt, .img
Sord M5Sord M5.bin, .rom, .cas
SpecialistSPMX.rks, .odi
SVI-328SVI328.cas, .bin, .rom
Tatung EinsteinTatungEinstein.dsk
TI-99/4ATI-99_4A.bin, .m99Texas Instruments
Tomy TutorTomyTutor.bin, .cas
TRS-80TRS-80.jvi, .dsk, .cas
TSConfTSConf.vhfZX Spectrum clone
UK101UK101.txt, .bas, .lod
Vector-06CVECTOR06.rom, .com, .c00, .edd, .fdd
VIC-20VIC20.d64, .g64, .prg, .tap, .crtCommodore VIC-20
X68000X68000.d88, .hdf, .mglSharp X68000
ZX81ZX81.p, .0
ZX SpectrumSpectrum.tap, .csw, .tzx, .sna, .z80, .trd, .img, .dsk, .mgt
ZX NextZXNext.vhd

Arcade & Special Systems

SystemFoldersExtensionsNotes
Arcade_Arcade.mraMAME ROM Archives
ArduboyArduboy.hex, .binMiniature game system
CHIP-8Chip8.ch8Virtual machine
Groovy MiSTerGroovy.gmcCustom platform

Launcher Details

Many launchers are supported on MiSTer which link to official cores. Launchers will be automatically detected and used as long as you stick to the official games folders and core menu structure set by Downloader.

Below are some launchers with special features that are supported by Zaparoo.

ao486

If a .vhd file is launched via Zaparoo, and this .vhd file is sitting in its own folder with an .iso or .chd file, that .iso or .chd file will also be automatically mounted alongside the .vhd file.

AmigaVision (Amiga)

Launching games in the AmigaVision image on the Amiga core is supported via the games.txt files and demos.txt files located in the Amiga/listings folder on your SD card.

For example, to launch Beneath a Stell Sky in AmigaVision:

Amiga/listings/games.txt/Beneath a Steel Sky (OCS)[en]

The games.txt and demos.txt files contain a listing of all supported games and demos, generated by AmigaVision, and can be treated as a virtual folder for launching via Zaparoo. Other games can be launched using the same format of Amiga/listings/games.txt/<Game Name>.

Opening the games.txt and demos.txt files in a text editor will show the full list of supported games and demos.

NeoGeo

NeoGeo also supports launching .zip files and folders directly with Zaparoo, as is supported with the MiSTer core itself.

For example, a .zip file:

NeoGeo/mslug.zip

Or a folder:

NeoGeo/mslug2

Alternate Launchers

Some alternate or unofficial versions of cores are supported and can be used by explicitly setting a launcher in the ZapScript on a token. Like the official cores, Zaparoo assumes they're installed in either the default location from Update All or in the appropriate menu folder unless otherwise noted.

To use them, add the following to the end of the file path or launch command: ?launcher=<launcher ID>. For example: N64/some/game.n64?launcher=80MHzNintendo64

LLAPI

Bliss-Box LLAPI cores. Alternate Arcade cores can be referenced directly with their .mra files.

Launcher IDs: LLAPIAtari2600, LLAPIAtari7800, LLAPIGameboy, LLAPIGBA, LLAPIMegaDrive, LLAPISMS, LLAPIMegaCD, LLAPINeoGeo, LLAPINES, LLAPINintendo64, LLAPI80MHzNintendo64, LLAPIPSX, LLAPIS32X, LLAPISuperGameboy, LLAPISaturn, LLAPISNES, LLAPITurboGrafx16

PWM

24-bit video PWM cores.

Launcher IDs: PWMNintendo64, PWM80MHzNintendo64, PWMPSX, PWM2XPSX, PWMSaturn

Overclock

Robert Piep's experimental overclock cores.

Launcher IDs: 80MHzNintendo64, 2XPSX

Sinden Lightgun

Sinden Lightgun cores.

info

The Sinden cores must be installed in a custom _Sinden folder at the top of the SD card, or else Zaparoo won't see them and they will conflict with official cores.

Launcher IDs: SindenGenesis, SindenMegaDrive, SindenSMS, SindenMegaCD, SindenNES, SindenPSX, SindenSNES

Main Forks

Some MiSTer Main forks are available with Zaparoo integration or features that work well with Zaparoo.

spark2k06

An alternative version of MiSTer Main is available by spark2k06, which adds many great Zaparoo related features to MiSTer like:

  • Show status of connected reader as icon in top bar.
  • Zaparoo standby screen.
  • Box art on game load.
  • Many additional MGL features.

Please check spark2k06's repository for more details.

Insert-Coin

An alternative version of MiSTer Main is also available by funkycochise as part of the Insert-Coin project. This version includes a feature to hide the loading screen before cores start games, which works great with Zaparoo!

Known Issues

  • Zaparoo can have conflicts with other devices that use serial USB connections such as the tty2oled project and anything else using an Arduino board. The current workaround is to disable auto_detect in the config.toml file and manually set the reader path.