Editing MiSTer

{{WIP}}

{{Infobox emulator
|title         = MiSTer
|logo          = mister.png
|logowidth     = 
|orig-developer = [https://github.com/sorgelig Sorgelig]<br/><small>(aka Alexey Melnikov)</small> 
|developer     = MiSTer-devel<br/><small>(MiSTer Team)</small>
|version       = [https://github.com/MiSTer-devel Git]
|active        = Yes
|platform      = Terasic DE10-nano (with add-ons)
|architecture  = [[FPGA]]
|target        = Various
|compatibility = Varies, see [[#Supported systems|supported systems]]
|accuracy      = 
|website       = [https://github.com/MiSTer-devel/Main_MiSTer/wiki MiSTer wiki]
|prog-lang     = Verilog, VHDL, SystemVerilog
|support       = [https://www.paypal.me/FPGAMiSTer PayPal]<br/>[https://www.patreon.com/FPGAMiSTer Patreon]
|license       = Varies between GPL3 and MIT
|source        = [https://github.com/MiSTer-devel GitHub]
}}<!-- TODO: figure out the capacities of both the DDR3 and SDRAM components. -->
'''MiSTer''' is an open source hardware reimplementation project designed to be used on an [[FPGA]]. It reimplements various console, arcade, and computer hardware on the [https://www.terasic.com.tw/cgi-bin/page/archive.pl?Language=English&CategoryNo=167&No=1046 Terasic DE10-nano] development board as opposed to running projects like [[Lakka]] on an ARM-based [[Emulation Boxes|DIY emulation box]]. MiSTer is a fork of MiST, which is a similar project; the difference is that MiSTer targets a more powerful board to allow for more complex hardware implementations.

Contrary to what one might think, the Terasic DE10-nano doesn't just have an FPGA; the system also contains an ARM processor and DDR3 memory which is used with an optimized Linux kernel to interface with files-- the system can even run [https://github.com/MiSTer-devel/Main_MiSTer/wiki/Desktop-Linux Lubuntu 16.04] if one wanted to. The difference between a board like the DE10-nano and, say, a Raspberry Pi is the addition of an entire FPGA which handles the bulk of the system core.

MiSTer also maintains schematics for a few additional boards; some cores will often require the SDRAM board, as it allows for better handling of memory than what the DDR3 unit provides. The DE10-nano only includes HDMI output so the I/O board, or an HDMI to VGA adapter, are required if VGA output is desired. 

==Setup==
<!--this is based on a quick skim through the wiki. there may be more that could be needed-->
Follow [https://github.com/MiSTer-devel/Main_MiSTer/wiki/How-to-start-with-MiSTer these] [https://github.com/MiSTer-devel/Main_MiSTer/wiki/Setup-Guide two] pages to get started (and [https://github.com/MiSTer-devel/Main_MiSTer/wiki/SDRAM-Board this one] if you plan on using a core that requires SDRAM).

'''Other updater scripts:'''
Besides the default script, there are more powerful third-party updater scripts for automatically downloading the hardware cores and software files that you would want for a MiSTer device:
* [https://github.com/atrac17/MiSTer_MAME_SCRIPTS MiSTer_MAME_SCRIPTS] (A MAME getter for downloading MAME & HBMAME files. This can be done after running the main MiSTer update script.)
* [https://github.com/theypsilon/Update_All_MiSTer Update_All_MiSTer] (Great , comprehensive updater script with customisation.)
* [https://github.com/MiSTer-devel/Downloader_MiSTer MiSTer Downloader] (Similar to the Update All MiSTer script from the same creator, [https://www.patreon.com/theypsilon theypsilon], but with fixes & improvements.)

==Overview==

===Supported systems===
<!-- Information taken from https://github.com/MiSTer-devel/Main_MiSTer/wiki/Core-Status. Possibly add it as a reference? -->
<!-- TODO: Arcade systems require a different table. Their wiki lists a lot of them on the side, so it may be optimal to set it as collapsible. -->
<!-- TODO: Add an informational legend. They use their own terminology when determining the status of cores. They are (in order from best to worst) SuperStar, Good, Advanced, and WIP. These terms are kept in the table but the distinction between "Good" and "SuperStar" might be necessary. -->

{| class="wikitable sortable"
|-
! scope="col"|System
! scope="col"|Classification
! scope="col"|Status
|-
|Bally Astrocade
|Console
|SuperStar
|-
|[[Atari 2600 emulators|Atari 2600]]
|Console
|SuperStar
|-
|[[Atari 5200 emulators|Atari 5200]]
|Console
|SuperStar
|-
|[[ColecoVision emulators|ColecoVision]]
|Console
|SuperStar
|-
|[[Nintendo Entertainment System emulators|Nintendo Entertainment System]]
|Console
|SuperStar
|-
|[[Game Boy/Game Boy Color emulators|Nintendo Gameboy]]
|Console
|SuperStar
|-
|[[Magnavox Odyssey² emulators|Odyssey²]]
|Console
|SuperStar
|-
|[[PC Engine (TurboGrafx-16) emulators|PC Engine/TurboGrafx 16 (SuperGrafx)]]
|Console
|SuperStar
|-
|[[Sega Genesis emulators|Sega Genesis/Mega Drive]]
|Console
|SuperStar
|-
|[[Master System emulators|Sega Master System]] and [[Master System emulators|Game Gear]]
|Console
|SuperStar
|-
|[[Super Nintendo emulators|SNES/Super Famicom]]
|Console
|SuperStar
|-
|[[Vectrex emulators|Vectrex]]
|Console
|SuperStar
|-
|[[Amstrad CPC emulators|Amstrad CPC 6128]]
|Computer
|SuperStar
|-
|[[Atari 8-bit|Atari 800 XL]]
|Computer
|SuperStar
|-
|[[Atari ST Line|Atari ST/STe]]
|Computer
|WIP
|-
|[[Amiga Line|Amiga]]
|Computer
|SuperStar
|-
|[[Commodore 64 emulators|Commodore 64]]
|Computer
|SuperStar
|-
|Commodore 16 / Plus/4
|Computer
|SuperStar
|-
|Commodore PET
|Computer
|SuperStar
|-
|Commodore VIC-20
|Computer
|SuperStar
|-
|[[Intel CPUs|ao486]]
|Computer
|SuperStar
|-
|SAM Coupe
|Computer
|SuperStar
|-
|[[ZX Spectrum emulators|ZX Spectrum]]
|Computer
|SuperStar
|-
|[[Apple II Line|Apple II+]]
|Computer
|Good
|-
|[[Macintosh line|Apple Macintosh Plus]]
|Computer
|Good
|-
|[[Altair 8800]]
|Computer
|Advanced
|-
|DEC PDP-1
|Computer
|Advanced
|-
|[[Neo Geo and variants|Neo Geo]]
|Console
|SuperStar
|-
|[[Sharp X68000 emulators|Sharp X68000]]
|Computer
|WIP
|-
|Sony Playstation
|Console
|WIP
|}

===Add-on boards===
The project also maintains schematics for add-on boards that users can add onto the DE10-nano. All of them are optional for the basic usage of the FPGA, but some cores may require the SDRAM board.

;SDRAM:Allows FPGA cores to use memory that's better suited for reimplementations.  Highly recommended, but even without the additional SDRAM module, many cores will still function when using the 1GB of DDR3 ram that comes on the De-10 Nano board itself.  SDRAM modules generally come in two sizes; 32MB and 128MB. With the 32MB module, you can play 99% of what is available on MiSTer.  The 128MB module currently is only required for a handful of Neo Geo games (about 15% of the library), but this includes notable ones like Metal Slug 3 and Garou.
;I/O:Adds a VGA connector, a 3.5mm audio jack, optical audio, three buttons, three LEDs, a secondary SD card slot, a USB 3.0-like expansion connector, and a fan that cools the FPGA. The DE10-nano only includes an HDMI connector, so this board is needed if one wants VGA support. The I/O board already features zero-latency analog video output if a RGB, component or other cables is used.
;RTC:Provides a real-time clock for enthusiasts. The clock can be automatically configured if the FPGA is connected to the internet via the DE10's Ethernet port, and only two cores make use of it anyway.
;USB hub:Adds seven USB ports under the main board. MiSTer supports 1000hz polling for USB devices and can achieve input latency under 1ms depending on the controller used.
;SNAC:The Serial Native Accessory Converter(SNAC) board allows original controllers and peripherals to connect directly to the FPGA with latency matching original consoles.  This is especially useful for light guns, but also works with a wide variety of other accessories like multi-taps, mice and 3D glasses.

====Controllers====
;Bliss-Box BlisSTer: [https://bliss-box.net/support] Alternative to the USB hub.  This product from Bliss-Box makes similar utilization of the ultra-low-latency API found in the MiSTer range for adapting native controllers. The Bliss-Box LLAPI (Low Level API) is a protocol written for the Bliss-Box Bridge not yet released but was adopted in the Mister cores available here [https://github.com/Kitrinx/LLAPI]. The BlisSTer enables original console controllers that inter-operate with Bliss-Box's universal adapter chips to connect to a MiSTer hardware (Read their Support page for more details). If you already have the Bliss-Box adapters [https://bliss-box.net/ 4-Play or Gamer-Pro] then you can use a level shifter that plugs on to the serial I/O port on the input board. Level shifters can be made (simple design) or bought from Bliss-Box. The Bliss-Box also works with consoles like original Xbox and Nintendo Switch<ref>[http://www.racketboy.com/forum/viewtopic.php?f=27&t=52566 Bliss-Box now goes live to a console near you.] (Racketboy thread. Thu Jan 10, 2019.)</ref>. The BlisSter [https://paradisearcadeshop.com/home/electrical/pcbs-lighting/pcbs-for-controllers/2595_blisster-rev2-usb-hub-by-bliss-box?ipa=0&ins=/ BlisSTer],[https://misterfpga.co.uk/product/blisster-v2/ or HERE] input board for the MiSTer has USB and HDMI ports. Adapter cables can be ordered along with the BlisSTer for original controllers to be used with those HDMI ports in low-latency mode. Support for the BlisSTer at this time is not in the main fork but you can use these cores [https://github.com/MiSTer-LLAPI]

<u>Note:</u> Check the Racketboy retrospective in Resources list below as it particularly covers these solutions to using old controllers well.

==Comparison to alternatives==
MiSTer FPGA has reached the point where it has surpassed the commercial offerings from Analogue, as well as other open source FPGA developments like MiST, SiDi, etc.  

==Cores currently in development==
<!-- TODO: Add links/references to information about upcoming cores- PSX (laxer3a), Saturn (srg320), and Capcom CPS2 (Jotego). -->
Current cores being developed include the Sony PlayStation (PSX/PS1) and Sega Saturn, amongst many others.  As far as the limit of what is possible on the platform currently, Saturn is at the edge of what is considered to be remotely feasible from the DE-10 Nano board that MiSTer uses. The Nintendo 64 is expected to require a more powerful FPGA and memory configuration to work correctly, so it is considered unlikely that this, and more advanced consoles, will be possible on the platform.

==Resources==
* [https://www.retrorgb.com/mister.html RetroRGB's start guide with links to shop pages for various parts]
* [https://www.retrorgb.com/tag/mister RetroRGB MiSTer news]
* [http://www.racketboy.com/retro/mister-fpga-the-future-of-retro-game-emulation-and-preservation Racketboy's retrospective] (February 20th, 2019. MUST-READ for everybody interested in learning about origins of FPGA used for simulating retro game systems and getting started with the MiSTer! There is also a big topic on controllers & their solutions.)
* [https://forums.overclockers.com.au/threads/mister-fpga-computer-console-arcade-hardware-simulation.1253887/ MiSTer FPGA (computer/console/arcade hardware simulation)] (forums.overclockers.com.au thread. Started on Oct 14, 2018 and running across many pages. It has nice coverage of many basic summaries, embedded video links especially for new & updated system cores, feedback and advice.)
* [https://misterfpga.org Official MiSTer forum] (Mainly for discussions on development of cores, packaged kits, info of changelog updates, sale page links and etc.)
* [https://discord.com/invite/4xKVg4XVYn Official Discord channel] for MiSTer FPGA (Good community. You can sometimes find some FPGA devs there.)
* [https://archive.org/download/mi-ster-console-bios-pack/MiSTer_Console_BIOS_PACK.zip MiSTer Console BIOS Pack] (Necessary BIOS files for various console cores on the MiSTer)
* [https://github.com/theypsilon/Update_All_MiSTer theypsilon's update_all script] (Very helpful improved updater script that includes a lot of files to get you up and running easily)

==References==
<references />

==External Links==
* [https://twitter.com/SmokeMonsterTWI Twitter feed] (By SmokeMonster, a RetroRGB.com journalist)
* [https://www.youtube.com/SmokeMonster YT channel] (By SmokeMonster, a RetroRGB.com journalist)
* [http://www.atari-forum.com/viewtopic.php?t=33650 Core availability on the MiSTer] (Atari-Forum thread. Tue May 08, 2018. Early comparisons between the original MiST hardware and this new MiSTer fork regarding supported system cores. Original developer of both hardware, Sorgelig, also discussed in this conversation.)
* [https://gamebroscentral.com/fpga-technology-how-does-it-preserve-retro-gaming/ FPGA Technology: How Does It Preserve Retro Gaming?] at Game Bros Central (August 12, 2019. By Lord Gamesly. An article with several topics including a summary; Limitations of Emulation; Use of FPGA in clone consoles, flash carts & resolution enhancements; and Final Thoughts.)