Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
This is an essential guide for your first time setup of the MiSTer system. It will guide you through the SD-card installation, help you update the MiSTer system files and shows you how to run a game on an example core (NES).
You will need the following things to get everything started.
For the SD-card setup:
- Windows 10
- Internet connection
- SD-card reader
- SD-card >2GB
...and to run it:
- DE10-nano board + 5V power supply
- SDRAM-Board (see wiki page for instructions)
- Monitor + HDMI cable
- USB-OTG adapter + USB keyboard
Prepare the SD-card
Download the latest SD-card installer from here
Insert your SD-card into your PC.
Start "MiSTer SD Card Utility.exe"
Make sure it says "U-Boot + Linux + MiSTer" in the "Image" field.
- Newer versions of Mister SD Card Utility will says "Boot + Files" in the "Image" field.
Select your SD-card in the "Drive" field. If you have inserted the SD-card after starting the Installer, hit the "Refresh" button and your SD-card should appear.
Press "Full Install" and confirm the following Warning with "Yes". All data on the SD-card will be deleted! Make sure to backup the SD-card before you execute this!
- Confirm the successful installation with "ok"
- The Installer will open multiple windows which will ask you to format the drive. Don't format the drive! Press "Cancel" in all three windows.
- The SD-card File Explorer window will be opened twice, close one of them. The SD-card should contain the following three files / folder:
If you see only the
menu.rbf file, hit F5 on your keyboard or "right click > Refresh" to refresh the window. You should see all three files now.
The files you see are:
linux- Folder containing linux files
config- The configuration folder. You can place configuration files like the mister.ini in this folder. Check out the Configuration Files wiki page for more information (not yet so...).
- This folder is no more created by newer version of SD Card Utility, but it will be created automatically by the MiSTer hardware at first run (you can manually create and populate it if you want)
menu.rbf- This is the actual MiSTer menu core, which you will see when you boot up the DE10-Nano board (GitHub).
MiSTer- MiSTer main firmware (GitHub)
Update MiSTer files
The SD-card installer might be older then the actual binary releases of the MiSTer firmware and the menu core. Therefore, we want to bring those files up to date.
- Go to the MiSTer-devel/Main_MiSTer Repository and download the most recent
MiSTer_201#####firmware file on the bottom of the page.
- Rename the
- Copy the file over to your SD-card and override the old
- Repeat this for the menu core file: Go to the MiSTer-devel/Menu_MiSTer repository and download the most recent
menu_201#####.rbfcore file on the bottom of the page. Rename
menu.rbfand override the old file on the SD-card.
Get a core
We want to actually run a core like the NES or Amiga on our DE10-Nano FPGA board. Therefore, we have to copy a core
.rbf file to the root of the SD-card. The sidebar on the right contains a list of MiSTer compatible cores. Check out the GitHub repository page of each core for specific information. The following description is a generic example based on the NES core, but it is applicable to most other cores.
- Click in the sidebar on Cores > "NES" or go directly through this link to the MiSTer-devel/NES_MiSTer release folder. Download the lates
- Copy the core file to the root of the SD-card. Leave the date in the filename. By this, you know which version you are actually using.
- Create a new folder and name it for example
- Download a
.nesROM (Game) file and copy it into your
NES Gamesfolder. You have to google that by yourself...
Fire it up!
- Make sure the SDRAM-Board is attached to the GPIO header JP1 of the DE10-Nano (See SDRAM Wiki-Page for further instructions). Connect the board via HDMI to an monitor and via USB-OTG adapter to a keyboard. Do not connect the power supply yet.
- Remove the SD-card from you PC and insert it in the DE10-Nano board.
- Connect the power supply. This will turn on the DE10-Nano board. You will see the MiSTer menu on the monitor. You see in the menu the NES core we have copied to the SD-card. Hit the enter key on your keyboard to start it.
- You will see a black screen. This is normal because no ROM is loaded yet. Press F12 on your keyboard to bring up the MiSTer menu. In order to run a game, select *"Load .NES" and hit Enter.
- This will bring up the SD-card root directory. Navigate into your "NES Games" folder and select the ROM you want to start and hit Enter..
- Congratulation, you successfully started you first game on your MiSTer!!!
Once you've installed Release_20180115 or later, you can install future updates on MiSTer without removing the SD card. It's done in 2 stages:
- Copy everything from files folder of release to /media/fat using FTP client and then reboot MiSTer (use LShift+LCtrl+LAlt+RAlt combination).
- Login serial console or ssh and type updateboot and then reboot again.
Usually bootloader has none or little change and not always requires update. But for better experience it's advised to update the bootloader with every release. If somehow new version of Linux won't be able to boot with previous bootloader, then simply use SD Install Tool to update the bootloader (Update Boot button).