game-networking-sockets 0.1.2

Rust abstraction for Valve GameNetworkingSockets library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

# Rust abstraction for [Valve GameNetworkingSockets](https://github.com/ValveSoftware/GameNetworkingSockets)

[![Crates.io](https://img.shields.io/crates/v/game-networking-sockets.svg)](https://crates.io/crates/game-networking-sockets)
[![Docs](https://docs.rs/game-networking-sockets/badge.svg)](https://docs.rs/game-networking-sockets/latest/game-networking-sockets/)

Simple, high-level and (somehow) type-safe wrapper for [Valve GameNetworkingSockets](https://github.com/ValveSoftware/GameNetworkingSockets).

- [**Go ahead and read the documentation**](https://hussein-aitlahcen.github.io/gns-rs/gns/)
- [**Have a quick look at the reliable chat client/server implementation**](./example/src/main.rs)

The library does not require your application to be running with Steam and this wrapper is intended to wrap the open-source version only.

Some features might be missing, if you are interested to introduce more abstraction, feel free to open a PR/Issue.

Libraries:
- `gns-sys` is the C++ library from Valve compiled with bindings generated (the library is directly compiled by cargo so you don't need to have it already installed).
- `gns` is the high level, type-safe Rust wrapper.

## Building

A few system libraries/tools are required in order to compile the C++ library as part of `gns-sys`.

System libraries required:
- `clang`
- `protobuf`
- `openssl`
- `abseil` (if using a recent version of protobuf)

Tools required to be in $PATH:
- `git`
- `protobuf-compiler`

### Windows

Building on Windows uses [vcpkg](https://github.com/microsoft/vcpkg) in manifest mode to gather and 
build dependencies. As such, the only requirement on Windows is to have `clang` installed and `git` 
available in $PATH.