Skip to content

Commit

Permalink
improve readme a bit: IA, known issues
Browse files Browse the repository at this point in the history
  • Loading branch information
db48x committed Feb 28, 2015
1 parent c6721bf commit 8ff85a3
Showing 1 changed file with 23 additions and 12 deletions.
35 changes: 23 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,29 +52,40 @@ Each of these is configured by calling a constructor function and providing it w

## Common ##

* emulatorJS(url)
* mountZip(drive, file)
* mountFile(filename, file)
* fetchFile(url)
* fetchOptionalFile(url)
* localFile(data)
* `emulatorJS(url)`
* `mountZip(drive, file)`
* `mountFile(filename, file)`
* `fetchFile(url)`
* `fetchOptionalFile(url)`
* `localFile(data)`

## JSMESS ##

* driver(driverName)
* extraArgs(args)
* peripheral(name, filename)
* `driver(driverName)`
* `extraArgs(args)`
* `peripheral(name, filename)`

## JSMAME ##

* driver(driverName)
* extraArgs(args)
* `driver(driverName)`
* `extraArgs(args)`

## EM-DosBox ##

* startExe(filename)

# Internet Archive #

There's also a helper for loading software from [the Internet Archive](https://archive.org/v2), `IALoader`. IALoader looks at the metadata associated with their items and uses that to build the configuration for the emulator.

## Examples ##

var emulator = IALoader("#canvas", "atari_2600_pitfall_1983_cce_c-813/atari_2600_pitfall_1983_cce_c-813.bin");

# Known Bugs #

* splash screen doesn't always fit inside the canvas
* not enough indication of download progress
* need to improve the download progress indicators
* browser feature detection for volume/mute/full-screen
* handling of aspect ratios, and their interaction with full-screen mode
* finish API for volume/mute/full-screen requests

0 comments on commit 8ff85a3

Please sign in to comment.