Giter VIP home page Giter VIP logo

retrosuite's Introduction

Try it now in CWS

RetroSuite

A platform to bring retro-gaming to the modern era.

CrowdEMU (Web App): Website where thousands of people can share an instance of a game; every 3 seconds the most popular move is executed. Includes video streaming. https://www.crowdemu.com

RetroSuite EMU (Chrome App): Native desktop application; play your favorite NES, SNES, Gameboy and Gameboy Advance ROMs. Use your phone as your controller - or use custom keyboard mappings. Deploys a websockets tcp server to allow use of phone as a controller. Download here

  • Use your iPhone as your joypad
  • Use your own custom keyboard button mappings; right click the screen once a game has started to pause and re-map
  • Try out some pre-loaded games, or add your own; RetroSuite EMU will remember the ones you've added
  • RetroSuite EMU auto-saves your game as you play, but you can also manually save and load in save states

RetroSuite Controller (Mobile App): React Native phone app that pairs with the Chrome app and acts as a controller for the retro console.

Scrum Roles

  • Scrum Master: Colin Whitmarsh
  • Product Owner: Kyle Corbelli
  • Extreme Programmer: Joe Miller VI
  • Extreme Programmer: Franklin Shieh

Installation

Requirements:

Step 1: Run 'npm install' from the root directory

$ npm install

Step 2: Run 'npm install' from the webApp directory

$ cd webApp
$ npm install

Running the CrowdEMU Web App

Step 1: Navigate to the webapp/emulatorNode directory

$ cd webApp/emulatorNode

Step 2: Set environmental variable CROWDMU_ROM to the available ROM. This emulator is compatible with Gameboy Color ROMS

$ CROWDMU_ROM=./path/to/rom.gb

Step 3: Run index.js

$ node index.js

Step 4: Navigate to clientServer and run server.js

$ cd clientServer
$ node server.js

Step 5: Navigate your web browser to 'localhost:3000'

Running the RetroSuite EMU Chrome App

Step 1: Open Chrome and navigate to Tools > Extensions

Step 2: Click 'Load unpacked extension...'

Step 3: Select and open the 'chromeApp' directory in your forked and cloned version of this repository

Step 4: Click 'Launch'

Credits and Thanks

retrosuite's People

Contributors

franklinshieh avatar colinwhitmarsh avatar joemillervi avatar kylecorbelli avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.