Web-based Cloud Gaming service for Retro Game
Find a file
2019-05-23 00:36:58 +08:00
cmd Worker listen to random port so we can run multiple worker 2019-05-21 23:54:31 +08:00
config WIP 2019-04-28 21:45:30 +07:00
cws Update run local 2019-05-19 23:55:41 +08:00
document Update design doc 2019-05-23 00:36:58 +08:00
emulator use for to wait channel 2019-05-20 16:00:09 +08:00
games Merge branch 'master' into frontend2 2019-05-15 02:10:18 +08:00
overlord Update save and load 2019-05-19 20:00:24 +08:00
static Update readme overlord (#33) 2019-05-21 23:30:22 +08:00
util Allocation inplace 2019-05-15 02:52:00 +08:00
vpx-encoder Worker listen to random port so we can run multiple worker 2019-05-21 23:54:31 +08:00
webrtc use for to wait channel 2019-05-20 16:00:09 +08:00
worker use for to wait channel 2019-05-20 16:00:09 +08:00
.gitattributes Help github detect golang 2019-04-15 00:51:50 +08:00
.gitignore Update gitignore 2019-04-16 01:35:13 +08:00
Dockerfile update run script 2019-05-05 21:11:37 +08:00
LICENSE Update LICENSE 2019-04-11 02:13:48 +08:00
README.md Update document 2019-05-22 23:34:00 +08:00
run_local.sh Update run local 2019-05-19 23:55:41 +08:00
run_local_docker.sh Update run local 2019-05-19 23:55:41 +08:00

Web-based Cloud Gaming Service

SEA: http://cloud.webgame2d.com | US West: http://us.cloud.webgame2d.com | US East: http://use.nes.webgame2d.com | Europe: http://eu.nes.playcloud.games For the best gaming experience, please select the closest region to you.

Web-based Cloud Gaming Service is an open source Cloud Gaming Service building on WebRTC using browser as the main platform.

.. aims to bring the most convenient gaming experience to gamer. You can play any games on your browser directly, which is fully compatible on multi-platform like Desktop, Android, IOS. This flexibility enables modern online gaming experience to retro games starting with NES in this current release.

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.

screenshot

Demo

https://www.youtube.com/watch?v=qkjV2VIwVIo

Feature

  1. Cloud gaming: Game logic is handled in server and streamed to user.
  2. Cross-platform compatibility: The game is run on webbrowser, the most universal builtin app. No console, external app or devices are need.
  3. Verially scaled: Services are distributed. The closest server with highest free resource will be assigned to user. (In progress)
  4. Collaborative hosting: this is our invented term refering to the whole community can contribute to host the platform. Whenever the server is hosted and able to connect to the coordinator, it can join the cloud-gaming network and Collaboratively serve prod traffic.
  5. Local streaming: If you host a server on your local machine and play game on other device close to that, the game will automatically detect running local server and serve the traffic.
  6. Cloud storage: Game state is storing on an online storage, so you can come back to continue playing in a game.

Run on local by Docker

You try hosting the server yourself by running ./run_local_docker.sh. It will spawn a docker environment and you can access the emulator on localhost:8000.

Development environment

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

Install dependencies

# Ubuntu
apt-get install -y pkg-config libvpx-dev

# MacOS
brew install libvpx pkg-config

# Windows
...

And golang dependencies

  • go get github.com/pion/webrtc/
  • go get github.com/gorilla/websocket
  • go get gopkg.in/hraban/opus.v2
  • go get github.com/satori/go.uuid
  • go get cloud.google.com/go/storage

And run

  • ./run_local.sh

Collaborative hosting

  • go run cmd/main.go -overlordhost ... - start game workers (in charge of peerconnection) connecting to cloud-game network

Documentation

Design Doc Implentation

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

Contributor

Nguyen Huu Thanh
https://www.linkedin.com/in/huuthanhnguyen/

Tri Dang Minh
https://trich.im