(retired) This was fun - but seriously, try Lakka instead (http://www.lakka.tv/)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
config
doc
media
scripts
MIT-LICENSE
README.md
install.sh

README.md

Retired

This project stopped development quite a long time ago. Checkout lakka.tv instead.

Goals and Philosophy

It's my desire to build a project that allows you to convert your Raspberry Pi into a great little emulation box. To get started I'm working on glint-nes, a single-console emulation box for the 8-bit Nintendo Entertainment System.

My vision is to provide "turn on and play" functionality. That is, eventually you should be able to download a pre-built OS image to your SD card with everything installed and configured already, and all you have to do is plug the Raspberry Pi into your TV with a compatible controller and you're playing classic NES games in 30 seconds or less (BYOR - bring your own ROMs).

The glint-nes team

I wanted to publicly recognize a few people who have contributed to the project or supported it with information and testing:

  • Brandt Daniels - Linux systems expert - has contributed some automation and scripting help, along with guidance on how to better integrate the project with the OS
  • Alec "Aloshi" Lofquist - Author of EmulationStation - glint-nes utilizes a customized version of EmulationStation, called glint-es, and Aloshi has been incredibly supportive and helpful in my programming efforts to customize it to glint-nes' needs
  • PetRockBlog - one of the earliest and best blogs demonstrating how to convert the Raspberry Pi into an emulation box. This blog was extremely helpful in getting me started, as well as pointing me to a lot of the tools such as EmulationStation.
  • Steven "Malachi" Venner - play tester - keeps the games support list up to date
  • @50437 on twitter - play tester
  • Jeff Lunt - I am your humble project organizer, primarily doing programming tasks and tweaking to get everything working together

I'd also like to thank many testers and supporters of the project who have elected to remain anonymous. Your feedback and support have been greatly appreciated!

How to get a working glint-nes box

These paths are mutually exclusive (i.e. pick only one, don't try to do both - they will conflict)

  • EITHER download a pre-built OS image, flash your SD card, and boot up your Pi. This is the least complicated approach and should give you a known working experience
  • OR Follow the prerequisites and build instructions below

Prerequisites

  1. Raspberry Pi Rev B. board (the one with the ethernet jack). Either the 256MB or 512MB models work just fine.
  2. Power supply for your Pi. It should be at least 5.0 volts, 1 amp (or 1000 milliamps). I use the outlet-to-USB adapter I got with the iPad - it's 3 amps - more than enough. I believe the power supply for the Google Nexus 7 tablet is also sufficiently powerful. Your typical cell phone wall outlet power supply might also be sufficient, but double check the power output printed on the power supply itself.
  3. 4GB SD card (minimum size) imaged with the Raspbian Wheezy 2012-12-16 image. WARNING: DO NOT run the build script on anything but a base image. If you run it on a personal image on which you have many files and a home directory and everything, the script will destroy a lot of your stuff. The build script is intended to take a base image (no modifications) and convert it.

Build

After imaging your SD card, boot up your Raspberry Pi, login, and then:

  • At the console, type: curl -L https://raw.github.com/normalocity/glint-nes/master/install.sh | bash

This command runs a script from the project that downloads and installs everything you need, including config files and settings for the Raspberry Pi.

Play! (BYOR - Bring Your Own ROMs)

glint-nes now has the ability to copy .nes auto-magically from a USB stick. After you boot into the game selection screen, simply insert a USB stick into your Pi containing your .nes files (sorry, zipped versions of these are not supported - you must have the plain .nes file), and glint-nes will automically find and copy them onto your Raspberry Pi. The whole process takes from a few seconds to perhaps a minute or two, depending on the size and number of ROMs you have.

You'll know when glint-nes is done copying the ROMs, because the games list will reset itself, displaying your list of games. Once this is done you can safely remove the USB stick and continue on with your day! :D

Please report issues that you run into. :)

Doesn't glint-nes come with games?

Nope. You'll have to find those on your own. Please don't email me asking for ROMs.

Controls:

This awesome controller I got from Amazon is the one I'm using now - it's a great replica retro USB controller.

Current known issues

  • Config options: You can, of course, tweak the config options anyway you like and report your results back to me. This repo provides (and automatically copies) a provided config file for you that should get you basically up and running, even if it's not a perfect experience.
  • Sound/Speed: Sound and emulation speed is still glitchy in some games, but we have a long list of games known to work well the the latest build.
  • Some games just flat out don't work. A few of the most popular games (e.g. "Mike Tyson's Punchout") just work like crap. This game in particular seems to be especially troublesome on the Raspberry Pi's limited hardware. The reasons (as it's been explained to me) is that some elements of the NES hardware, while emulated, are extremely inefficient to emulate in software, and as such some games just won't work, or won't work very well. We're looking for tweaks and config changes to the emulator that we might be able to do that can lessen or eliminate this problem, but there are still issues. Again, if a specific game is incredibly important to you, please check the supported games list to look for known issues.