Skip to content

Latest commit

 

History

History
44 lines (25 loc) · 1.14 KB

README.md

File metadata and controls

44 lines (25 loc) · 1.14 KB
Raw

JSNES Web UI

A React-based web UI for JSNES.

Running in development

$ yarn install
$ yarn start

Building for production

$ yarn build

The built app will be in build/.

Running tests

$ yarn test

Formatting code

All code must conform to Prettier formatting. The test suite won't pass unless it does.

To automatically format all your code, run:

$ yarn run format

Adding roms

Add ROMs for yourself using localStorage

Navigate to the server public root (e.g. http://localhost:3000), click "+ Add ROM files" and follow the instructions. The ROMs will be saved into your browser cache and other users will not be able to access them.

Add ROMs for all users

Open src/config.js and add a new key under the defined config.ROMS. For example:

myrom: {
  name: "My Rom",
  description: <span>This is my own homebrew NES rom</span>,
  url: "http://localhost:3000/roms/myrom/myrom.nes"
}

If you add your rom file now under public/roms/myrom/myrom.nes, the game should start playing as you navigate to http://localhost:3000/run/myrom