README.md

Rain Net

It is a bare-bones networking library built on top of Asio, for use in any type of game that requires communication with a server over the reliable and connection-oriented TCP protocol.

It is used to build both the client and the server side. Check out the header files for some documentation and see the client_server example from tests.

It requires C++17. I tested it on GCC 14.1 and MSVC 19.39.

Usage

Add this repository as a git submodule:

git submodule add -b stable -- https://github.com/SimonMaracine/Rain-Net <path/to/submodule>

and then write this in CMakeLists.txt:

add_subdirectory(<path/to/submodule>)
target_link_libraries(<target> PRIVATE rain_net_client)  # rain_net_client/rain_net_server

Link against the client or server target, whichever you're using in your binary.

To build the tests, set this variable before add_subdirectory(...):

set(RAIN_NET_BUILD_TESTS ON)

Development takes place on the main branch. The stable branch is for actual use.