基于c++ + VS2019开发的云游戏引擎工程

# Regame - Cloud Gaming Engine [简体中文](README.zh-CN.md) | English `Regame - Cloud Gaming Engine` is a set of technologies developed by Edge computing team of [Ksyun](https://www.ksyun.com/) to serve the cloud game scene. Cloud gaming is a method of playing video games that is done using remote hardware. You don't have to download or install games locally, just begin playing the game immediately because it is being run on remote servers. Cloud gaming engine is a core technology to host ordinary games on remote server and start cloud gaming service. `Regame` is still under development. It would be great if you could help. [Download Regame v0.4 here](https://ks3-cn-beijing.ksyun.com/liuguang/regame_v0.4.zip) Demo videos (Chinese): - [01-Regame Cloud Gaming Demo - Street Fighter](https://www.bilibili.com/video/bv1jt4y1r7GT) - bilibili - [01-Regame Cloud Gaming Demo - Street Fighter](https://www.ixigua.com/6898563893564703239) - ixigua - [01-Regame Cloud Gaming Demo - Street Fighter](https://www.zhihu.com/zvideo/1314567244832530432) - zhihu - [09-Regame WebRTC - Accelerate the cloud trip of enterprise business - English subtitle](https://www.bilibili.com/video/BV1g34y1U7RL) - 哔哩哔哩 - [09-Regame WebRTC - Accelerate the cloud trip of enterprise business - English subtitle](https://www.ixigua.com/7023285940831552031) - 西瓜视频 - [09-Regame WebRTC - Accelerate the cloud trip of enterprise business - English subtitle](https://www.zhihu.com/zvideo/1436363494992445440) - 知乎 ## 1. Requirements ### Server | Target | Minimum | Recommended | | --- | --- | --- | | System | Windows 7, 8, 8.1, 10 | Windows 10 | | GPU | NVIDIA GPU | GTX 1080Ti, RTX 2070S tested | | Software | GeForce Experience | latest GeForce Experience | | Driver | GeForce Game Ready Driver | latest GeForce Game Ready Driver | ### Client | Target | Minimum | Recommended | | --- | --- | --- | | System | Windows 7, 8, 8.1, 10 | Windows 10 | | CPU | ANY | amd64 | ## 2. Basic - `cgh` use Hook technology to capture image, support most of DirectX games, such as Cyberpunk 2077, Street Fighter. - `cge` use FFmpeg to encode audio and images `cgh` captured into streaming. - `cgc` use FFmpeg to decode audio and video frames, and use SDL2 to play audio and show images. [](doc/cg.gv) ## 3. QuickStart [FAQ](doc/faq.md) ### cge The `Cloud Gaming Engine`. You can launch `cge` directly, which will apply default options. Run `cge --help` to see all options: ``` KSYUN Edge Cloud Gaming Engine v0.4 Beta Usage: -h [ --help ] Produce help message --audio-bitrate arg (=128000) Set audio bitrate --audio-codec arg (=libopus) Set audio codec. Select one of {libopus, aac, opus} --bind-address arg (=::) Set bind address for listening. eg: 0.0.0.0 --disable-keys arg Disable scan codes. eg: 226,230 disable ALT; 227,231 disable WIN --donot-present arg (=0) Tell cgh don't present --hardware-encoder arg Set video hardware encoder. Select one of {amf, nvenc, qsv} --gamepad-replay arg (=none) Set gamepad replay method. Select one of {none, cgvhid, vigem} --keyboard-replay arg (=none) Set keyboard replay method. Select one of {none, cgvhid} --mouse-replay arg (=none) Set mouse replay method. Select one of {none, cgvhid} --log-level arg (=info) Set logging severity level. Select one of {trace, debug, info, warning, error, fatal} -p [ --port ] arg (=8080) Set the service port --video-bitrate arg (=1000000) Set video bitrate --video-codec arg (=h264) Set video codec. Select one of {h264, h265, hevc}, h265 == hevc --video-gop arg (=180) Set video gop. [1, 500] --video-preset arg Set preset for video encoder. For AMF, select one of {speed, balanced, quality}; For NVENC, select one of {p1, p2, p3, p4, p5, p6, p7, slow, medium, fast}; For QSV, select one of {veryfast, faster, fast, medium, slow, slower, veryslow}; otherwise, select one of {ultrafast, superfast, veryfast, faster, fast, medium, slow, slower, veryslow, placebo} --video-quality arg (=23) Set video quality. [0, 51], lower is better, 0 is lossless ``` You can press `Ctrl+C` to stop it gracefully. ### regame-authenticator `cge` uses [regame-authenticator](https://github.com/ksyun-kenc/regame-authenticator) to verify login. [](doc/regame-authenticator.gv) ### cgh Some hook dlls for capturing pictures from D3D game. ### cgi A tool for injecting hook dll into game process. [](doc/cgi.gv) ``` Allowed options: -h [ --help ] Produce help message -d [ --dynamic ] arg Use dynamic injecting -e [ --exec ] arg Path of the executable -a [ --arg ] arg Arguments of the executable -c [ --cd ] arg Current directory for the executable -i [ --imagename ] arg Image name of the process being injected. -w [ --wait ] arg (=1,000) Wait before injecting. unit: ms --lx86 arg Path of x86 library to inject into process --lx64 arg Path of x64 library to inject into process ``` ### cgvhid Cloud gameing Virtual HID driver. For replaying controller event on server.  ### cgvidd Cloud gameing Virtual Indirect Display Driver. For capturing screen on server. ### video_source A tool for testing. Just run it, and it will generate simple pictures and write them as video frames to shared memory, then notify `cge` to fetch. You can use `cgc` to see these pictures. It also can be used to test latency. Video Reference (Chinese): - [05-Regame Cloud Gaming Engine: Latency Test](https://www.bilibili.com/video/BV1KU4y147ks/) - bilibili - [05-Regame Cloud Gaming Engine: Latency Test](https://www.ixigua.com/6918363287298146823) - ixigua ### cgc A simple client to work with `cge`. ``` Ksyun Edge Cloud Gaming Client v0.3 Beta Usage: -h [ --help ] Produce help message --audio-frame-delay arg (=2) Set audio frame max delay, [0, 8] -f [ --fullscreen-state ] arg (=none) Set fullscreen state, can be one of {none, real, fake} -l [ --list-hardware-decoder ] List hardware decoder -d [ --hardware-decoder ] arg Set hardware decoder -r [ --remote-host ] arg (=127.0.0.1) Set remote host -p [ --remote-port ] arg (=8080) Set remote port --top-most arg Keep the main window always on top -u [ --username ] arg Set username --verification-code arg Set verification code --volume arg (=100) Set volume, [0, 100] ``` ### cgs A WebRTC server works together with `cge`, to serve web clients. ## 4. Setting Up Your Build Environment ### 4.1 VS2019 [Reference .vsconfig](doc/.vsconfig)  ### 4.2 Boost Install [Boost](https://www.boost.org/) and set `BOOST_ROOT` environment variable to install directory. [Details](https://blog.umu618.com/2020/09/11/umutech-boost-1-installation/) Boost compile command: ``` # For MTRelease configuration .\b2 --address-model=64 runtime-link=static ``` Video Reference (Chinese): - [06-Regame Cloud Gaming Engine FAQ: Compile Boost](https://www.bilibili.com/video/BV1P5411J7L8/) - bilibili - [06-Regame Cloud Gaming Engine FAQ: Compile Boost](https://www.ixig