https://github.com/takahirox/nes-js

JavaScript NES(Famicom) emulator
https://github.com/takahirox/nes-js

emu emulator famicom javascript nes nes-js webaudio

Last synced: 3 months ago
JSON representation

JavaScript NES(Famicom) emulator

• Host: GitHub
• URL: https://github.com/takahirox/nes-js
• Owner: takahirox
• License: mit
• Created: 2014-07-09T05:08:39.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-10-04T09:13:57.000Z (about 7 years ago)
• Last Synced: 2024-04-25T00:56:18.797Z (6 months ago)
• Topics: emu, emulator, famicom, javascript, nes, nes-js, webaudio
• Language: JavaScript
• Homepage: http://takahirox.github.io/nes-js/index.html
• Size: 320 KB
• Stars: 205
• Watchers: 11
• Forks: 45
• Open Issues: 4
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nes-js

This is JavaScript NES(Famicom) emulator which runs on browser.

## Demo

[Demo](http://takahirox.github.io/nes-js/index.html)

[Demo with Three.js](http://takahirox.github.io/nes-js/index2.html) (It has a performance issue!)

[WebVR Demo with Three.js](http://takahirox.github.io/nes-js/index3.html) (It has a serious performance issue!)

[AR Demo with Three.js and jsartoolkit5](https://takahirox.github.io/nes-js/index4.html) (It has a performance issue!)

## Screenshot

![Screen shot](https://github.com/takahirox/assets/blob/master/nes-js/screenshot.png)

![Screen shot with Three.js](https://github.com/takahirox/takahirox.github.io/blob/master/images/nesemu.png)

## Features

- iNES format rom image support

- Renders with Canvas

- Audio support with WebAudio

- Runs on browser

## Browser

### How to use

```html

  

  

    function init() {

      var url = 'url to rom image';

      var request = new XMLHttpRequest();

      request.responseType = 'arraybuffer';

      request.onload = function() {

        var buffer = request.response;

        var nes = new NesJs.Nes();

        nes.setRom(new NesJs.Rom(buffer));

        nes.setDisplay(new NesJs.Display(document.getElementById('gameCanvas')));

        nes.setAudio(new NesJs.Audio());

        window.onkeydown = function(e) { nes.handleKeyDown(e); };

        window.onkeyup = function(e) { nes.handleKeyUp(e); };

        nes.bootup();

        nes.run();

      };

      request.open('GET', url, true);

      request.send(null);

    }

  

  


    

  


```

## NPM

### How to install

```

$ npm install nes-js

```

### How to build

```

$ npm install

$ npm run all

```

## Default key configuration

This table shows the key - joypad configuration set by

```html

  window.onkeydown = function(e) { nes.handleKeyDown(e); };

  window.onkeyup = function(e) { nes.handleKeyUp(e); };

```

| key          | joypad |

|--------------|--------|

| enter        | start  |

| space        | select |

| cursor-left  | left   |

| cursor-up    | up     |

| cursor-right | right  |

| cursor-down  | down   |

| x            | A      |

| z            | B      |

## APIs

T.B.D.

- NesJs

  - Nes

    - setRom()

    - setDisplay()

    - setAudio()

    - bootup()

    - run()

    - handleKeyDown()

    - handleKeyUp()

  - Rom

  - Display

  - Audio

## TODO

- Performance optimization

- Support more many mappers

- Support unofficial CPU instructions

- Gamepad API support

## Links

- Nes Dev

  - [Nes Dev Wiki](http://wiki.nesdev.com/w/index.php/Nesdev_Wiki)

- VR/AR

  - [Three.js](https://github.com/mrdoob/three.js)

  - [jsartoolkit5](https://github.com/artoolkit/jsartoolkit5)