zig-raknet

A simple RakNet implementation in the Zig programming language.

Note

At the moment, this library only supports the master branch of Zig, meaning that it is prone to breaking changes.

Installation

The library can be installed using Zig's in-progress package manager:

// build.zig.zon
.{
    .name = "your-project-name",
    .version = "your-project-version",
    .dependencies = .{
        .raknet = .{
            .url = "https://github.com/sylvrs/zig-raknet/archive/refs/heads/master.tar.gz",
            // this hash value can be fetched from the error message when trying to build the project
            // there is no current way to get the hash value automatically as the package manager is
            // still very much so an *in-progress* project.
            .hash = "HASHED_VALUE_HERE",
        },
    },
}

// build.zig
pub fn build(b: *std.Build) void {
    const target = b.standardTargetOptions(.{});
    const optimize = b.standardOptimizeOption(.{});
    // add the dependency to the build script
    const network_module = b.dependency("network", .{ .target = target, .optimize = optimize }).module("network");
    const raknet_module = b.dependency("raknet", .{ .target = target, .optimize = optimize }).module("raknet");
    // ...
    // your executable should be defined already
    // i'll be using the name "executable" for the sake of this example
    executable.addModule("raknet", module);
    executable.addModule("network", network_module);
}

Usage

Example usage of the library can be found in the examples directory. Here is what a simple server looks like:

const raknet = @import("raknet");
const network = @import("network");
const std = @import("std");

pub fn main() !void {
    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
    // create a server
    var server = raknet.Server.init(.{
        // the allocator to use for the server
        .allocator = gpa.allocator(),
        // the data to be sent to clients when they ping the server
        .pong_data = "Hello, World!"
        // the address to start listening on
        .endpoint = .{
            .address = .{ .ipv4 = try network.Address.IPv4.parse("0.0.0.0") },
            .port = 19132,
        },
        // whether to print messages from the server into stderr
        .verbose = true,
    });
    defer server.deinit();
    std.debug.print("Listening to data on {any}\n", .{server.address});
    // start the server and listen for incoming connections
    try server.accept();
}