mirror of
https://github.com/db48x/emularity.git
synced 2026-09-15 02:52:57 +00:00
Update and rename README.md to TECHNICAL.md
This commit is contained in:
@@ -1,41 +1,4 @@
|
||||
# Welcome to the Emularity #
|
||||

|
||||
# 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.
|
||||
# Technical Information on use of the Emularity
|
||||
|
||||
# Emulator API #
|
||||
|
||||
@@ -163,12 +126,3 @@ Once you have an emulator object, there are several methods you can call.
|
||||
* `mute()`
|
||||
* `setSplashColors()`
|
||||
* others…
|
||||
|
||||
# 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
|
||||
Reference in New Issue
Block a user