From 0002147462f39b22fb93fd03da4373d2de084aad Mon Sep 17 00:00:00 2001 From: Jason Scott Date: Sun, 12 Apr 2015 22:31:03 -0400 Subject: [PATCH] Create README.md --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..96c20f1 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# Welcome to the Emularity # +![Emularity](https://raw.githubusercontent.com/db48x/emularity/master/logo/emularity_light.png) +# Synopsis # + +The goal of this little project is to make it easy to embed a +javascript-based emulator in your own webpage. It downloads the files +you specify (with aprogress ui to show what is happening), arranges +them to form a filesystem, constructs the necessary arguments for the +emulator, and handles transitions to and from full-screen mode. + +To use this project you'll need to provide it with a canvas element, +styled as necessary so that it has the correct size on screen (the +emulated program will be scaled up automatically to fit, controlling +for aspect ratio). You will also likely want to provide a simple UI +for entering full-screen mode or muting the audio; these can simply +call methods on the emulator when activated. + +# The Emulators # + +Currently works with two emulators: + +## JSMESS ## + +[JSMESS](https://github.com/jsmess/jsmess) is a port of the Multi +Emulator Super System (MESS) and the Multiple Arcade Machine Emulator +(MAME) projects to Javascript. MESS and MAME support hundreds of +different machines; producing a single javascript file which supports +all of them turns out to be infeasible. Instead the JSMESS developers +have split each machine out into a separate js file. + +## EM-DOSBox ## + +[EM-DOSBox](https://github.com/dreamlayers/em-dosbox/) is a port of +DosBox to Javascript. DOSBox emulates an IBM PC compatible running +DOS. There are two versions of this emulator, dosbox.js and +dosbox-sync.js. Use the former by default, and the latter if you need +the emulator to support console input, batch files, or programs that +run other programs. + +# Known Bugs # + +* documentation is quite poor +* splash screen doesn't always fit inside the canvas +* 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 +