Skip to content

Latest commit

 

History

History
170 lines (134 loc) · 11.4 KB

README.md

File metadata and controls

170 lines (134 loc) · 11.4 KB
Raw

Hi. We're back.

RetroPie-Extra

This is a collection of unofficial installation scripts for RetroPie allowing you to quickly and easily install emulators, ports and libretrocores that haven't been included in RetroPie for one reason or another. These scripts can be considered experimental at best.

Those in the master branch have been tested reasonably and should work well but may have some flaws as they haven't gone through the RetroPie's watchful eyes yet. Scripts that are unfinished/untested/unpolished will not be located in this repository and instead have been moved to RetroPie-Extra-unstable.

Pull requests and issue reports are accepted and encouraged as well as requests. Feel free to use the issue tracker to send me any personal requests for new scripts that you may have.

Installation

The following commands clone the repo to your Raspberry Pi and then run install-scripts.sh to install the scripts in the master branch directly to the proper directories in the RetroPie-Setup/ folder.

cd ~
git clone https://github.com/zerojay/RetroPie-Extra.git
cd RetroPie-Extra/
./install-extras.sh

The installation script assumes that you are running it on a Raspberry Pi with the RetroPie-Setup/ folder being stored in /home/pi/RetroPie-Setup. If your setup differs, just copy the scripts directly to the folder they need to be in.

Usage

After installing RetroPie-Extra, the extra scripts will be installed directly in the RetroPie Setup script (generally in the experimental section), which you can run from either the command line or from the menu within Emulation Station.

cd ~
cd RetroPie-Setup/
sudo ./retropie_setup.sh

Updating

The following commands update your Raspberry Pi to the latest repo and then run install-scripts.sh to install the scripts in the master branch directly to the proper directories in the RetroPie-Setup/ folder.

cd ~
cd RetroPie-Extra/
git pull origin
./install-extras.sh

The installation script assumes that you are running it on a Raspberry Pi with the RetroPie-Setup/ folder being stored in /home/pi/RetroPie-Setup. If your setup differs, just copy the scripts directly to the folder they need to be in.

Troubleshooting

Here are some helpful hints for getting around some possible issues that you may encounter.

The port I installed appears to close immediately upon launching.

In most cases, this is likely because the port requires external data files, especially in the case of game engines. In cases where shareware datafiles are available, the port will install them where possible. Otherwise, you will need to provide your own. The warning dialog box at the end of installation should usually tell you what files will be needed and where to place them. If you somehow don't see a dialog box after installation, you can open the script itself and look towards the bottom for the warning.

What is the directory structure needed for lr-daphne?

I haven't worked that out yet. If you have, drop me a line.

Included Software

Master Branch

Emulators

  • - gearboy.sh - Gameboy emulator - Tested and works well.
  • - kat5200.sh - Atari 8-bit/5200 emulator - Only set up for 5200 at the moment.
  • - mpv.sh - Video Player - Not an actual emulator but allows you to play movies and tv shows from new systems in RetroPie.
  • - openbor.sh - Beat 'em Up Game Engine (newest version) - Tested only on Pi4 so far, installs as a system instead of as a port, direct launching of games from emulationstation supported!
  • - pico8.sh - Fantasy Game Emulator - Adds as a new system in RetroPie so you can directly launch carts.
  • - pokemini.sh - Pokemon Mini emulator - Tested and works well.

Libretrocores

  • - lr-bsnes.sh - bsnes core for libretro with added SGB support.
  • - lr-daphne.sh - Daphne port to libretro - laserdisk arcade games.
  • - lr-fceumm-mod.sh - Modified fceumm core to specifically support the Super Mario Bros 1/3 hack.
  • - lr-freej2me.sh - A J2ME implementation for old JAVA phone games.
  • - lr-mame2003_midway.sh - MAME 0.78 core with Midway games optimizations.
  • - lr-mess-jaguar.sh - Add support for using lr-mess for Jaguar games, uses atarijaguar system name to match lr-virtualjaguar.
  • - lr-pocketcdg.sh - A MP3 karaoke music player.
  • - lr-prboom-system.sh - For setting up DOOM as an emulated system, not a port.

Ports

  • - amphetamine.sh - 2D Platforming Game - Tested, runs well. Requires keyboard.
  • - barrage.sh - Shooting Gallery action game - Tested and works well, requires mouse.
  • - bermudasyndrome.sh - Bermuda Syndrome engine - Tested, runs, possibly instable.
  • - bloboats.sh - Fun physics game - Tested and works well, OpenGL game running through glshim.
  • - breaker.sh - Arkanoid clone - Tested and works well.
  • - burgerspace.sh - BurgerTime clone - Tested and works well.
  • - chocolate-doom.sh - DOOM source port - Tested and works well.
  • - chocolate-doom-system.sh - For setting up DOOM as an emulated system, not port.
  • - chromium.sh - Open Source Web Browser - Tested and works well.
  • - corsixth.sh - Theme Hospital engine clone - Tested and works well.
  • - crack-attack.sh - Tetris Attack clone - Tested and works well. Minor color issue needs to be fixed with glshim.
  • - crispy-doom.sh - DOOM source port - Tested and works well.
  • - crispy-doom-system.sh - For setting up DOOM as an emulated system, not port.
  • - deadbeef.sh - Music and ripped game music player - Tested and works well.
  • - devilutionx.sh - Diablo source port - Tested and working well on Pi4.
  • - easyrpgplayer.sh - RPG Maker 2000/2003 interpreter - Tested and works well.
  • - freeciv.sh - Civilization online clone - Tested and works well, I may soon replace it to compile latest freeciv so that players can play with newer clients.
  • - freedink.sh - Dink Smallwood engine - Tested and works well.
  • - freesynd.sh - Syndicate clone - Tested and has occasional crash issues. Save between levels to avoid losing progress.
  • - gamemaker.sh - Install the 3 gamemaker games - Tested and works well.
  • - ganbare.sh - Japanese 2D Platformer - Tested and works well, does not require Japanese to play.
  • - hcl.sh - Hydra Castle Labrinth - Tested and works well.
  • - heboris.sh - Tetris The Grand Master clone - Tested and works well. To fix sound, change settings from MIDI to MP3.
  • - hurrican.sh - Turrican clone. - Tested and works well, minor graphics issues.
  • - iceweasel.sh - Rebranded Firefox Web Browser - Tested and works well.
  • - kaiten-patissier-cs.sh - Japanese 2D Platformer - Tested and works well, has English mode.
  • - kaiten-patissier-ura.sh - Japanese 2D Platformer - Tested and works well, has English mode.
  • - kaiten-patissier.sh - Japanese 2D Platformer - Tested and works well, has English mode.
  • - kodi-extra.sh - Kodi Media Player 16 with controller support as a separate system - Tested and works well.
  • - kweb.sh - Minimal kiosk web browser - Tested and working well generally. Media may not be working well, I need to understand it better first to say.
  • - lbreakout2.sh - Open Source Breakout game - Tested and working well, requires mouse.
  • - lgeneral.sh - Open Source strategy game - Tested and working well, requires mouse.
  • - lmarbles.sh - Open Source Atomix game - Tested and working well, requires mouse.
  • - ltris.sh - Open Source Tetris game - Tested and working well, requires keyboard.
  • - manaplus.sh - 2D MMORPG client - Tested and works well, requires mouse.
  • - netsurf.sh - Lightweight web browser - Tested and works well.
  • - nkaruga.sh - Ikaruga demake. Tested and works well, requires keyboard.
  • - nxengine.sh - The standalone version of the open-source clone/rewrite of Cave Story - Tested and works well.
  • - openjazz.sh - Jazz Jackrabbit source port.
  • - pingus.sh - Lemmings clone - Tested and works well, requires mouse.
  • - prboom-plus.sh - Enhanced DOOM source port - lightly tested, seems to work.
  • - rawgl.sh - Another World source port - Tested, occasionally crashes when button held when switching scenes?
  • - reminiscence.sh - Flashback engine clone - **Tested and works well. **
  • - retrobattle.sh - Fun retro style platform game - Tested and works well.
  • - rickyd.sh - Rick Dangerous clone - Tested and works well, requires keyboard.
  • - rockbot.sh - Mega Man clone. Tested and screen flickers like crazy until proper settings are applied. Check package help for more info.
  • - rott-darkwar.sh - Rise of the Triad source port with joystick support - Tested and works well.
  • - rott-huntbgin.sh - Rise of the Triad (shareware version) source port with joystick support.
  • - sdl-bomber.sh - Simple Bomberman clone - **Tested and works well, turn down the volume perhaps. **
  • - shiromino.sh - Tetris the Grand Master Clone - Requires keyboard to restart/quit.
  • - sorr.sh - Streets of Rage Remake port - Tested and works well. Use fullscreen fast video mode.
  • - sm64ex.sh - Super Mario 64 PC Port for Pi4 - Works extremely well on Pi 4.
  • - texmaster2009.sh - Tetris TGM clone - Tested and works well. Works on Pi4.
  • - tinyfugue.sh - MUD client - Tested and works well.
  • - ulmos-adventure.sh - Simple Adventure Game - Tested and works well.
  • - vgmplay.sh - Music Player - Tested and works well. Plays .vgm and .vgz game music rips. Command line client only.
  • - vorton.sh - Highway Encounter Remake in Spanish - Tested and works well.
  • - warmux.sh - Worms Clone - Tested and works well. Possible issues with config files in wrong places?
  • - weechat.sh - Console IRC Client - Tested and works well.
  • - wizznic.sh - Puzznic clone - Tested and works well.
  • - xash3d-fwgs.sh - Half-Life engine source port.
  • - zeldansq.sh - Zelda: Navi's Quest fangame - Tested and works well.
  • - zeldapicross.sh - Zelda themed Picross fangame - Tested and works well, may require keyboard.

Supplementary

  • - fun-facts-splashscreens.sh - Set up some loading splashscreens with fun facts.
  • - joystick-selection.sh - Set controllers for RetroArch players 1-4.
  • - screenshot.sh - Take screenshots remotely through SSH - Tested and works well.

Future To-Do List

I've moved this over to the TODO.md file.

Hall of Fame - Scripts accepted into RetroPie-Setup

  • - LXDE - LXDE Desktop.
  • - SimCoupe - Sam Coupe Emulator.
  • - Oricutron - Oric 1/Oric Atmos emulator.
  • - sdltrs - Radio Shack TRS-80 Model I/III/4/4P emulator.
  • - ti99sim - Texas Instruments 99A emulator.

Contact Info / Additional Information

  • Twitter: @zerojay - Often posting new information and additions from the repository to the #retropie hashtag.
  • IRC: zerojay on irc.freenode.net, #retropie/#retropie-extra.

If you wish to be up-to-date about all the changes happening to the repository as they happen, feel free to join the #retropie-extra channel on Freenode.