Video Games (plugin)

Note

The video game plugin is maintained as an open-source community plugin rather than being bundled into Television Simulator itself. This is because of the complexity of running emulators in a web browser and the large number of keyboard bindings that need to be supported. The plugin is MIT-licensed and doesn’t include any emulators or games in its distribution, but is able to load them from the web or your local filesystem.

Copyright disclaimer

Remember that distributing copyrighted games is against the law in most countries. Also, some emulators may not be licensed for commercial use. The video game plugin does not distribute any emulators or games, and it is your responsibility to ensure that you have the right to use any emulators or games.

Usage

Get the plugin from GitHub or use the hosted version:

- number: -1
  iframe:
    src: http://gcpw.art/tvs/engines/video-game # replace with your own server if self-hosting
    options:
      game: flappybird.nes # Required. The game library by default is from `retrobrews.github.io`. You can specify a game from there directly. Set to false to use a core that doesn't require a game.
      core: fceumm # Required. The system to emulate.

Technical details

This plugin is a very thin wrapper over Nostalgist.js with the following characteristics:

• Inputs are limited to controllers only. Plug in an Xbox controller for the best experience.
• No games will load until we’re told what options to load via the TVS IFrame API.
• State is saved automatically to Indexed DB when the page is unloaded or the channel is changed.

Options

Being an IFrame plugin, we pass options via the options object rather than directly in the iframe object.

core required

Type: string

The RetroArch core to load. Read about Nostalgist.js’s core option

game required

Type: string | false

The game ROM to load. Read about Nostalgist.js’s rom option