/js-dos

The best API for running dos programs in browser

Primary LanguageTypeScriptGNU General Public License v2.0GPL-2.0

js-dos 7.xx

Build

js-dos is a javascript library that allows you to run DOS programs in browser. It was designed from the ground up to be easily installed and used to get your DOS program up and running in browser quickly.

    Dos(element).run("game.jsdos")

Documentation

Quick start with create-dosbox

Create js-dos web page with no build configuration.

npx create-dosbox my-app
cd my-app
npm install
npm start
---
Open localhost:8080 in browser

You will be prompted to select game that you want bootstrap.

If you've previously installed create-dosbox globally via npm install -g create-dosbox, we recommend you uninstall the package using npm uninstall -g create-dosbox or yarn global remove create-dosbox to ensure that npx always uses the latest version.

(npx comes with npm 5.2+ and higher, see instructions for older npm versions)

Then open http://localhost:8080/ to see your app.

npm start

It will create a directory called my-app inside the current folder.
Inside that directory, it will generate the initial project structure:

my-app
├── package.json
└── _site
    ├── js-dos
    ├── bundle.jsdos
    └── index.html

No configuration or complicated folder structures, only the files you need to build your app.

  • js-dos - contains last release version of js-dos that you can download from Releases page
  • bundle.jsdos - is a bundle with game to start read more
  • index.html - is a web page template

So, you can host _site on static web server no other dependincies is needed.

Once the installation is done, you can open your project folder:

cd my-app

Inside the newly created project, you can run some built-in commands:

npm install
npm start

Open http://localhost:8080 to view it in the browser.

Community

Ask a technical question in Q&A.

Building

To build whole project do:

yarn
NODE_ENV=production yarn run gulp

Also, you can build js and css separately:

yarn run gulp js
yarn run gulp css

Example

To run built-in example do:

hs .
firefox examples/digger/index.html

Older releases