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

Add faq (#54)

Browse source 
* Add FAQ

* Update readme

* Update README
This commit is contained in:
giongto35 2019-06-09 23:16:51 +08:00 • committed by GitHub
parent b520dd19f3
commit 13a7c4ed66
1 changed files with 25 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

30
README.md vendored
View file

@ -1,6 +1,6 @@
# Klog, Web-based Cloud Gaming Service
- **SEA**: [http://cloud.webgame2d.com](http://cloud.webgame2d.com) - **US West**: [http://usw.cloud.webgame2d.com](http://usw.cloud.webgame2d.com)
- **US East**: [http://use.cloud.webgame2d.com](http://use.cloud.webgame2d.com) - **Europe**: [http://eu.cloud.webgame2d.com](http://eu.cloud.webgame2d.com)
- **US East**: [http://use.cloud.webgame2d.com](http://use.cloud.webgame2d.com) - **Europe London**: [http://eu.cloud.webgame2d.com](http://eu.cloud.webgame2d.com)
- [**Game Instruction**](document/instruction/)
For the best gaming experience, please select the closest region to you.
@ -18,8 +18,8 @@ Note: The current state of Klog are not optimized for production. The service wi
## Feature
1. Cloud gaming: Game logic is hosted on a remote server. User doesn't have to install or setup anything. Images and audio are streamed to user in the most optimal way.
2. Cross-platform compatibility: The game is run on webbrowser, the most universal builtin app. No console, plugin, external app or devices are needed. The device must support webRTC to perform streaming. Joystick is also supported.
3. Vertically scaled: Services are distributed. The closest server with highest free resource will be assigned to user. (In development)
2. Cross-platform compatibility: The game is run on webbrowser, the most universal built-in app. No console, plugin, external app or devices are needed. The device must support webRTC to perform streaming. Joystick is also supported.
3. Vertically scaled: We can add more machines to handle more traffic. The closest server with highest free resource will be assigned to user (In development).
4. Cloud storage: Game state is storing on online storage, so you can come back to continue playing in a game.
## Run on local by Docker
@ -52,9 +52,29 @@ And run
- ✏ [Design Doc](document/designdoc/)
- 💿 [Implementation Doc](document/implementation/)
## Follow up
## FAQ
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.
### How does the project start?
- The project is inspired by Google Stadia. The most important question comes to everyone mind is how good is the latency? Will gaming experience is affected by the network? I did some researches on that topic and WebRTC seems to be the most suitable protocol for that purpose. I limited the project scope and made a POC of Cloud-gaming. The result indeed looks very promising.
### How good is the result
- My estimation is that it requires 10Mbps per NES game session with resolution 256 * 240.
### Why is the game lag for some people?
- Cloud-gaming is very network-sensitive. It requires the server is close to the user, so please pick the nearest server to you. If there is not, you can try hosting the platform on your own machine followed above instruction and test.
- Cloud-gaming is based on WebRTC peer to peer, so there are some cases direct communication is not possible because of the firewall. In that case, relay communication happens and the game is not smooth. You can find a public network and retry.
- The current state of project is hosted on a limited resource, so during high traffic, the game might got lag due to CPU is overused, not because of the network. Besides, my memory management is not working properly sometimes and game sessions are not fully separated, so the game session can lag over time. In that case, please reload or continue your game by clicking share and reopen the old game.
### Why NES but not some more modern games?
- For the purpose of latency demonstration and fast iteration, I picked NES but integrating with other emulators like GBA, NDS and even Playstation is also possible. For High-end games, there will be problems with hardware and infrastructure. Google has a lot of resource and its distributed GPU will enhance this cloud-gaming use case. My resource is not as abundant, so I consider NES emulator for my first step.
### Why Web browser as the main platform?
- Web browser is most universal built-in app and it will bring the most convenient and modern gaming experience together with cloud-gaming. You can try the platform on Android. Unfortunately, IOS doesn't support WebRTC protocol yet, [http://iswebrtcreadyyet.com/](http://iswebrtcreadyyet.com/)
## Credits