Difference between revisions of "WiiSX"

From WiiBrew
Jump to: navigation, search
(beta 2.1)
Line 14: Line 14:
 
'''WiiSX''' is a PSX emulator for the Nintendo Gamecube & Wii brought to you by Wii64Team (emu_kidid, sepp256, tehpola). It is based on various PCSX code bases, see the credits section for specifics.
 
'''WiiSX''' is a PSX emulator for the Nintendo Gamecube & Wii brought to you by Wii64Team (emu_kidid, sepp256, tehpola). It is based on various PCSX code bases, see the credits section for specifics.
  
== Features ==
+
== Progress & Updates ==
*Software Rendered Graphics
+
* Check out http://www.emulatemii.com for the latest news on the progress of this emulator, featuring regular updates and in-depth technical posts on the progress and current features. If you like this emulator, please [http://emulatemii.com/wordpress/?page_id=66 donate] and support the team!
*[http://en.wikipedia.org/wiki/Dynamic_recompilation Dynamic Recompilation]
 
*Sound
 
*Input emulation, of both analogic and standard controllers.
 
*Memory Cards
 
*SD Storage Loading
 
*USB Storage Loading
 
*Samba Loading
 
*Progressive/Widescreen Resolution
 
  
== Instructions ==
+
== Further Information ==
You will need the [http://wiibrew.org/wiki/Homebrew_Channel Homebrew Channel]
+
The emulator can be controlled with any combination of GC controllers, Classic Controllers, Wiimotes with Nunchuks and even just Wiimotes. See the included readme for details on the controls. You can load ROMs and saves from a FAT formatted SD or USB (details on the folders required are in the readme).
  
#Download from http://code.google.com/p/pcsxgc/downloads/list
+
== Developers ==
#Create a folder in the root of your SD card called "wiiSX". Place all of your .bin/.cue game images into the folder "isos" and SCPH1001.BIN(BIOS) into the folder "bios". Create another folder called "saves".
+
We don't want to discourage other people forking and working on the emulator; however, any unofficial builds must not be called "WiiSX" or "CubeSX" nor use the WiiSX or CubeSX logo in order to avoid confusion. For now, we're just releasing a snapshot of the source used to build Beta 2.1, but we're planning on updating the public repository with each commit we've made to our private repository so that everyone can see the progression of the code. This process will begin soon.
#*.bin/.cue/.img/.ccd images are supported.
 
#Create a folder under apps (eg /apps/wiiSX) and place the unpacked boot.dol, icon.png and meta.xml files in that folder.
 
#The memory card files are MCD001.mcr and MCD002.mcr, located at /wiisx/saves . Please note that if these files are not present, the emulator will automatically generate them for you.
 
  
== Button Mapping ==
+
== Current Release & Known Issues ==
 +
* Beta 2.1 was released on July 11th 2010, which addresses various bugs reported in the July 3rd Beta 2.0 release.
 +
* CDDA audio streaming is not implemented
 +
* .CUE is not working from DVD, select the .bin directly
 +
* Final Fantasy VII crashes Dynarec (after first battle)
 +
 
 +
== Currently Achieved Features ==
 +
* Emulation via [http://en.wikipedia.org/wiki/Dynamic_recompilation Dynamic Recompilation] & Interpreter
 +
* Software Rendered Graphics with GX scaling
 +
* SPU and XA Stereo Audio
 +
* Input via Gamecube & Classic Controller & Wiimote + Nunchuck & Wiimote
 +
* Input Emulation for DualShock Controllers (Both Standard & Analog Modes)
 +
* Vibration Feedback
 +
* Configurable input combinations
 +
* DVD/USB/SDGecko/Front-SD/Samba ISO Loading
 +
* Memory Cards
 +
* Save States
 +
* Progressive/Widescreen Resolution
 +
 
 +
== To-do (In order of importance) ==
 +
* Increase Compatibility
 +
* Improve Speed
 +
* Hardware Accelerated Graphics
 +
* Netplay
 +
 
 +
== Installation ==
 +
==== For SD/USB ====
 +
Extract the contents of wiiSX-beta2.1.zip to the root of your SD card/USB
 +
 
 +
Put ISOs (.bin/.cue files) in the directory named /wiisx/isos (All save types will automatically be placed in /wiisx/saves)
 +
 
 +
For actual BIOS: Name your bios "SCPH1001.BIN" and place it on SD/USB in the directory /wiisx/bios
 +
 
 +
==== For DVD ====
 +
ISOs may be anywhere on the disc
 +
 
 +
 
 +
== Quick Usage ==
 +
Load the executable from the HBC or in the loader of your choice
 +
 
 +
Once loaded, select 'Load ISO'
 +
 
 +
Choose the source (SD/USB/DVD/Samba)
 +
 
 +
Select the ISO to load (Note: to go up a directory select '..', B will exit the file browser)
 +
 
 +
Select 'Play Game' to play
 +
 
 +
To exit game press:
 +
{| class="wikitable"
 +
|-
 +
! {{Wiimote}} + {{Nunchuck}} !! {{GCNController}} !! {{ClassicController}} !! {{Wii}}
 +
|-
 +
| {{Wiimote1Button}} + {{Wiimote2Button}} || {{GCStartButton}} + {{GCYButton}} || {{ClassicHomeButton}} || {{WiiResetButton}}
 +
|}
 +
(Note: this must be done to save your game; it will not be done automatically)
 +
 
 +
== Settings ==
 +
=== General ===
 +
* Native Saves Device: Choose where to load and save native game saves
 +
* Save States Device: Choose where to load and save save states
 +
* Select CPU Core: Choose whether to play games with interpreter
 +
** (better compatibility) or dynarec (better speed)
 +
* Save settings.cfg: Save all of these settings either SD or USB
 +
** (to be loaded automatically next time from the device you launch WiiSX with)
 +
 
 +
=== Video ===
 +
* Show FPS: Display the framerate in the top-left corner of the screen
 +
* Screen Mode: Select the aspect ratio of the display; 'Force 16:9' will pillar-box the in-game display
 +
 
 +
=== Input / Controls ===
 +
* Controls are now fully configurable so any button on your controller can be mapped
 +
* The controller configuration screen presents each PSX DualShock button and allows you to toggle through sources
 +
* There are 4 configuration slots for each type of controller
 +
* To load a different, previously saved configuration, select the slot, and click 'Load'
 +
* After configuring the controls as desired, select the slot, and click 'Save'
 +
* After saving different configurations to the slots, be sure to save your configs in the input tab of the settings frame
 +
* Clicking 'Next Pad' will cycle through the PSX controllers assigned
 +
* There is an option to invert the Y axis of the DuakShock's analog stick(s); by default this is 'Normal Y'
 +
* The 'Menu Combo' configuration allows you to select a button combination to return to the menu
 +
 
 +
* Configure Input: Select controllers to use in game
 +
* Configure Buttons: Enter the controller configuration screen described above
 +
* PSX Controller Type: Select whether the DualShock controller is in 'analog' mode or not. Many games won't work unless the mode is 'standard'.
 +
* Save Button Configs: Save all of the controller configuration slots to SD or USB
 +
* Auto Load Slot: Select which slot to automatically be loaded for each type of controller
 +
 
 +
=== Audio ===
 +
* Disable Audio: Select to mute the sound
 +
* Disable XA: Select to mute XA audio
 +
 
 +
=== Saves ===
 +
* Auto Save Native Saves: When enabled, the emulator will automatically load saves from the selected device and save when returning to the menu or turning off the console
 +
* Copy Saves: Not yet implemented
 +
* Delete Saves: Not yet implemented
 +
 
 +
== Compatibility List ==
 +
* [[WiiSX/Compatibility|User made compatibility list]]
 +
 
 +
 
 +
== Input Methods ==
 +
* A mix of Gamecube Controllers and Wiimote with or without classic controller or nunchucks may be used to support up to 2 players at once
 +
 
 +
== Input Mappings ==
 +
* TODO: add the rest of the default configurations (Classic, Wiimote+Nunchuck, ...)
 
{| class="wikitable" border="1" "text-align:center"
 
{| class="wikitable" border="1" "text-align:center"
 
|-
 
|-
Line 80: Line 173:
 
|}
 
|}
  
== Known Issues ==
+
== ISO Format ==
* CDDA audio streaming is not implemented
+
* ISOs can be in any format, .bin/.cue/.img/.ccd
* .CUE is not working from DVD, select the .bin directly
+
* ISOs may be loaded via SDGecko / Front-SD / USB / DVD / Samba
* Final Fantasy VII crashes Dynarec (after first battle)
+
* ISOs must be placed in a directory named "/wiisx/isos/" on the SDCard
* [[WiiSX/Compatibility|User made compatibility list]]
+
* ISOs can be placed anywhere if using a DVD
 +
* Samba configuration must be entered into settings.cfg
  
== Updates ==
+
== Save Support ==
The Wii64Team keeps a progress blog which can be found at http://www.emulatemii.com
+
* There is memcard save support for the SDGecko, Front-SD, USB and Gamecube Memory Card
 +
* Save state support is only for the SDGecko, Front-SD and USB
 +
* To save, you must have a directory named "/wiisx/saves/" in the root directory
  
Beta 2.1 was released on July 11th 2010, which addresses various bugs reported in the July 3rd Beta 2.0 release.
+
== Support ==
 +
Finally, there is a support forum located on [http://www.gc-forever.com/forums/viewforum.php?f=10 emu_kidid's site], so if you are having trouble with Beta 2.1, please seek help there before submitting issues to the Google code tracker. You can also join in and discuss the project with other users there.
  
== See Also ==
+
== Credits ==
<s>WiiSX Beta1 Mod3 by Jacobeian, featuring USB disk and Classic Controller support</s> Outdated.
+
* General Coder: emu_kidid
 +
* Graphics & Menu Coder: sepp256
 +
* Core Coder: tehpola
 +
* Artwork: [[User:drmr|drmr]]
 +
* [http://www.pcsx.net/ pcsx team]
 +
* [http://pcsx-df.sourceforge.net/ pcsx-df]
 +
* [http://pcsx.gpost.dk/ pcsx 1.5-test3 mac version by Gil Pederson]
 +
* [http://sourceforge.net/projects/peops/ P.E.Op.S. PSX GPU]
 +
* franspu
 +
* CDRMooby
 +
* SSSPSX
 +
* Compiled using [[devkitPPC]] r21 and [[libogc]]
  
<s>WiiSX Beta2 USB2 Mod by Matguitarist</s> Outdated.
+
* Visit us on [http://emulatemii.com EmulateMii] and the [http://code.google.com/p/pcsxgc GoogleCode] page.
 
 
<s>WiiSX beta2 USB2 MOD Source</s> Outdated.
 
 
 
Sorry, i forgot to link the source. ( Matguitarist )
 
 
 
== Credits ==
 
*[http://www.pcsx.net/ pcsx team]
 
*[http://pcsx-df.sourceforge.net/ pcsx-df]
 
*[http://pcsx.gpost.dk/ pcsx 1.5-test3 mac version by Gil Pederson]
 
*[http://sourceforge.net/projects/peops/ P.E.Op.S. PSX GPU]
 

Revision as of 05:33, 12 July 2010

WiiSX
WiiSX icon.png
General
Author(s)emu_kidid, sepp256, tehpola
TypeConsole emulator
VersionBeta 2
LicenceGNU GPL v2
Links
Download
Website
Source
Downloadable via the Homebrew Browser
Peripherals
ClassicController.svg Wiimote4.svg SensorBar.svg Nunchuck alternative.svg USB mass storage device GameCube Controller DVD Loads files from SDHC cards in the Front SD slot SD Gecko GameCube Memory Card

WiiSX is a PSX emulator for the Nintendo Gamecube & Wii brought to you by Wii64Team (emu_kidid, sepp256, tehpola). It is based on various PCSX code bases, see the credits section for specifics.

Progress & Updates

  • Check out http://www.emulatemii.com for the latest news on the progress of this emulator, featuring regular updates and in-depth technical posts on the progress and current features. If you like this emulator, please donate and support the team!

Further Information

The emulator can be controlled with any combination of GC controllers, Classic Controllers, Wiimotes with Nunchuks and even just Wiimotes. See the included readme for details on the controls. You can load ROMs and saves from a FAT formatted SD or USB (details on the folders required are in the readme).

Developers

We don't want to discourage other people forking and working on the emulator; however, any unofficial builds must not be called "WiiSX" or "CubeSX" nor use the WiiSX or CubeSX logo in order to avoid confusion. For now, we're just releasing a snapshot of the source used to build Beta 2.1, but we're planning on updating the public repository with each commit we've made to our private repository so that everyone can see the progression of the code. This process will begin soon.

Current Release & Known Issues

  • Beta 2.1 was released on July 11th 2010, which addresses various bugs reported in the July 3rd Beta 2.0 release.
  • CDDA audio streaming is not implemented
  • .CUE is not working from DVD, select the .bin directly
  • Final Fantasy VII crashes Dynarec (after first battle)

Currently Achieved Features

  • Emulation via Dynamic Recompilation & Interpreter
  • Software Rendered Graphics with GX scaling
  • SPU and XA Stereo Audio
  • Input via Gamecube & Classic Controller & Wiimote + Nunchuck & Wiimote
  • Input Emulation for DualShock Controllers (Both Standard & Analog Modes)
  • Vibration Feedback
  • Configurable input combinations
  • DVD/USB/SDGecko/Front-SD/Samba ISO Loading
  • Memory Cards
  • Save States
  • Progressive/Widescreen Resolution

To-do (In order of importance)

  • Increase Compatibility
  • Improve Speed
  • Hardware Accelerated Graphics
  • Netplay

Installation

For SD/USB

Extract the contents of wiiSX-beta2.1.zip to the root of your SD card/USB

Put ISOs (.bin/.cue files) in the directory named /wiisx/isos (All save types will automatically be placed in /wiisx/saves)

For actual BIOS: Name your bios "SCPH1001.BIN" and place it on SD/USB in the directory /wiisx/bios

For DVD

ISOs may be anywhere on the disc


Quick Usage

Load the executable from the HBC or in the loader of your choice

Once loaded, select 'Load ISO'

Choose the source (SD/USB/DVD/Samba)

Select the ISO to load (Note: to go up a directory select '..', B will exit the file browser)

Select 'Play Game' to play

To exit game press:

Wiimote.svg + Nunchuck alternative.svg GameCube Controller ClassicController.svg WiiDrawing.svg
Wiimote 1 Button + Wiimote 2 Button GameCube START Button + Gamecube Y Button Classic HOME Button Wii RESET Button

(Note: this must be done to save your game; it will not be done automatically)

Settings

General

  • Native Saves Device: Choose where to load and save native game saves
  • Save States Device: Choose where to load and save save states
  • Select CPU Core: Choose whether to play games with interpreter
    • (better compatibility) or dynarec (better speed)
  • Save settings.cfg: Save all of these settings either SD or USB
    • (to be loaded automatically next time from the device you launch WiiSX with)

Video

  • Show FPS: Display the framerate in the top-left corner of the screen
  • Screen Mode: Select the aspect ratio of the display; 'Force 16:9' will pillar-box the in-game display

Input / Controls

  • Controls are now fully configurable so any button on your controller can be mapped
  • The controller configuration screen presents each PSX DualShock button and allows you to toggle through sources
  • There are 4 configuration slots for each type of controller
  • To load a different, previously saved configuration, select the slot, and click 'Load'
  • After configuring the controls as desired, select the slot, and click 'Save'
  • After saving different configurations to the slots, be sure to save your configs in the input tab of the settings frame
  • Clicking 'Next Pad' will cycle through the PSX controllers assigned
  • There is an option to invert the Y axis of the DuakShock's analog stick(s); by default this is 'Normal Y'
  • The 'Menu Combo' configuration allows you to select a button combination to return to the menu
  • Configure Input: Select controllers to use in game
  • Configure Buttons: Enter the controller configuration screen described above
  • PSX Controller Type: Select whether the DualShock controller is in 'analog' mode or not. Many games won't work unless the mode is 'standard'.
  • Save Button Configs: Save all of the controller configuration slots to SD or USB
  • Auto Load Slot: Select which slot to automatically be loaded for each type of controller

Audio

  • Disable Audio: Select to mute the sound
  • Disable XA: Select to mute XA audio

Saves

  • Auto Save Native Saves: When enabled, the emulator will automatically load saves from the selected device and save when returning to the menu or turning off the console
  • Copy Saves: Not yet implemented
  • Delete Saves: Not yet implemented

Compatibility List


Input Methods

  • A mix of Gamecube Controllers and Wiimote with or without classic controller or nunchucks may be used to support up to 2 players at once

Input Mappings

  • TODO: add the rest of the default configurations (Classic, Wiimote+Nunchuck, ...)
Playstation Controller Gamecube Controller
Cross
Gamecube A Button
Square
Gamecube B Button
Triangle
Gamecube Y Button
Circle
Gamecube X Button
Right Analog Stick
Gamecube C Control Stick
Left Analog Stick
GameCube Control Stick
Digital Pad
Classic D-Pad
Start
GameCube START Button
Select
GameCube Z Button + GameCube START Button
R1
GameCube R Trigger
R2
GameCube Z Button + GameCube R Trigger
L1
GameCube L Trigger
L2
GameCube Z Button + GameCube L Trigger

ISO Format

  • ISOs can be in any format, .bin/.cue/.img/.ccd
  • ISOs may be loaded via SDGecko / Front-SD / USB / DVD / Samba
  • ISOs must be placed in a directory named "/wiisx/isos/" on the SDCard
  • ISOs can be placed anywhere if using a DVD
  • Samba configuration must be entered into settings.cfg

Save Support

  • There is memcard save support for the SDGecko, Front-SD, USB and Gamecube Memory Card
  • Save state support is only for the SDGecko, Front-SD and USB
  • To save, you must have a directory named "/wiisx/saves/" in the root directory

Support

Finally, there is a support forum located on emu_kidid's site, so if you are having trouble with Beta 2.1, please seek help there before submitting issues to the Google code tracker. You can also join in and discuss the project with other users there.

Credits

* General Coder: emu_kidid
* Graphics & Menu Coder: sepp256
* Core Coder: tehpola
* Artwork: drmr
* pcsx team
* pcsx-df
* pcsx 1.5-test3 mac version by Gil Pederson
* P.E.Op.S. PSX GPU
* franspu
* CDRMooby
* SSSPSX
* Compiled using devkitPPC r21 and libogc
* Visit us on EmulateMii and the GoogleCode page.