DelayNoMore/README.md

Preface

This project is a demo for a websocket-based rollback netcode inspired by GGPO.

As lots of feedbacks ask for a discussion on using UDP instead, I tried to summarize my personal opinion about it in ConcerningEdgeCases -- since v0.9.25, the project is actually equipped with UDP capabilities as follows.

• When using the so called native apps on Android and Windows (I'm working casually hard to support iOS next), the frontends will try to use UDP hole-punching w/ the help of backend as a registry. If UDP hole-punching is working, the rollback is often less than turn-around frames to recover and thus not noticeable, being much better than using websocket alone. This video shows how the UDP holepunched p2p performs for Phone-Wifi v.s. PC-Wifi (viewed by PC side).
• If UDP hole-punching is not working, e.g. for Symmetric NAT like in 4G/5G cellular network, the frontends will use backend as a UDP tunnel (or relay, whatever you like to call it). This video shows how the UDP tunnel performs for Phone-4G v.s. PC-Wifi (viewed by PC side).
• Browser vs native app is possible but in that case only websocket is used.

The following video is recorded over INTERNET using an input delay of 4 frames and it feels SMOOTH when playing! Please also checkout these demo videos

• source video of the first gif (earlier version)
• source video of the second gif (added turn-around optimization & dashing)

to see how this demo carries out a full 60fps synchronization with the help of batched input upsync/downsync for satisfying network I/O performance.

Notable Features

• Backend dynamics toggle via Room.BackendDynamicsEnabled
• Recovery upon reconnection (only if backend dynamics is ON)
• Automatically correction for "slow ticker", especially "active slow ticker" which is well-known to be a headache for input synchronization
• Frame data logging toggle for both frontend & backend, useful for debugging out of sync entities when developing new features

(how input delay roughly works)

(how rollback-and-chase in this project roughly works)

(By use of GopherJs, the frontend codes for dynamics are now automatically generated)

1. Building & running

1.1 Tools to install

Backend

• Command Line Tools for Xcode (on OSX) or TDM-GCC (on Windows) (a make executable mandatory)
• Golang1.18.6 (brought down to 1.18 for GopherJs support, mandatory, in China please try a mirror site like that of ustc)
• GopherJs1.18.0-beta1 (optional, only for developemnt)
• MySQL 5.7 (mandatory, for OSX not all versions of 5.7 can be found thus 5.7.24 is recommended)
• Redis 3.0.503 or above (mandatory)
• skeema (optional, only for convenient MySQL schema provisioning)
• protobuf CLI (optional, only for development)

Frontend

• CocosCreator v2.2.1 (mandatory, ONLY AVAILABLE on Windows or OSX and should be exactly this version, DON'T use any other version because CocosCreator is well-known for new versions not being backward compatible)
• protojs (optional, only for development)

1.2 Provisioning

Backend/Database

It's strongly recommended that skeema is used for provisioning the required schema in MySQL instance. When using skeema the steps are as follows.

### Mandatory after an initial clone
user@proj-root/database/skeema-repo-root> cp .skeema.template .skeema

### Mandatory
user@proj-root/database/skeema-repo-root> skeema push

On Windows 10/11, you can compile skeema from source and config the host to be 127.0.0.1 instead of localhost to use it, i.e. circumventing the pitfall for MySQL unix socket connection on Windows.

Backend/Golang

user@proj-root/battle_srv/configs> cp -r ./configs.template ./configs

Frontend

user@proj-root/frontend/assets/plugin_scripts> cp ./conf.js.template ./conf.js

1.3 Actual building & running

Backend

### The following command runs mysql-server in foreground, it's almost NEVER run in such a way, please find a proper way to run it for yourself
user@anywhere> mysqld

### The following command runs redis-server in foreground, it's OK to put it in background
user@anywhere> redis-server

### on Windows using TDM-GCC: mingw32-make run-test 
user@proj-root/battle_srv> make run-test

Frontend

The easy way is to try out 2 players with test accounts on a same machine.

• Open CocosCreator v2.2.1 (mandatory, it serves the web content of the following steps)
• Open one browser instance, visit http://localhost:7456?expectedRoomId=1, input addon the username box and click to request a captcha, this is a test account so a captcha would be returned by the backend and filled automatically (as shown in the figure below), then click and click to proceed to a matching scene.
• Open another browser instance, visit http://localhost:7456?expectedRoomId=1, input bddon the username box and click to request a captcha, this is another test account so a captcha would be returned by the backend and filled automatically, then click and click to proceed, when matched a battle(but no competition rule yet) would start.
• Try out the onscreen virtual joysticks to move the cars and see if their movements are in-sync.

2 Troubleshooting

2.1 Redis snapshot writing failure

ErrFatal        {"err": "MISCONF Redis is configured to save RDB snapshots, but is currently not able to persist on disk. Commands that may modify the data set are disabled. Please check Redis logs for details about the error."}

Just restart your redis-server process.

2.2 Why not show "PING value" on frontend display?

The most important reason for not showing "PING value" is simple: in most games the "PING value" is collected by a dedicated kernel thread which doesn't interfere the UI thread or the primary networking thread. As this demo primarily runs on browser by far, I don't have this capability easily.

Moreover, in practice I found that to spot sync anomalies, the following tools are much more useful than the "PING VALUE".

• Detection of prediction mismatch on the frontend.
• Detection of type#1 forceConfirmation on the backend.
• Detection of type#2 forceConfirmation on the backend.

There's also some useful information displayed on the frontend when true == Map.showNetworkDoctorInfo.

2.3 WIN32 platform tool versioning

When building for native platforms, it's much more convenient to trigger the CocosCreator project forming frmo CLI, e.g.

shell> cd <proj-root>
shell> /path/to/CocosCreator.exe --path ./frontend --build "platform=win32;debug=true"

2.4 CococCreator native build reloading

CocosCreator doesn't have perfect file cache management during native project building, use "Developer Tools > Reload" to reset the IDE status upon mysterious errors.

Another issue is with the package name, see the screenshot below, kindly note that after successfully building with a blank package name, you can then re-fill the desired package name and build again!

2.5 Checking UDP port binding result

*nix

netstat -anp | grep <your_port>

Windows

netstat -ano | grep <your_port>

2.6 Checking native code crash on non-rooted Android phone

DeveloperOs> adb bugreport ./logs.zip
# The file "logs.zip" will be automatically pulled to current folder of the DeveloperOS, copy "logs/FS/data/tomestones" out of the zip, then use the binary "$NDK_ROOT/ndk-stack" to analyze whichever tombstone you're interested in, for example, I often use the following
DeveloperOs> ${NDK_ROOT}/ndk-stack.cmd -sym \path\to\DelayNoMore\frontend\build\jsb-link\frameworks\runtime-src\proj.android-studio\app\build\intermediates\ndkBuild\debug\obj\local\arm64-v8a -dump \path\to\tombstones\tombstone_03  
# The param "-sym \path\to\objs" tells "ndk-stack" to decode "tombstone_03" with symbols provided by all the files inside that "\path\to\objs".