In memory of Ben “bushing” Byer, who passed away on Monday, February 8th, 2016.

Difference between revisions of "WiiColEm"

From WiiBrew
Jump to navigation Jump to search
Line 470: Line 470:
 
== Changelog ==
 
== Changelog ==
  
=== 0.1-pre1 - January 12, 2010 ===
+
=== 0.1 - January 28, 2010 ===
  
* Initial preview release
+
* Initial release
  
 
[[Category:Homebrew using SDL libraries]]
 
[[Category:Homebrew using SDL libraries]]

Revision as of 18:01, 28 January 2010

WiiColEm
WiiColEm.png
General
Author(s)Raz0red
TypeConsole emulator
Version0.1
Links
Download
Website
Discussion
Source
Peripherals
WiiMote2.svg Nunchuck alternative.svg ClassicController.svg GameCube Controller Loads files from the Front SD slot

Overview

WiiColEm is a port of the ColEm ColecoVision emulator version 2.5.2 developed by Marat Fayzullin.

Features:

  • Support for driving, roller, and super action controllers
  • Tilt-based (Wiimote) driving support
  • Cartridge database w/ recommended controller settings and keypad descriptions for most commercial cartridges
  • Per-cartridge button mappings
  • On-screen keypad display
  • High cartridge compatibility (see below)

The following additions/modifications were made to the core emulation code:

  • "The Heist" now works correctly (memory initialization bug).
  • Added support for Opcode RAM expansion.
  • Added support for "Lord of the Dungeon" (original 32k or trimmed 24k).
  • Mode 2 masking now works correctly (supports Daniel Bienvenu games).
  • Mode 0 and Mode 3 now work correctly ("Cabbage Patch Kids Picture Show" and "Smurf: Paint 'n Play Workshop" now work correctly).
  • Fixed graphic corruption that would occur when switching between games (VRAM and related state were not being reset correctly).
  • Fixed save/load state bug where the emulator would incorrectly report that the save was invalid (memory was not being cleared correctly).
  • Fixed issue where noise channel wasn't starting when it should (Matt Patrol).

What about BlueMSX-wii?

So, a common question might be why release this WiiColEm when the excellent BlueMSX-wii emulator exists? The truth is that I started this project some time ago prior to the release of BlueMSX-wii. After finally getting some free time again I decided to go ahead and complete the port. The reason I decided to release it is that it is an entirely different code base. As such, it may play some things that BlueMSX-wii does not. WiiColEm also supports all of the controllers (Driving, Roller, and Spinner). Finally, it has an on-screen keypad display with key descriptions so all Coleco games should be playable.

Known Issues

  • Zip files are not currently supported
  • The noise channel isn't accurate (core bug)

Installation

To install WiiColEm, simply extract the zip file directly to your SD card (retain the hierarchical structure exactly).

Cartridge images should be placed in the roms directory (/wiicolem/roms).

Status

  • Released 0.1 --Raz0red 16:00, 28 January 2010 (UTC)

Cartridge Database

WiiColem ships with a database that contains recommended settings for most commercial cartridges. These settings cover controls mappings, keypad button descriptions, and advanced settings (whether the cartridge requires the Opcode RAM expansion, etc.).

To see the settings applied for a particular cartridge perform the following steps:

  • Load the cartridge (via the "Load cartridge" menu item)
  • Return to the WiiColem menu
  • Select "Cartridge settings (current cartridge)" menu item
  • Examine the "Control settings" and "Advanced" settings for the cartridge

For more information on mapping controls and creating and/or customizing cartridge settings, see Cartridge Settings.

Default Controls

The following section contains the "default" control mappings for WiiColEm.

It is important to note that if the cartridge that is being loaded exists in the Cartridge Database it may contain non-default mappings.

WiiColEm menu

Wiimote.svg Wiimote.svg + Nunchuck alternative.svg ClassicController.svg GameCube Controller Action
Wiimote D-Pad Up / Wiimote D-Pad Down Wiimote D-Pad Up / Wiimote D-Pad Down or Nunchuck Control Stick Classic D-Pad Up / Classic D-Pad Down or Classic Left Control Stick Gamecube D-Pad Up / Gamecube D-Pad Down or GameCube Control Stick Scroll through the Menu
Wiimote D-Pad Left / Wiimote D-Pad Right Wiimote D-Pad Left / Wiimote D-Pad Right or Nunchuck Control Stick Classic D-Pad Left / Classic D-Pad Right or Classic Left Control Stick Gamecube D-Pad Left / Gamecube D-Pad Right or GameCube Control Stick Page through the Menu
Wiimote A Button Wiimote A Button or Nunchuck C Button Classic a Button Gamecube A Button Select menu item
Wiimote B Button Wiimote B Button or Nunchuck Z Button Classic b Button Gamecube B Button Previous menu
Wiimote HOME Button Wiimote HOME Button Classic HOME Button GameCube Z Button Exit to Homebrew channel

In-game (Keypad)

The keypad allows you to press keys on the ColecoVision controller keypads. If a description has been provided for the currently selected key it will be displayed above the keypad.

You can select whether you want emulation to pause while the keypad is displayed via the "Keypad pause" option in "Advanced" settings (pausing is enabled by default). This value can be overridden on a cartridge-by-cartridge basis via Cartridge Settings.

  • When keypad pause is enabled, the keypad will be closed when a keypad button is pressed (or the keypad is explicitly closed). It is important to note that the keypad button will continue to be pressed as long as the controller button is held. This is necessary for games like War Room where you need to hold the keypad buttons down to see the different factories, etc.
  • When keypad pause is disabled, emulation will continue while the keypad is displayed. The keypad will continue to be displayed until it is explicitly closed. This mode works well for games like Lord of the Dungeon and Ken Uston Blackjack that require lots of button presses.

It is also important to note that commonly used keys can be mapped to Wii controller buttons (see Cartridge Settings).

WiimoteHorizontal.svg Wiimote.svg + Nunchuck alternative.svg ClassicController.svg GameCube Controller Action
Wiimote D-Pad Nunchuck Control Stick or Wiimote D-Pad Classic D-Pad or Classic Left Control Stick or Classic Right Control Stick GameCube D-Pad or GameCube Control Stick or Gamecube C Control Stick Choose Key
Wiimote 2 Button or Wiimote 1 Button or Wiimote A Button or Wiimote B Button Nunchuck C Button or Nunchuck Z Button or Wiimote A Button or Wiimote B Button Classic a Button or Classic b Button Gamecube A Button or Gamecube B Button Press Key
Wiimote + Button Wiimote + Button Classic + Button GameCube START Button Close Keypad

In-game (Standard)

WiimoteHorizontal.svg Wiimote.svg + Nunchuck alternative.svg ClassicController.svg GameCube Controller Action
Wiimote D-Pad Nunchuck Control Stick or Wiimote D-Pad Classic D-Pad or Classic Left Control Stick or Classic Right Control Stick GameCube D-Pad or GameCube Control Stick or Gamecube C Control Stick Move
Wiimote 2 Button Nunchuck C Button Classic a Button Gamecube A Button Left Fire Button
Wiimote 1 Button Nunchuck Z Button Classic b Button Gamecube B Button Right Fire Button
Wiimote + Button Wiimote + Button Classic + Button GameCube START Button Toggle Keypad
Wiimote HOME Button Wiimote HOME Button Classic HOME Button GameCube Z Button Display WiiColEm menu (see above)

In-game (Super action)

Very few games use the "spinner" that is a part of the super action controller. You can enable/disable the "spinner" via Cartridge Settings.

By disabling the spinner, you have more options available for the move controls (Nunchuk analog, both analogs on the Classic and GameCube controllers).

Wiimote.svg + Nunchuck alternative.svg ClassicController.svg GameCube Controller Action
Nunchuck Control Stick or Wiimote D-Pad Classic D-Pad or Classic Left Control Stick or Classic Right Control Stick GameCube D-Pad or GameCube Control Stick or Gamecube C Control Stick Move (If spinner is disabled)
Wiimote D-Pad Classic D-Pad or Classic Left Control Stick GameCube D-Pad or GameCube Control Stick Move (If spinner is enabled)
Nunchuck Control Stick Classic Right Control Stick Gamecube C Control Stick Spinner (If enabled)
Nunchuck C Button or Wiimote 2 Button Classic a Button or Classic R Trigger Gamecube A Button or GameCube R Trigger Yellow button
Nunchuck Z Buttonor Wiimote 1 Button Classic b Button or Classic L Trigger Gamecube B Button or GameCube L Trigger Orange button
Wiimote A Button Classic x Button or Classic ZR Button Gamecube X Button Blue button
Wiimote B Button Classic y Button or Classic ZL Button Gamecube Y Button Purple button
Wiimote + Button Classic + Button GameCube START Button Toggle Keypad
Wiimote HOME Button Classic HOME Button GameCube Z Button Display WiiColEm menu (see above)

In-game (Driving / Tilt)

In this mode, you steer by tilting the Wiimote (similar to Excite Truck/Bots). You can adjust the tilt sensitivity via Cartridge Settings.

WiimoteHorizontal.svg Action
Tilt WiimoteHorizontal.svg Steer
Wiimote D-Pad Shift
Wiimote 2 Button Gas
Wiimote 1 Button Brake
Wiimote + Button Toggle Keypad
Wiimote HOME Button Display WiiColEm menu (see above)

In-game (Driving / Analog)

In this mode, you steer by using the analog controls (Nunchuk, Classic, GameCube). You can adjust the analog sensitivity via Cartridge Settings.

Wiimote.svg + Nunchuck alternative.svg ClassicController.svg GameCube Controller Action
Nunchuck Control Stick Classic Right Control Stick Gamecube C Control Stick Steer
Wiimote D-Pad Classic D-Pad GameCube D-Pad Shift
Nunchuck C Button or Wiimote 2 Button Classic a Button Gamecube A Button Gas
Nunchuck Z Buttonor Wiimote 1 Button Classic b Button Gamecube B Button Brake
Wiimote + Button Classic + Button GameCube START Button Toggle Keypad
Wiimote HOME Button Classic HOME Button GameCube Z Button Display WiiColEm menu (see above)

In-game (Roller)

In this mode, the trackball motion is simulated via analog controls (Nunchuk, Classic, GameCube). You can adjust the analog sensitivity via Cartridge Settings.

Wiimote.svg + Nunchuck alternative.svg ClassicController.svg GameCube Controller Action
Nunchuck Control Stick Classic Left Control Stick GameCube Control Stick Move
Nunchuck C Button or Wiimote 2 Button Classic a Button Gamecube A Button Left Fire (2p)
Nunchuck Z Buttonor Wiimote 1 Button Classic b Button Gamecube B Button Right Fire (2p)
Wiimote A Button Classic x Button Gamecube X Button Left Fire
Wiimote B Button Classic y Button Gamecube Y Button Right Fire
Wiimote + Button Classic + Button GameCube START Button Toggle Keypad
Wiimote HOME Button Classic HOME Button GameCube Z Button Display WiiColEm menu (see above)

Cartridge Settings

WiiColEm contains the ability to manage per-cartridge settings. The settings that can be edited include:

  • Control settings
  • Advanced settings (Whether it requires Opcode memory expansion, keypad pause, etc.)

Control Settings

The following control options are available:

  • The controller type (standard, super action, driving/tilt, driving/analog, roller)
  • Wiimote orientation
  • Sensitivity (Roller and driving controllers)
  • ColecoVision keypad and controller button mappings

When mapping buttons, you map a ColecoVision keypad or controller button to one of the "button groups" listed below. This allows you to map a button once across the different Wii controllers.

You can use the "(View as)" menu item to toggle how the ColecoVision buttons are mapped to a particular Wii controller (Wiimote, Nunchuk, Classic, and GameCube).

Group Wiimote.svg Nunchuck alternative.svg ClassicController.svg GameCube Controller
Button 1 Wiimote 2 Button Nunchuck C Button Classic a Button Gamecube A Button
Button 2 Wiimote 1 Button Nunchuck Z Button Classic b Button Gamecube B Button
Button 3 Wiimote A Button (n/a) Classic x Button Gamecube X Button
Button 4 Wiimote B Button (n/a) Classic y Button Gamecube Y Button
Button 5 (n/a) (n/a) Classic R Trigger GameCube R Trigger
Button 6 (n/a) (n/a) Classic L Trigger GameCube L Trigger
Button 7 (n/a) (n/a) Classic ZR Button (n/a)
Button 8 (n/a) (n/a) Classic ZL Button (n/a)

Screenshots

Special thanks

  • Marat Fayzullin
    • For answering all of my questions and providing valuable suggestions
  • Tantric
    • Menu example code and SDL enhancements
  • Daniel Bienvenu (newcoleco)
    • Help resolving the Mode 2 issues
  • Yurkie
    • Testing and for providing great suggestions

Changelog

0.1 - January 28, 2010

  • Initial release