/RetroRig-ES

(discontinued) EmulationStation flavor of RetroRig. Curated and pre-configured emulation.

Primary LanguageShellOtherNOASSERTION

RetroRig-ES Project

alt text

[Version 0.3.0]

RetroRig-ES is preconfigured setup of scripts, configurations, and emulators for x64 and x86 Linux systems, using EmulationStation as the front-end. I wanted to take as much out of the equation as possible for users to configure themselves. The "ES" fork of RetroRig was meant to give a hard look at using EmulationStation as the front end, rather than XBMC. This project is intended to be run on Ubuntu (currently 14.04 LTS), and a gamepad / controller. The project focuses mainly on Debian derivities, but more could be supported in the future if additional help is gained.

I invite you to challenge the configs and scripts to help improve my ultimate goal to provide an easy way to get up and running with RetroGaming on x86_64 Linux systems. Pull requests or Issues are very much welcome! Please see the AUTHORS file in the root directory for all the awesome people that contribute to this project.

You can follow RetroRig-ES's development by staring the github.com page, or with joining the IRC channel #libregeek located under the irc.freenode.net network. The main op is me "ProfessorKaos64". You can also follow me on twitter with the username "@N3RD42". There is also a forum for any and all discussion.

Please be advised:
RetroRig-ES requires sudo access to inject the xboxdrv init sripts, install softwate via apt-get, and other various items. All script code and config files are available for review.

Thank you for your patience.

Demo Video

Coming in the future. Stay tuned

Warning

This is mainly targeted at folks wishing to repurpose a spare physical PC. VirtualBox support exists, (to an extent), but can behave erratcially with emulator speed/framerates and is not advised. I do hope to corrrect some of that in due time, but right now, it is more of an "extra" or a "test bed." RetroRig-ES will overwrite some folders for supported emulators and a few system files. Please see the wiki entries under "Installation," and "Advanced Configuration," or checkout the source code.

Some current features include

For all other features and future plans, please see the wiki

  • Gamepad friendly support for at least 20 amazing consoles
  • Concentration on a console-like experience from bootup to shutdown
  • No need to install an entire separate distro on your Mint/Debian machine
  • Custom emulator and utilties packages
  • Seperate dot file (.retrorig-es) so no other program's configurations are affected
  • Auto-install software, emulator configs, and required components
  • Many supported consoles (more added frequently)
  • Gamepad select menu
  • SSH and samba share support
  • Preset Controller mappings for supported gamepads
  • Resolution presets/custom selection for emulators that support it
  • Save state, load state, exit emulators with gamepad
  • A cobbled together "first run" state of RCB with a blank games database and pre-set configs
  • Functions to update git repo, emulator binaries, upgrade system and more
  • ROM pre-loader
  • BIOS pre-loader
  • Modular design for expandability
  • Unity configuration set during config-setup to lengthen screen timeout + remove screen lock

Wiki

First, I must direct you to read the wiki on this github page, as it contains extra information outside this wiki. A large amount of tips, tricks, and how-to information is located on this, all for your benefit. This may be replicated to this repository, or stay on its own. https://github.com/ProfessorKaos64/RetroRig-ES/wiki

Please also note
You may add the --help flag to the script for a quick help file. Come on, do it, it has psychedelic colorrrrsss!

Installation

Pre-requisites:

You will need git, dialog to run the installer and for updating:

sudo apt-get install dialog git

RetroRig will try to install them automatically for you (for instance, if you download the zip archive), but if you experience any issues starting the script,enusre they exist with the CLI commands 'which dialog' and 'which git" to ensure they report back. Please also ensure your graphics card or onboard graphics chipset supports OpenGL.

All install commands below are done on the command line. You can however doubleclick on the Debian package to install it.

Preferred method: package installation
In Progress

Pre-built packages for other distributions will be coming in the future. Stay tuned.

Alternate install method (GitHub source):

git clone https://github.com/ProfessorKaos64/RetroRig-ES

To install via GitHub source:

cd RetroRig-ES
sudo ./retrorig-es-setup.sh

The main disitribution target is Ubuntu 14.04 LTS, but support for other platforms is being worked on. For a currernt list of supported platofrms and distributions, see this wiki entry. Support for Ubuntu 15.04 is being worked on. You can also perform a git checkout Beta to try our Beta branch, but please do so with caution and backup any file before hand!

You can also download a zip file or by other means on the github page.

Updating

The retrorig-setup-es.sh script also currently contains mechanisms to upgrade the OS, update the emulator binaries, and also a way to pull the latest files from github.

Please Note

This project is not yet complete! Project notes and guide will be hosted at www.libregeek.org at some point in the near future.

EOF