Mirrors/cloud-game
1
0
Fork 0
mirror of https://github.com/giongto35/cloud-game.git synced 2026-07-23 01:57:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update read me

Browse source
This commit is contained in:
giongto35 2019-04-11 02:05:17 +08:00
parent 1cf783ce0d
commit 6c60f5c215
1 changed files with 33 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -2,10 +2,11 @@
Cloud Gaming Service is an open source Cloud Gaming Service building on [WebRTC](https://github.com/pion).
With Cloud gaming, you can play any of your favourite NES game directly on your browser without installing it on your machine. It also brings modern online multiplayer gaming experience to NES game, so two people can play the game together . Joystick gaming is the past :P.
With Cloud gaming, you can play any of your favourite NES game directly on your browser without installing it on your machine. It also brings modern online multiplayer gaming experience to classic NES game, so two people can play the game together . Joystick gaming is the past :P.
## Feature
1. Can play NES games directly from browser.
2. Immediately startup, no need to install.
2. Can multiplayer over internet. A person host a game and the other person can join the same game as 1st or 2nd player.
3. Save (S) and Load (L) at any point in time.
4. If you save the roomID, next time you can come back to continue play in that room.
@ -39,7 +40,32 @@ You can host the server yourself by running `./run_local.sh`. It will spawn a do
You can open port, so other person can access your local machine and play the game together.
# Credits
## 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
@ -47,7 +73,11 @@ You can open port, so other person can access your local machine and play the ga
* 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
## LICENSE
[MIT License](LICENSE)
## Contributor
Nguyen Huu Thanh
https://www.linkedin.com/in/huuthanhnguyen/