| cmd | ||
| config | ||
| cws | ||
| emulator | ||
| overlord | ||
| static | ||
| util | ||
| vpx-encoder | ||
| webrtc | ||
| worker | ||
| .gitattributes | ||
| .gitignore | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| run_local.sh | ||
Cloud Gaming Service Lite
Cloud Gaming Service Lite is an open source Cloud Gaming Service building on WebRTC.
With cloud gaming, you can play any of your favourite NES games directly on your browser without installing it. It also brings modern online multiplayer gaming experience to classic NES game, so two people can play the game together.
Feature
- Can play NES games directly from browser.
- Immediately startup, no need to install.
- Can multiplayer over internet. A person host a game and the other person can join the same game as 1st or 2nd player.
- Save (S) and Load (L) at any point in time.
- If you save the roomID, next time you can come back to continue play in that room.
- The game can be hosted on local and your game session can be accessed over internet.
Demo
https://www.youtube.com/watch?v=qkjV2VIwVIo
Try the game
For the best gaming experience, please select the closest region to you.
Southeast Asia:
US West (Los Angeles):
US East: (Haven't hosted)
Europe: (Haven't hosted)
Note: The current state of cloud gaming service lite are not optimized for production. The service will still experience lag in the case of heavy traffic. You can try hosting your own service following the instruction in the next session.
Run on local
You can host the server yourself by running ./run_local.sh. It will spawn a docker environment and you can access the emulator on localhost:8000.
Given the roomID, the game session on your local can be accessed over ethernet. The server will bypass NAT and set up a peer connection from remote service to local.
Development environment
Install Golang https://golang.org/doc/install
Install dependencies
- Install libvpx and pkg-config
# Ubuntu
apt-get install -y pkg-config libvpx-dev
# MacOS
brew install libvpx pkg-config
# Windows
...
go get github.com/pion/webrtc/go get github.com/gorilla/websocket
Then we can run the main directly
go run cmd/main.go -debug- for debug UIgo run cmd/main.go- for gameboy UI
Code structure
├── games: roms list, no code logic
├── nes: emulator internal
├── static: static file for front end
│ ├── js
│ │ └── ws.js: client logic
│ ├── gameboy.html: frontend with gameboy ui
│ └── index_ws.html: raw frontend without ui
├── ui
│ ├── director.go: coordinator of views
│ └── gameview.go: in game logic
├── vpx-encoder: vp8 encoding images -> video track
├── webrtc: peer to peer communication
├── main.go: integration between emulator + webrtc (communication) + websocket (signalling)
└── run_local.sh
Follow up
This project demos the simplest cloud game with NES. Integrating with other emulator like GBA, NDS will also be possible. I'm welcome for the contribution.
Credits
- Pion Webrtc team for the incredible Golang Webrtc library and their supports https://github.com/pion/webrtc/.
- fogleman for the awesome nes emulator https://github.com/fogleman/nes.
- poi5305 for the video encoding https://github.com/poi5305/go-yuv2webRTC.
- bchanx for the gameboy https://github.com/bchanx/animated-gameboy-in-css.
- And last but not least, my longtime friend Tri as the co-author.
Contributor
Nguyen Huu Thanh
https://www.linkedin.com/in/huuthanhnguyen/
Tri Dang Minh
https://trich.im