Volodymyr FialkoandBIAGINI Nathan
15d823dab6
* Fix rpc build with other examples
CPP_COMPILE is an option, a cache variable, thus regular unset() is not
working for it since it tries to unset the scope variable.
This causing cmake to skip compilation of rpc.
Unset CPP_COMPILE from CACHE to make it work as intended.
* Fix compiler flags with build targets
Currently tests, soak and examples are build without extra flags,
because add_compile_options is specified after defining build targets.
From add_compile_options() docs:
Adds options to the compiler command line for targets in the current
directory and below that are added *after* this command is invoked.
* Pass debug callbacks as struct
Fixes:
warning: ISO C forbids conversion of function pointer to object pointer
type
* Move global variables under NBNET_IMPL
Nb net could be included multiple times, to prevent creation of global
variables in each file move them under NBNET_IMPL.
Also use designated initializer to initiate a driver structure to
remove warnings about partial initialization. Designated initializer
would initialize other members to zero.
* Resolve unused variables warnings.
Cast unused function arguments to (void) to suspend warnings.
* Resolve signed vs unsigned warnings
Remove unnecessary lt 0 checks and sync types to remove signed vs
unsigned warnings.
* Resolve string related warnings
Fixes:
nbnet/tests/string_tests.c:18:9: error: ‘strncpy’
output truncated before terminating nul copying 5 bytes from a string of
the same length
[-Werror=stringop-truncation]
18 | strncpy(res + pos, b, len_b);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
nbnet/tests/string_tests.c:24:9: error: ‘strncpy’
specified bound depends on the length of the source argument
[-Werror=stringop-truncation]
* Resolve function defined but not used warnings
Mark GameServer_GetClientCount() as inline.
* Attempt to fix warning in ASSERT_VALUE_IN_RANGE
In case when value in unsigned type and min is 0, this commit just
obfuscates types, maybe there's better solution.
Fixes:
warning: comparison of unsigned expression in ‘>= 0’ is always true
[-Wtype-limits]
* Ensure that read len is less than word size
In release mode(-DCMAKE_BUILD_TYPE=Release) tests returning following
error:
nbnet/tests/../nbnet.h:2272:9: error: ‘memcpy’ forming offset [4, 7] is
out of the bound s [0, 4] of object ‘word’ with type ‘Word’ {aka
‘unsigned int’} [-Werror=array-bounds=]
2272 | memcpy(bytes, &word, length); |
^~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add check to verify that length is less than Word size.
* add -Wno-unknown-pragmas flag
* fix examples compilation on windows
* fix examples compilation on windows
* fix examples compilation on windows
* fix unit tests compilation on windows
* fix soak test compilation on windows
* fix unit tests compilation on windows
* fix unit tests compilation on windows
---------
Co-authored-by: BIAGINI Nathan <nath.biagini@gmail.com>
Raylib
This example demonstrates almost all the features of nbnet, it is much more advanced than the echo example.
Each client is represented as a colored square and can:
- move inside the window (with the directional keys)
- switch color (with the spacebar)
- increase or decrease a float value (with K and J jeys, used to demonstrate float serialization)
Each client is responsible of sending updates about his own state to the server. The server gathers states from all clients and stores them. Every tick, the server packs the latest received client states in a message that is then broadcasted to all clients. Each client displays a representation of other clients based on the latest received states from the server.
This example protocol is implemented using three messages:
-
UpdateStateMessage (unreliabe)
This message is sent by a client to the server every tick. It contains the most up to date client state data (position and float value).
-
ChangeColorMessage (reliable)
This message is sent by a client to the server every time it changes its color.
-
GameStateMessage (unreliable)
This message is broadcasted by the server to all connected clients. It contains the most up-to-date states of all clients.
This example also demonstrates how to use the nbnet network conditions simulation, both client and server accept the following command line options:
--packet_loss=<value> # percentage (0 - 1), float value
--packet_duplication=<value> # percentage (0 -1), float value
--ping=<value> # in secondes, float value
--jitter=<value> # in seconds, float value
Information about the state of the connection will be displayed in the bottom right of the client window.
Web
nbnet supports two WebRTC drivers: one using JS and emscripten and a native one fully written in C.
emscripten WebRTC driver
This driver requires the code to be compiled with emscripten.
emcmake cmake -DRAYLIB_LIBRARY_PATH=<path to raylib lib file> -DRAYLIB_INCLUDE_PATH=<path to raylib headers folder> .
To run the server:
npm run server
You can pass options to the server like so:
npm run server -- --packet_loss=<value> ...
To run the client you need to have an HTTP server running and serving the build directory (it contains the HTML file), then you just have to open http://localhost:<PORT>/raylib_client.html in your browser.
When compiling the server this way, it will have to run as a nodejs application and only web clients will be able to connect to it. If you want your server to accept both web and native clients, read the next section.
Native WebRTC driver
Unlike the JS WebRTC driver, this one can be compiled natively and therefore can be used alongside the UDP driver, making it possible to support both UDP socket and WebRTC connections.
Some external dependencies are required:
- libssl
- libcrypto
- libdatachannel
- facil.io
mkdir build
cd build
cmake -DRAYLIB_LIBRARY_PATH=<path to raylib lib file> -DRAYLIB_INCLUDE_PATH=<path to raylib headers folder> -DLIBFACILIO_LIBRARY_PATH=<path libfacil.io lib file> -DLIBCRYPTO_LIBRARY_PATH=<path to libcrypto lib file> -DLIBSSL_LIBRARY_PATH=<path to libssl lib file> -DLIBDATACHANNEL_LIBRARY_PATH=<path to libdatachannel lib file> -DLIBFACILIO_INCLUDE_PATH=<path libfacilio headers folder> -DOPENSSL_INCLUDE_PATH=<path to openssl headers folder> -DLIBDATACHANNEL_INCLUDE_PATH=<path to libdatachannel headers folder> -DWEBRTC_C_DRIVER=ON .
To run the server:
./raylib_server
To run a native client:
./raylib_client
To run a web client simply do the same thing as in the previous section.
Here is a video showcasing one web client and one native client connected to the same server.