Short:        The Binding of Isaac (Flash) recompiled natively
Author:       whylurking, MorphOS port by BeWorld
Type:         game/action
Version:      1.5.0
Architecture: ppc-morphos

IsaacRecomp 1.5.0 for MorphOS
=============================

The Binding of Isaac (2011 Flash game) translated to C++ and running on a native
engine: no Flash player, no emulator. Original, Wrath of the Lamb and Eternal
Edition in one program, with controller support and the bundled mods.

THE GAME IS NOT INCLUDED. You need your own copy from Steam: graphics, sounds,
music and game data are read from its Isaac.exe at startup.


Requirements
------------
- MorphOS 3.x with SDL2 (sdl2.library) and TinyGL (3D-capable Radeon with a
  stencil buffer recommended; masks are drawn without clipping otherwise)
- A G4 or faster CPU recommended (everything runs on one core)
- Isaac.exe from your Steam copy of The Binding of Isaac (Wrath of the Lamb and
  Eternal Edition are supported too)


Installation
------------
1. Copy the IsaacRecomp drawer anywhere.
2. In Steam: right-click the game > Manage > Browse local files, and copy
   Isaac.exe into the IsaacRecomp drawer. (Binding_of_Isaac.exe is only the Steam
   launcher: it won't work.)
3. Start IsaacRecomp from its icon or from a Shell.

Several versions: on Steam they are all called Isaac.exe. Copy them under
different names (Isaac-Original.exe, Isaac-WotL.exe, Isaac-Eternal.exe...):
each one is recognized by its contents and a selection screen appears at
startup. Each version keeps its own save file. From a Shell,
"IsaacRecomp --game og|wotl|eternal" starts one directly.

On the first start the program creates isaac.ini, log.txt, saves/ and mods/ in
its drawer.


Display
-------
By default the game opens its own screen in the display mode closest to
960x720 (usually 1024x768), with black bars if needed. Change it in isaac.ini:

  fullscreen = 1      0 = in a window on the Workbench screen
  width = 960         size asked for (fullscreen: the closest screen mode)
  height = 720
  vsync = 1
  volume = 100
  cache_mb = 64       video memory for already drawn graphics (pages of 16 MB);
                      raise it on cards with more video memory (128 or more on
                      256 MB cards) so graphics are drawn again less often

The image is updated 30 times per second, like the original game.


Controls
--------
Keyboard (the game's own):
  W A S D             move (Z Q S D with the game's AZERTY option)
  Arrows              shoot
  E                   bomb
  Space               active item
  Q                   card / pill (A with the AZERTY option)
  P                   pause
  F3                  performance overlay (also written to saves/performance.txt)
  F11 / Alt+Return    fullscreen <-> window
  F12                 screenshot (saves/screenshot_N.bmp)

Controller (SDL game controller, Xbox layout):
  Left stick / D-pad  move (analog speed: joystick_acceleration in isaac.ini)
  Right stick, A B X Y shoot
  LB / LT             bomb
  RB / RT             active item
  Right stick click   card / pill
  Start / Back / left stick click   pause
In menus the D-pad or left stick moves the selection (highlighted in pink), A
selects and B goes back. Buttons can be changed in the game: Options > Controls
> Rebind controls.

Controllers are used through SDL2. A pad SDL doesn't know gets a generic
mapping, written to log.txt; to correct it, put a gamecontrollerdb.txt (SDL's
format) in the drawer.


Mods
----
The mods folder holds the bundled mods: StatOn, GenesisConsole, WideSaac,
PillLog, Itemnomicon, BaseTime, The Gone and RainbowVision. They are all off:
turn them on in mods/mods.txt ("on = 1" under a mod), every option is
explained there.


Differences from the PC version
-------------------------------
- 30 images per second (no interpolation to the display's refresh rate)
- No blur filters
- RainbowVision's colour modes have no effect
- No touch controls


Troubleshooting
---------------
log.txt in the drawer tells which games were found ("game found:"), the screen
mode and the TinyGL driver. "the SWF does not exactly match the Steam version"
means the file is not one of the three Steam releases and may not work
correctly.


Credits
-------
IsaacRecomp by whylurking (MIT license for the engine and tools, see LICENSE
and THIRD-PARTY-LICENSES.txt). Made with the help of artificial intelligence.
MorphOS port by BeWorld: TinyGL renderer, single-core tuning, real fullscreen
screen mode, controller fixes.

The Binding of Isaac is by Edmund McMillen and Florian Himsl. This free,
non-profit fan project is not affiliated with them, Nicalis or Valve.