diff --git a/dist-scripts/retroarch-360-README.txt b/dist-scripts/retroarch-360-README.txt new file mode 100644 index 0000000000..b49abcea34 --- /dev/null +++ b/dist-scripts/retroarch-360-README.txt @@ -0,0 +1,201 @@ +------------------------------------------------------------------------------ +RETROARCH 360 - 0.9.8.3 +------------------------------------------------------------------------------ +RetroConsole Level: 2 +Author: Themaister, Squarepusher/Twin Aphex +------------------------------------------------------------------------------ + +------------------------------------------------------------------------------ +HOW TO INSTALL THIS +------------------------------------------------------------------------------ +Copy the entire folder to your harddrive. + +ROMs go into the 'roms' directory, or some subdirectory in the RetroArch-360 +directory. + +------------------------------------------------------------------------------ +HOW TO USE THIS +------------------------------------------------------------------------------ +On first startup, RetroArch will select one of the dozen or so +emulator/game cores. The name of the core currently loaded will be +shown at the bottom side of the screen. + +You can now select a ROM that this core supports and load it in the Filebrowser. + +To select a different core - go to 'Change Libretro core' in the Main Menu. +Press A to go to a filebrowser where you can select a different core. Press A +to switch to the emulator/game core. + +------------------------------------------------------------------------------ +INGAME CONTROLS +------------------------------------------------------------------------------ +During ingame operation you can do some extra actions: + +Right Thumb Stick - Down - Fast-forwards the game +Right Thumb Stick - Up - Rewinds the game in real-time + ('Rewind' has to be enabled in the 'Settings' + screen - warning - comes at a slight + performance decrease but will be worth it + if you love this feature) +RStick Left + RT - Decrease save state slot +Rtick Right + RT - Increase save state slot +RStick Up + RT - Load selected save state slot +RStick Down + RT - Save selected save state slot +Right Thumb + Left Thumb - Go back to 'Menu'/'Quick Menu' + +------------------------------------------------------------------------------ +WHAT IS RETROARCH? +------------------------------------------------------------------------------ +RetroArch is a modular multi-system emulator system that is designed to +be fast, lightweight and portable. It has features few other emulator +frontends have, such as real-time rewinding and game-aware shading. + +------------------------------------------------------------------------------ +WHAT IS LIBRETRO? +------------------------------------------------------------------------------ +Libretro is the API that RetroArch uses. It makes it easy to port games +and emulators to a single core backend, such as RetroArch. + +For the user, this means - more ports to play with, more crossplatform +portability, less worrying about developers having to reinvent the wheel +writing boilerplate UI/port code - so that they can get busy with writing +the emulator/porting the emulator/game. + +------------------------------------------------------------------------------ +WHAT'S THE BIG DEAL? +------------------------------------------------------------------------------ +Right now it's unique in that it runs the same emulator cores on +multiple systems (such as Xbox 360, PS3, PC, Wii, etc). + +For each emulator 'core', RetroArch makes use of a library API that we +like to call 'libretro'. + +Think of libretro as an interface for emulator and game ports. You can +make a libretro port once and expect the same code to run on all the +platforms that RetroArch supports. It's designed with simplicity and +ease of use in mind so that the porter can worry about the port at hand +instead of having to wrestle with an obfuscatory API. + +The purpose of libretro is to help ease the work of the emulator/game +porter by giving him an API that allows him to target multiple platforms +at once without having to redo any code. He doesn't have to worry about +writing input/video/audio drivers - all of that is supplied to him by +RetroArch. All he/she has to do is to have the emulator port hook +into the libretro API and that's it - we take care of the rest. + +------------------------------------------------------------------------------ +XBOX 360 PORT +------------------------------------------------------------------------------ +The Xbox 360 port of RetroArch has the following features: + +- Real-time rewinding +- Switching between emulator cores seamlessly, and ability to install +new libretro cores + +Included with RetroArch 360 are a bunch of shaders - including the latest +version of the popular xBR shader. It is possible to use two shaders +simultaneously to get the best possible graphical look. + +------------------------------------------------------------------------------ +EMULATOR/GAME CORES BUNDLED WITH XBOX 360 PORT +------------------------------------------------------------------------------ +The following emulators/games have been ported to RetroArch and are included in +the Xbox 360 release of RetroArch. + +For more information about them, see the included +'retroarch-libretro-README.txt' file. + +- Final Burn Alpha (Arcade - various) [version 0.2.97.28] +- FCEUmm (Nintendo Entertainment System) [recent SVN version] +- NEStopia (Nintendo Entertainment System) [1.44] +- Gambatte (Game Boy | Super Game Boy | Game Boy Color) [version 0.5.0 WIP] +- Genesis Plus GX (Sega SG-1000 | Master System | Game Gear | Genesis/Mega Drive | + Sega CD) [version 1.7.3] +- SNES9x Next (Super Nintendo/Super Famicom) +- VBA Next (Game Boy Advance) +- Prboom (for playing Doom 1/Doom 2/Ultimate Doom/Final Doom) +- Mednafen PCE Fast (PC Engine/PC Engine CD/Turbografx 16) +- Mednafen Wonderswan (WonderSwan/WonderSwan Color/WonderSwan Crystal) +- Mednafen NGP (Neo Geo Pocket Color) + +All of the emulators listed above are the latest versions currently +available. Most of them have been specifically optimized so that +they will run better on 360 (some games would not reach fullspeed +without these optimizations). + +------------------------------------------------------------------------------ +WHAT EXTENSIONS ARE SUPPORTED BY EACH CORE +------------------------------------------------------------------------------ +- Prboom WAD|wad +- SNES9x Next smc|fig|sfc|gd3|gd7|dx2|bsx|swc|zip|SMC|FIG|SFC|BSX|GD3| + GD7|DX2|SWC +- Genesis Plus GX md|smd|bin|gen|zip|MD|SMD|bin|GEN|ZIP|sms|SMS|gg|GG|sg|SG| + cue|CUE +- VBA Next GBA|gba +- FCEUmm nes|NES|unif|UNIF +- NEStopia nes|NES|fds|FDS +- Gambatte gb|gbc|dmg|zip|GB|GBC|DMG|ZIP +- Final Burn Alpha zip|ZIP +- Mednafen PCE pce|PCE|cue|CUE +- Mednafen Wonderswan ws|WS|wsc|WSC +- Mednafen NGP ngp|NGP + +------------------------------------------------------------------------------ +ZIP SUPPORT +------------------------------------------------------------------------------ +Selecting a ZIP file will temporarily unzip that file to the harddrive. The +temporary file will be deleted as soon as the game gets unloaded and/or when +you quit RetroArch. + +NOTE: For the FBA core (and other cores that have 'block_extract' set to +true) - selecting a ZIP file from the Filebrowser will load that game +directly. + +------------------------------------------------------------------------------ +Troubleshooting +------------------------------------------------------------------------------ + +If you find that RetroArch no longer works for whatever reason, there is +a way to get it back to work - + +- Remove retroarch.cfg from the 'Retroarch-360' folder, then start up again. +The Libretro management service in RetroArch should automatically pick a +random libretro core and write this to the config file. + +------------------------------------------------------------------------------ +What can you expect in the future? +------------------------------------------------------------------------------ +- Do a Blackberry Playbook/Blackberry 10 RetroArch port +- Do an iOS port of RetroArch (will need hardware for this - gifts appreciated) +- Make the libxenon port release-worthy. +- Add console-friendly features (nicely formatted names for FBA, some better +way to do core switching, etc) +- Fix NxEngine issues on consoles +- Finish up MAME 0.72 port +- Finish up ScummVM port +- Port of VICE to libretro +- More emulators, more games that will run on RetroArch +- Lots of other crazy ideas that might or might not pan out + +------------------------------------------------------------------------------ +Credits +------------------------------------------------------------------------------ +- Mudlord for his Waterpaint/Noise shaders. +- Hyllian for the xBR shader. +- Opium2k for the nice manual shaders (bundled with PS3 release). +- Deank for assistance with RetroArch Salamander on CFW PS3s and + Multiman interoperability. +- FBA devs for adopting the libretro port. +- Ekeeke for help with the Genesis Plus GX port. +- ToadKing for having done a lot of work on RetroArch Wii. +- Freakdave for helping out with the Xbox 1 port. + +------------------------------------------------------------------------------ +Websites +------------------------------------------------------------------------------ +Twitter: http://twitter.com/libretro +Source: http://github.com/libretro +Homepage: http://www.libretro.org +IRC: #retroarch (freenode) + +------------------------------------------------------------------------------ diff --git a/dist-scripts/retroarch-CHANGELOG.txt b/dist-scripts/retroarch-CHANGELOG.txt new file mode 100644 index 0000000000..ce5aa01f3d --- /dev/null +++ b/dist-scripts/retroarch-CHANGELOG.txt @@ -0,0 +1,124 @@ +RETROARCH CONSOLE +------------------------------------------------------------------------------ +v0.9.8.3 +------------------------------------------------------------------------------ +* [FBA core] Various changes/fixes +- Hook up Armed Police Batrider controls +- Afterburner - make fire buttons work +- Hook up Bad Dudes controls +- Hook up Cyberbots controls +- Hook up 1942 controls +- Add missing Chase HQ controls +- Add missing WWF Wrestlefest controls +- EEPROM save should now work (tested with EEPROM-based system such as Capcom CPS2) +- Samples are now looked for - should be in 'samples' subdirectory +- Hiscore files should now be read from/written to. +* [SNES9x Next] Added big speed hack for Star Fox 1 - makes it fast enough for it to run at fullspeed on the Wii. +* [Genesis Plus GX] Set samplerate back to 44Khz. +* [Android] New 'Calibrate Refresh Rate' option - use this to get an accurate estimation of your screen refresh rate. NOTE: Touch the screen at all times during calibration for more accurate measurements. You might have to slightly tweak the value later on for the best results. +* [Android] Added a 'Set OS-reported refresh rate' which should do the same as what 'Sync refreshrate to Screen' previously did. Note 2 users might get better results with this than they will with 'Calibrate refresh rate'. +* [Android] Added a built-in help system that should answer a lot of the frequently asked questions. +* ]Android] Add iCade profiles - two added for now - iPega and Red Samurai +* [Android] Audio resampler now faster +* [Android] Input autodetection expanded - +* [CONSOLES] Audio resampler is now adjustable - can choose between Sinc resampler (new) and Hermite resampler (old). Sinc is now selected by default, is superior audio-quality wise and will fix a lot of sound issues. +* [PS3] Save Preset fixed +* [PS3] Starting with Dual Shader/Custom Scaling mode OFF and then turning it ON works now +* [Wii] Numerous Wii video mode fixes - including PAL modes that went beyond the internal framebuffer bounds +- PC2JAMMA-USB (needs to be tested) +- Genius MaxFire G-08XU +- Zeemote Steelseries +- Saitek Rumblepad +- Super Smart Joy + +------------------------------------------------------------------------------ +v0.9.8.1 +------------------------------------------------------------------------------ +- (Android) Lots of changes - too numerous to list +- [FBA] Fixed serious bug that would cause a lot of games to get stuck +in service mode or to display graphical corruption (CPS1). +- [NEStopia] Now outputs in mono sound mode. +- [FCEUmm] Uses RGB565 now - should no longer flicker on RMenu. +- [Mednafen PC Engine Fast] Fixed libretro issue where certain games +had totally wrong pitch +- [Mednafen Wonderswan] Core fixed, works again. +- [Genesis Plus GX] Set audio samplerate at 48KHz (from 44KHz). +- [PS3] Fixed serious bugs where it could get 'stuck' or the app could +'hang' while toggling between ingame and quickmenu/file browser. +- [PS3] Added 'Menu Skins' to 'Retro Settings' - will allow you to +select a different background for the menu. Captain CPS-X's menu skin +is also included. +- [Wii] Fixes serious analog stick issues with CC Pro/CC. +- [Wii] Added additional resolutions - 304x224, 576x224, 608x224 +- [Wii] More natural way to switch between cores +------------------------------------------------------------------------------ +v0.9.8 +------------------------------------------------------------------------------ +- (Android) Initial release of RetroArch Android. +- [LIBRETRO] Added Mednafen NGP and Mednafen VB. +- [LIBRETRO] Added NEStopia Undead (1.44). +- [LIBRETRO] Updated Mednafen PCE Fast and Mednafen Wonderswan to 0.9.28. +- [LIBRETRO] Added PCSX ReARMed for RetroArch Android. +- [FBA] Updated Final Burn Alpha to 0.9.27.28. +- [Gambatte] Updated Gambatte (now has built-in GBC BIOS color palettes). +- [SNES9x Next] Updated SNES9x Next (fixes numerous bugs). +- [FCEUmm] Updated FCEUmm to latest version. +- [Genesis Plus GX] Updated Genesis Plus GX to latest version. +- (360) Gamma correction can now be applied on-the-fly - no longer requires +reboots +- (360) Added new shaders - mudlord-oldtvshader-variant, crt-curved, and +others +- (360) Added 'SRAM dir Enable' option - allows you to save all your SRAM to +game:/sram instead of the ROM directory +- (360) Added 'SRAM dir Enable' option - allows you to save all your states to +game:/savestates +- (RARCH_CONSOLE) Various stability fixes +- (RARCH_CONSOLE) More sane unzipping mode - will temporarily extract file to +HDD and then instantly delete it when it's done with it (ie. when another ROM +gets loaded or when RetroArch shuts down) +- (RARCH_CONSOLE) All console ports now use 59.94Hz for synchronization on +the RetroArch side instead of 59.92Hz as before. All consoles use 59.94Hz +so this agrees better with them. +- (PS3) Added PAL60 temporal PAL mode +- (PS3) Fixed a lot of path issues - SRAM/savestate dir enable now work, +'Default ROM directory' should now work, etc. +- (PS3) Added rewind granularity options +- (PS3) Rewrote video driver from scratch (RGL v2). Faster blitting. +- (PS3) Onscreen keyboard should work again. +- (WII) Made a custom wiiuse input driver and built it in. Slimmed down +and should give better results. Also rejigged input in general. +- (WII) Added rewind option. NOTE: This feature is CPU intensive - a core +might need to at least run at double realtime FPS in order for this option +to be useful. +- (WII) Button combos can now be done ingame. You can do rewinding, fast +forwarding, selecting save state slots and 'save state load/save state save' +all ingame without first going to the menu. For more information, read the +README.txt for the Wii release. +------------------------------------------------------------------------------ +v0.9.7.1 +------------------------------------------------------------------------------ +- (FBAcores CPS1) Sound crackling/popping fixed +- (FBACores CPS2) Sound crackling/popping fixed +- (FBACores NeoGeo) Sound crackling/popping fixed +- (WII) Fixed left/right audio channels being in reverse issue +- (WII) Filebrowser now filters by core supported extensions +- (WII) Fixed filebrowser performance issues in v0.9.7 +------------------------------------------------------------------------------ +v0.9.7 +------------------------------------------------------------------------------ +- (XBOX 1/Wii) Made an Xbox 1/Wii port. +- (LIBRETRO) Added Mednafen PCE FAST, and Mednafen Wonderswan cores +- (360) Added Genesis Plus GX to official 360 release +- (Genesis Plus GX) Updated to v1.7.0 +- (PS3) Improved GUI +- (360) Improved UI +- (ALL) Improved stability / error trapping +- (ALL) ZIP extract modes expanded - it can extract the contents of a ZIP file to +the current directory, and/or extract to current dir and immediately load the +first ROM/game file. +- Too many things to mention + +------------------------------------------------------------------------------ +v0.9.6 +------------------------------------------------------------------------------ +- (PS3/360) Initial release of RetroArch PS3/360. diff --git a/dist-scripts/retroarch-ps3-README.txt b/dist-scripts/retroarch-ps3-README.txt new file mode 100644 index 0000000000..bef61e3d54 --- /dev/null +++ b/dist-scripts/retroarch-ps3-README.txt @@ -0,0 +1,237 @@ +------------------------------------------------------------------------------ +RETROARCH PS3 - 0.9.8.3 +------------------------------------------------------------------------------ +RetroConsole Level: 2 +Author: Themaister, Squarepusher/Twin Aphex +------------------------------------------------------------------------------ + +------------------------------------------------------------------------------ +HOW TO INSTALL THIS +------------------------------------------------------------------------------ + +------------------------------------------------------------------------------ +ON DEBUG (DEX) PS3 +------------------------------------------------------------------------------ +Put the PKG file 'retroarch-ps3-v0.9.8.3-dex.pkg' on your +USB stick, put it in your PS3. Go to the PS3 XMB - go to the +Game tab - Select 'Install Packages', and install the PKG file. + +------------------------------------------------------------------------------ +ON CFW P3 +------------------------------------------------------------------------------ +Put the PKG file 'retroarch-ps3-v0.9.8.3-cfw.pkg' on your +USB stick. Put it in your CFW PS3. Go to the PS3 XMB - go to the +Game tab - select 'Install Packages', and install the PKG file. + +NOTE: The official release no longer supports Geohot/Wutangzra +CFWs. If you must use them, you have to do pkg_finalize on the PKG +to install it. + +------------------------------------------------------------------------------ +HOW TO USE THIS +------------------------------------------------------------------------------ +On first startup, RetroArch will select one of the dozen or +so emulator/game cores. The name of the core currently loaded will +be shown at the top side of the screen. + +You can now select a ROM that this core supports and load it in +the Filebrowser. + +To select a different core in the menu - press Select to go to the +Settings screen. From here, go to the 'Retro tab', and select +'Default emulator core'. Press X to go to a filebrowser where you +can select a different core. Press X to confirm, then exit +RetroArch. Start up again to boot up to the new emulator core. + +To change to a different core ingame - press R3 to bring up +the 'Quick Menu'. Select 'Change libretro core'. Press X to +go to a filebrowser where you can select a different core. + +------------------------------------------------------------------------------ +INGAME CONTROLS +------------------------------------------------------------------------------ +During ingame operation you can do some extra actions: + +Right Thumb Stick - Down - Fast-forwards the game +Right Thumb Stick - Up - Rewinds the game in real-time + ('Rewind' has to be enabled in the + 'Settings' menu - warning - comes at a + performance decrease but will be worth it + if you love this feature) +RStick Left + R2 - Decrease save state slot +Rtick Right + R2 - Increase save state slot +RStick Up + R2 - Load selected save state slot +RStick Down + R2 - Save selected save state slot +L3 + R3 - Go back to 'Menu'/'Quick Menu' + +------------------------------------------------------------------------------ +WHAT IS RETROARCH? +------------------------------------------------------------------------------ +RetroArch is a modular multi-system emulator system that is +designed to be fast, lightweight and portable. It has features +few other emulator frontends have, such as real-time rewinding +and game-aware shading. + +------------------------------------------------------------------------------ +WHAT IS LIBRETRO? +------------------------------------------------------------------------------ +Libretro is the API that RetroArch uses. It makes it easy to +port games and emulators to a single core backend, such as +RetroArch. + +For the user, this means - more ports to play with, more +crossplatform portability, less worrying about developers having +to reinvent the wheel writing boilerplate UI/port code - so that +they can get busy with writing the emulator/porting the emulator/game. + +------------------------------------------------------------------------------ +WHAT'S THE BIG DEAL? +------------------------------------------------------------------------------ +Right now it's unique in that it runs the same emulator cores on +multiple systems (such as Xbox 360, PS3, PC, Wii, Xbox 1, etc). + +For each emulator 'core', RetroArch makes use of a library API that +we like to call 'libretro'. + +Think of libretro as an interface for emulator and game ports. You +can make a libretro port once and expect the same code to run on all +the platforms that RetroArch supports. It's designed with simplicity +and ease of use in mind so that the porter can worry about the port +at hand instead of having to wrestle with an obfuscatory API. + +The purpose of libretro is to help ease the work of the emulator/game +porter by giving him an API that allows him to target multiple +platforms at once without having to redo any code. He doesn't have +to worry about writing input/video/audio drivers - all of that is +supplied to him by RetroArch. All he has to do is to have the emulator +port hook into the libretro API and that's it - we take care of the rest. + +------------------------------------------------------------------------------ +PLAYSTATION3 PORT +------------------------------------------------------------------------------ +The PS3 port of RetroArch is one of the most developed console ports +of RetroArch. + +A couple of unique features RetroArch PS3 boasts that is not commonly +found anywhere else: + +- Game-aware shading in every emulator now (*) +- Real-time rewinding +- More shader features (motion blurring, etc) +- Switching between emulator cores seamlessly, and ability to install new + libretro cores + +Included with RetroArch PS3 are a bunch of shaders - including the +latest versions of the popular xBR shader. It is possible to use two +shaders simultaneously to get the best possible graphical look. + +* Check out Opium2k's manual shaders for Zelda 3 and others - you can +find DLC packs for RetroArch at this site: + +https://code.google.com/p/retro-arch/ + +------------------------------------------------------------------------------ +EMULATOR/GAME CORES BUNDLED WITH PS3 PORT +------------------------------------------------------------------------------ +The following emulators have been ported to RetroArch and are included +in the PS3 release of RetroArch. + +For more information about them, see the included +'retroarch-libretro-README.txt' file. + +- Final Burn Alpha (Arcade - various) [version 0.2.97.28] +- FCEUmm (Nintendo Entertainment System) [recent SVN version] +- NEStopia (Nintendo Entertainment System) [1.44] +- Gambatte (Game Boy | Super Game Boy | Game Boy Color) [version 0.5.0 WIP] +- Genesis Plus GX (Sega SG-1000 | Master System | Game Gear | Genesis/Mega Drive | + Sega CD) [version 1.7.3] +- SNES9x Next (Super Nintendo/Super Famicom) +- VBA Next (Game Boy Advance) +- Prboom (for playing Doom 1/Doom 2/Ultimate Doom/Final Doom) +- Mednafen PCE Fast (PC Engine/PC Engine CD/Turbografx 16) +- Mednafen Wonderswan (WonderSwan/WonderSwan Color/WonderSwan Crystal) +- Mednafen NGP (Neo Geo Pocket Color) +- Mednafen VB (Virtual Boy) + +All of the emulators listed above are the latest versions currently +available. Most of them have been specifically optimized so that they +will run better on PS3 (some games would not reach fullspeed without these optimizations). + +------------------------------------------------------------------------------ +WHAT EXTENSIONS ARE SUPPORTED BY EACH CORE +------------------------------------------------------------------------------ +- Prboom WAD|wad +- SNES9x Next smc|fig|sfc|gd3|gd7|dx2|bsx|swc|zip|SMC|FIG|SFC|BSX|GD3| + GD7|DX2|SWC +- Genesis Plus GX md|smd|bin|gen|zip|MD|SMD|bin|GEN|ZIP|sms|SMS|gg|GG|sg|SG| + cue|CUE +- VBA Next GBA|gba +- FCEUmm nes|NES|unif|UNIF +- NEStopia nes|NES|fds|FDS +- Gambatte gb|gbc|dmg|zip|GB|GBC|DMG|ZIP +- Final Burn Alpha zip|ZIP +- Mednafen PCE pce|PCE|cue|CUE +- Mednafen Wonderswan ws|WS|wsc|WSC +- Mednafen NGP ngp|NGP +- Mednafen VB vb|VB + +------------------------------------------------------------------------------ +ZIP SUPPORT +------------------------------------------------------------------------------ +Selecting a ZIP file will temporarily unzip that file to the harddrive. The +temporary file will be deleted as soon as the game gets unloaded and/or when +you quit RetroArch. + +NOTE: For the FBA core (and other cores that have 'block_extract' set to +true) - selecting a ZIP file from the Filebrowser will load that game +directly. + +------------------------------------------------------------------------------ +Troubleshooting +------------------------------------------------------------------------------ + +If you find that RetroArch no longer works for whatever reason, there is +a way to get it back to work - + +- Remove retroarch.cfg from the 'SSNE100000' folder, then start up again. +The Libretro management service in RetroArch should automatically pick a +random libretro core and write this to the config file. + +------------------------------------------------------------------------------ +What can you expect in the future? +------------------------------------------------------------------------------ +- Do a Blackberry Playbook/Blackberry 10 RetroArch port +- Do an iOS port of RetroArch (will need hardware for this - gifts appreciated) +- Make the libxenon port release-worthy. +- Add console-friendly features (nicely formatted names for FBA, some better +way to do core switching, etc) +- Fix NxEngine issues on consoles +- Finish up MAME 0.72 port +- Finish up ScummVM port +- Port of VICE to libretro +- More emulators, more games that will run on RetroArch +- Lots of other crazy ideas that might or might not pan out + +------------------------------------------------------------------------------ +Credits +------------------------------------------------------------------------------ +- Mudlord for his Waterpaint/Noise shaders. +- Hyllian for the xBR shader. +- Opium2k for the nice manual shaders (bundled with PS3 release). +- Deank for assistance with RetroArch Salamander on CFW PS3s and + Multiman interoperability. +- FBA devs for adopting the libretro port. +- Ekeeke for help with the Genesis Plus GX port. +- ToadKing for having done a lot of work on RetroArch Wii. +- Freakdave for helping out with the Xbox 1 port. + +------------------------------------------------------------------------------ +Websites +------------------------------------------------------------------------------ +Twitter: http://twitter.com/libretro +Source: http://github.com/libretro +Homepage: http://www.libretro.org +Opium2K DLC for RetroArch: https://code.google.com/p/retro-arch/ +IRC: #retroarch (freenode) + +------------------------------------------------------------------------------ diff --git a/dist-scripts/retroarch-wii-readme.txt b/dist-scripts/retroarch-wii-readme.txt new file mode 100644 index 0000000000..eb28304084 --- /dev/null +++ b/dist-scripts/retroarch-wii-readme.txt @@ -0,0 +1,237 @@ +------------------------------------------------------------------------------ +RETROARCH WII - 0.9.8.3 +------------------------------------------------------------------------------ +RetroConsole Level: 1 +Author: Themaister, Toad King, Squarepusher/Twin Aphex +------------------------------------------------------------------------------ + +------------------------------------------------------------------------------ +HOW TO INSTALL THIS +------------------------------------------------------------------------------ +Copy the entire directory (retroarch-wii) to your SD card in your 'apps' +directory. Start up the Homebrew Channel and start up RetroArch Wii from +there. + +On first startup, RetroArch will create a folder in the root of your storage +device called 'retroarch'. All RetroArch configuration files are stored here. + +------------------------------------------------------------------------------ +HOW TO USE THIS +------------------------------------------------------------------------------ +On first startup, RetroArch will select one of the dozen or so +emulator/game cores. The name of the core currently loaded will be +shown at the bottom side of the screen. + +You can now select a ROM that this core supports and load it in the Filebrowser. + +To select a different core - go to the Settings menu (see 'Ingame controls'). +Select the option 'Core' and hit the A button. A filebrowser will appear +where you can select a different core. Press A to switch to the +emulator/game core. + +After doing so, select 'Restart RetroArch' to load the newly selected core. + +------------------------------------------------------------------------------ +CONTROLS +------------------------------------------------------------------------------ +RetroArch Wii will create a new input config file for each core you load. +All input settings will be saved when RetroArch exits. + +NOTE: When starting up a new core for the first time, you might have to first +initialize the input settings. Go to the Settings menu (see 'Ingame controls') +and go to 'Controller #number config'. Re-set the 'Device' by going back and +forth between a previous device. The controls will be automatically applied. + +This only has to be done once per core. + +------------------------------------------------------------------------------ +INGAME CONTROLS +------------------------------------------------------------------------------ +During ingame operation you can do some extra actions: + +Wii Classic Minus - Go to Settings +Wii Classic Controller Home + ZL + ZR - Quit RetroArch +Wii Classic Controller Home - Go back to 'Menu' + +Wiimote Minus - Go to Settings +Wiimote Home - Go back to 'Menu' +Wiimote Home + B - Quit RetroArch + +Gamecube pad Z - Go to Settings +Gamecube pad L + R + LStick Up + Rstick Up - Go back to 'Menu' +Gamecube pad L + R + LStick Down + Rstick Down - Quit RetroArch + +Right Thumb Stick - Down - Fast-forwards the game +Right Thumb Stick - Up - Rewinds the game in real-time + ('Rewind' has to be enabled in the + 'Settings' menu - warning - comes at a + performance decrease but will be worth it + if you love this feature) +RStick Left + ZL - Decrease save state slot +Rtick Right + ZR - Increase save state slot +RStick Up + ZR - Load selected save state slot +RStick Down + ZR - Save selected save state slot + +(NOTE: For Gamecube pads - you would press Z trigger + any of the Rstick +Down movements shown above instead of ZR/ZL) + +------------------------------------------------------------------------------ +WHAT IS RETROARCH? +------------------------------------------------------------------------------ +RetroArch is a modular multi-system emulator system that is designed to +be fast, lightweight and portable. + +------------------------------------------------------------------------------ +WHAT IS LIBRETRO? +------------------------------------------------------------------------------ +Libretro is the API that RetroArch uses. It makes it easy to port games +and emulators to a single core backend, such as RetroArch. + +For the user, this means - more ports to play with, more crossplatform +portability, less worrying about developers having to reinvent the wheel +writing boilerplate UI/port code - so that they can get busy with writing +the emulator/porting the emulator/game. + +------------------------------------------------------------------------------ +WHAT'S THE BIG DEAL? +------------------------------------------------------------------------------ +Right now it's unique in that it runs the same emulator cores on +multiple systems (such as Xbox 360, Xbox 1, PS3, PC, Wii, Android, +etc). + +For each emulator 'core', RetroArch makes use of a library API that we +like to call 'libretro'. + +Think of libretro as an interface for emulator and game ports. You can +make a libretro port once and expect the same code to run on all the +platforms that RetroArch supports. It's designed with simplicity and +ease of use in mind so that the porter can worry about the port at hand +instead of having to wrestle with an obfuscatory API. + +The purpose of libretro is to help ease the work of the emulator/game +porter by giving him an API that allows him to target multiple platforms +at once without having to redo any code. He doesn't have to worry about +writing input/video/audio drivers - all of that is supplied to him by +RetroArch. All he has to do is to have the emulator port hook into the +libretro API and that's it - we take care of the rest. + +------------------------------------------------------------------------------ +WII PORT +------------------------------------------------------------------------------ +The Wii port of RetroArch has the following features: + +- Real-time rewinding +- Switching between emulator cores seamlessly, and ability to install +new libretro cores + +------------------------------------------------------------------------------ +EMULATOR/GAME CORES BUNDLED WITH WII PORT +------------------------------------------------------------------------------ +The following emulators/games have been ported to RetroArch and are included in +the Wii release of RetroArch. + +For more information about them, see the included +'retroarch-libretro-README.txt' file. + +- Final Burn Alpha [version 0.2.97.28] +- Final Burn Alpha Cores (CPS1 - CPS2 - NeoGeo) [version 0.2.97.28] (**) +- FCEUmm (Nintendo Entertainment System) [recent SVN version] +- NEStopia (Nintendo Entertainment System) [1.44] +- Gambatte (Game Boy | Super Game Boy | Game Boy Color) [version 0.5.0 WIP] +- Genesis Plus GX (Sega SG-1000 | Master System | Game Gear | Genesis/Mega Drive | + Sega CD) [version 1.7.3] +- SNES9x Next (Super Nintendo/Super Famicom) +- VBA Next (Game Boy Advance) (*) +- Prboom (for playing Doom 1/Doom 2/Ultimate Doom/Final Doom) +- Mednafen PCE Fast (PC Engine/PC Engine CD/Turbografx 16) +- Mednafen Wonderswan (WonderSwan/WonderSwan Color/WonderSwan Crystal) +- Mednafen NGP (Neo Geo Pocket Color) +- Mednafen VB (Virtual Boy) + +All of the emulators listed above are the latest versions currently +available. Most of them have been specifically optimized so that +they will run better on Wii (some games would not reach fullspeed +without these optimizations). + +* Some games don't run at fullspeed on Wii (VBA Next is a +RetroConsole Level 2 emulator port). +** The biggest Neo-Geo ROMs that can be loaded are around 23+MB in +size, such as Real Bout Fatal Fury 1 and King of Fighters '96. + +------------------------------------------------------------------------------ +WHAT EXTENSIONS ARE SUPPORTED BY EACH CORE +------------------------------------------------------------------------------ +- Prboom WAD|wad +- SNES9x Next smc|fig|sfc|gd3|gd7|dx2|bsx|swc|zip|SMC|FIG|SFC|BSX|GD3| + GD7|DX2|SWC +- Genesis Plus GX md|smd|bin|gen|zip|MD|SMD|bin|GEN|ZIP|sms|SMS|gg|GG|sg|SG| + cue|CUE +- VBA Next GBA|gba +- FCEUmm nes|NES|unif|UNIF +- NEStopia nes|NES|fds|FDS +- Gambatte gb|gbc|dmg|zip|GB|GBC|DMG|ZIP +- Final Burn Alpha zip|ZIP +- Mednafen PCE pce|PCE|cue|CUE +- Mednafen Wonderswan ws|WS|wsc|WSC +- Mednafen NGP ngp|NGP +- Mednafen VB vb|VB + +------------------------------------------------------------------------------ +ZIP SUPPORT (IN GENERAL) +------------------------------------------------------------------------------ +Selecting a ZIP file will temporarily unzip that file to the harddrive. The +temporary file will be deleted as soon as the game gets unloaded and/or when +you quit RetroArch. + +NOTE: For the FBA core (and other cores that have 'block_extract' set to +true) - selecting a ZIP file from the Filebrowser will load that game +directly. + +------------------------------------------------------------------------------ +Troubleshooting +------------------------------------------------------------------------------ + +If you find that RetroArch no longer works for whatever reason, there is +a way to get it back to work - + +- Remove retroarch.cfg from the 'retroarch' folder on your storage device, +then start up again. The Libretro management service in RetroArch should +automatically pick a random libretro core and write this to the config file. + +------------------------------------------------------------------------------ +What can you expect in the future? +------------------------------------------------------------------------------ +- Do a Blackberry Playbook/Blackberry 10 RetroArch port +- Do an iOS port of RetroArch (will need hardware for this - gifts appreciated) +- Make the libxenon port release-worthy. +- Add console-friendly features (nicely formatted names for FBA, some better +way to do core switching, etc) +- Fix NxEngine issues on consoles +- Finish up MAME 0.72 port +- Finish up ScummVM port +- Port of VICE to libretro +- More emulators, more games that will run on RetroArch +- Lots of other crazy ideas that might or might not pan out + +------------------------------------------------------------------------------ +Credits +------------------------------------------------------------------------------ +- Hyllian for the xBR shader family. +- Opium2k for the nice manual shaders (bundled with PS3 release). +- Deank for assistance with RetroArch Salamander on CFW PS3s and +- Mudlord for his Waterpaint/Noise shaders. + Multiman interoperability. +- FBA devs for adopting the libretro port. +- Ekeeke for help with the Genesis Plus GX port. +- ToadKing for having done a lot of work on RetroArch Wii. +- Freakdave for helping out with the Xbox 1 port. + +------------------------------------------------------------------------------ +Websites +------------------------------------------------------------------------------ +Twitter: http://twitter.com/libretro +Source: http://github.com/libretro +Homepage: http://www.libretro.org +IRC: #retroarch (freenode) + +------------------------------------------------------------------------------ diff --git a/dist-scripts/retroarch-xbox1-README.txt b/dist-scripts/retroarch-xbox1-README.txt new file mode 100644 index 0000000000..f60efa1329 --- /dev/null +++ b/dist-scripts/retroarch-xbox1-README.txt @@ -0,0 +1,229 @@ +------------------------------------------------------------------------------ +RETROARCH XBOX 1 - 0.9.8.3 +------------------------------------------------------------------------------ +RetroConsole Level: 1 +Author: Themaister, Squarepusher/Twin Aphex, Freakdave +------------------------------------------------------------------------------ + +------------------------------------------------------------------------------ +HOW TO INSTALL THIS +------------------------------------------------------------------------------ +Copy the entire folder ('RetroArch-XB1') to your harddrive. + +ROMs go into the 'roms' directory, or some subdirectory in the 'RetroArch-XB1' +directory. + +------------------------------------------------------------------------------ +HOW TO USE THIS +------------------------------------------------------------------------------ +On first startup, RetroArch will select one of the dozen or so +emulator/game cores. The name of the core currently loaded will be +shown at the bottom side of the screen. + +You can now select a ROM that this core supports and load it in the Filebrowser. + +There are two ways of selecting a different core: + +1) 'Change Libretro core' in the Main Menu + +Go to the Settings menu by pressing [Select], go forwards two pages by pressing +he [R Trigger] until you come across 'Default libretro core'. Press A to go to +a filebrowser where you can select a different core. Press [A button] to switch +to the emulator/game core. + +2) From the Ingame Menu + +While playing a game, press the [Right Thumb] button. Select 'Change libretro core' +with the [A button] and select a different core. + +------------------------------------------------------------------------------ +INGAME CONTROLS +------------------------------------------------------------------------------ +During ingame operation you can do some extra actions: + +Right Thumb Stick - Down - Fast-forwards the game +Right Thumb Stick - Up - Rewinds the game in real-time + ('Rewind' has to be enabled in the 'Settings' + screen - warning - comes at a slight + performance decrease but will be worth it + if you love this feature) +RStick Left + RT - Decrease save state slot +Rtick Right + RT - Increase save state slot +RStick Up + RT - Load selected save state slot +RStick Down + RT - Save selected save state slot +Right Thumb + Left Thumb - Go back to 'Menu'/'Quick Menu' + +------------------------------------------------------------------------------ +FILE BROWSER EXTRA CONTROLS +------------------------------------------------------------------------------ + +Left Trigger - Go to previous drive mapping +Right Trigger - Go to next drive mapping + +White - Scroll list up +Black - Scroll list down + +------------------------------------------------------------------------------ +WHAT IS RETROARCH? +------------------------------------------------------------------------------ +RetroArch is a modular multi-system emulator system that is designed to +be fast, lightweight and portable. It has features few other emulator +frontends have, such as real-time rewinding and game-aware shading. + +------------------------------------------------------------------------------ +WHAT IS LIBRETRO? +------------------------------------------------------------------------------ +Libretro is the API that RetroArch uses. It makes it easy to port games +and emulators to a single core backend, such as RetroArch. + +For the user, this means - more ports to play with, more crossplatform +portability, less worrying about developers having to reinvent the wheel +writing boilerplate UI/port code - so that they can get busy with writing +the emulator/porting the emulator/game. + +------------------------------------------------------------------------------ +WHAT'S THE BIG DEAL? +------------------------------------------------------------------------------ +Right now it's unique in that it runs the same emulator cores on +multiple systems (such as Xbox 360, Xbox 1, PS3, PC, Wii, etc). + +For each emulator 'core', RetroArch makes use of a library API that we +like to call 'libretro'. + +Think of libretro as an interface for emulator and game ports. You can +make a libretro port once and expect the same code to run on all the +platforms that RetroArch supports. It's designed with simplicity and +ease of use in mind so that the porter can worry about the port at hand +instead of having to wrestle with an obfuscatory API. + +The purpose of libretro is to help ease the work of the emulator/game +porter by giving him an API that allows him to target multiple platforms +at once without having to redo any code. He doesn't have to worry about +writing input/video/audio drivers - all of that is supplied to him by +RetroArch. All he has to do is to have the emulator port hook into the +libretro API and that's it - we take care of the rest. + +------------------------------------------------------------------------------ +XBOX 1 PORT +------------------------------------------------------------------------------ +The Xbox 1 port of RetroArch has the following features: + +- Real-time rewinding. +- Switching between emulator cores seamlessly, and ability to install +new libretro cores + +------------------------------------------------------------------------------ +EMULATOR/GAME CORES BUNDLED WITH XBOX 1 PORT +------------------------------------------------------------------------------ +The following emulators/games have been ported to RetroArch and are included in +the Xbox 1 release of RetroArch. + +For more information about them, see the included +'retroarch-libretro-README.txt' file. + +- Final Burn Alpha (Arcade - various) [version 0.2.97.28] +- Final Burn Alpha Cores (CPS1 - CPS2 - Neo - more) [version 0.2.97.28] (***) +- FCEUmm (Nintendo Entertainment System) [recent SVN version] +- NEStopia (Nintendo Entertainment System) [1.44] +- Gambatte (Game Boy | Super Game Boy | Game Boy Color) [version 0.5.0 WIP] +- Genesis Plus GX (Sega SG-1000 | Master System | Game Gear | Genesis/Mega Drive | + Sega CD) [version 1.7.3] +- SNES9x Next (Super Nintendo/Super Famicom) (v1.52.3) (**) +- VBA Next (Game Boy Advance) (*) +- Prboom (for playing Doom 1/Doom 2/Ultimate Doom/Final Doom) +- Mednafen PCE Fast (PC Engine/PC Engine CD/Turbografx 16) +- Mednafen Wonderswan (WonderSwan/WonderSwan Color/WonderSwan Crystal) +- Mednafen NGP (Neo Geo Pocket Color) + +All of the emulators listed above are the latest versions currently +available. Most of them have been specifically optimized so that +they will run better on Xbox 1 (some games would not reach fullspeed +without these optimizations). + +* - VBA Next doesn't run at fullspeed on Wii (VBA Next is a RetroConsole +Level 2 emulator port). It will be replaced by a port of gpSP in the near +future. +** - SuperFX games will not run at fullspeed - a special version of SNES9x +will be developed for Retro Console Level 1 systems. +*** The biggest Neo-Geo ROMs that can be loaded are around 23+MB in +size, such as Real Bout Fatal Fury 1 and King of Fighters '96. + +------------------------------------------------------------------------------ +WHAT EXTENSIONS ARE SUPPORTED BY EACH CORE +------------------------------------------------------------------------------ +- Prboom WAD|wad +- SNES9x Next smc|fig|sfc|gd3|gd7|dx2|bsx|swc|zip|SMC|FIG|SFC|BSX|GD3| + GD7|DX2|SWC +- Genesis Plus GX md|smd|bin|gen|zip|MD|SMD|bin|GEN|ZIP|sms|SMS|gg|GG|sg|SG| + cue|CUE +- VBA Next GBA|gba +- FCEUmm nes|NES|unif|UNIF +- NEStopia nes|NES|fds|FDS +- Gambatte gb|gbc|dmg|zip|GB|GBC|DMG|ZIP +- Final Burn Alpha zip|ZIP +- Mednafen PCE pce|PCE|cue|CUE +- Mednafen Wonderswan ws|WS|wsc|WSC +- Mednafen PCE pce|PCE|cue|CUE +- Mednafen Wonderswan ws|WS|wsc|WSC +- Mednafen NGP ngp|NGP + +------------------------------------------------------------------------------ +ZIP SUPPORT +------------------------------------------------------------------------------ +Selecting a ZIP file will temporarily unzip that file to the harddrive. The +temporary file will be deleted as soon as the game gets unloaded and/or when +you quit RetroArch. + +NOTE: For the FBA core (and other cores that have 'block_extract' set to +true) - selecting a ZIP file from the Filebrowser will load that game +directly. + +------------------------------------------------------------------------------ +Troubleshooting +------------------------------------------------------------------------------ + +If you find that RetroArch no longer works for whatever reason, there is +a way to get it back to work - + +- Remove retroarch.cfg from the 'Retroarch-XB1' folder, then start up again. +The Libretro management service in RetroArch should automatically pick a +random libretro core and write this to the config file. + +------------------------------------------------------------------------------ +What can you expect in the future? +------------------------------------------------------------------------------ +- Do a Blackberry Playbook/Blackberry 10 RetroArch port +- Do an iOS port of RetroArch (will need hardware for this - gifts appreciated) +- Make the libxenon port release-worthy. +- Add console-friendly features (nicely formatted names for FBA, some better +way to do core switching, etc) +- Fix NxEngine issues on consoles +- Finish up MAME 0.72 port +- Finish up ScummVM port +- Port of VICE to libretro +- More emulators, more games that will run on RetroArch +- Lots of other crazy ideas that might or might not pan out + +------------------------------------------------------------------------------ +Credits +------------------------------------------------------------------------------ +- Mudlord for his Waterpaint/Noise shaders. +- Hyllian for the xBR shader. +- Opium2k for the nice manual shaders (bundled with PS3 release). +- Deank for assistance with RetroArch Salamander on CFW PS3s and + Multiman interoperability. +- FBA devs for adopting the libretro port. +- Ekeeke for help with the Genesis Plus GX port. +- ToadKing for having done a lot of work on RetroArch Wii. +- Freakdave for helping out with the Xbox 1 port. + +------------------------------------------------------------------------------ +Websites +------------------------------------------------------------------------------ +Twitter: http://twitter.com/libretro +Source: http://github.com/libretro +Homepage: http://www.libretro.org +IRC: #retroarch (freenode) + +------------------------------------------------------------------------------ + diff --git a/wii/pkg/meta.xml b/wii/pkg/meta.xml index 47e5dbef1a..677c2e8975 100644 --- a/wii/pkg/meta.xml +++ b/wii/pkg/meta.xml @@ -2,7 +2,7 @@ RetroArch GX Maister, Squarepusher, ToadKing - 0.9.8.1 + 0.9.8.3 2012-2013 Multi-system emulator A port of RetroArch to the GameCube/Wii.