mirror of https://github.com/giongto35/cloud-game.git synced 2026-01-24 02:55:45 +00:00

Web-based Cloud Gaming service for Retro Game

antstream cloud-computing cloud-gaming distributed game game-online gba go golang google-stadia hacktoberfest hacktoberfest2021 libretro microsoft-xcloud nes retro-games retroarch stadia webrtc xcloud

Find a file

giongto35 1e6684044c Update bit		2019-04-12 01:02:42 +08:00
nes	Update game boy	2019-04-08 20:01:14 +08:00
static	Update bit	2019-04-12 01:02:42 +08:00
ui	Update bit	2019-04-12 01:02:42 +08:00
util	Remove unnecessary code	2019-04-06 01:05:07 +08:00
vpx-encoder	Remove gl	2019-03-31 23:54:02 +08:00
webrtc	Clean room with no sessions	2019-04-10 03:33:21 +08:00
Dockerfile	Update pion package	2019-04-07 02:12:10 +08:00
LICENSE	Update LICENSE	2019-04-11 02:13:48 +08:00
main.go	Clean room with no sessions	2019-04-10 03:33:21 +08:00
README.md	Update Readme	2019-04-11 10:39:35 +08:00
run_local.sh	Update run_local.sh	2019-04-11 23:32:39 +08:00

README.md

Cloud Gaming Service Lite

Cloud Gaming Service is an open source Cloud Gaming Service building on WebRTC.

With cloud gaming, you can play any of your favourite NES game 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.

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)

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.

You can open port, so other person can access your local machine and play the game together.

Development environment

Install Golang https://golang.org/doc/install

Install dependencies

apt-get install libvpx-dev -y (or alternatives of libvpx on other OS)
go get github.com/pion/webrtc/
go get github.com/gorilla/mux
go get github.com/gorilla/websocket

Then we can run the main directly

go run main.go

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 will 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