Getting Started

Packeteer provides type-safe packets, promise-based remote functions, and a clean schema-driven networking API for Roblox developers.

Enable strict type checking

For the best experience with Packeteer’s type system, enable Luau strict mode in scripts that interact with Packeteer.

Add --!strict at the top of your scripts:

--!strict

local Network = require(...)

This allows Luau to validate packet arguments, callback parameters, and return values.

Installing Packeteer

Model

InstallationDownload the Packeteer Model

Wally

Packeteer currently does not support Wally.

Creating your Network Schema

The schema is where you define all packets that can be sent between the server and client.

When creating new module scripts containing schemas, it is recommended to put them all in a folder like “ReplicatedStorage/Networking/…”

Caution

Module Scripts containing schemas must always return the schema and not anything else.

local Packeteer = require(path.to.Packeteer)

return Packeteer.create({
  Server = {
    ServerEvent = Packeteer.event<<{ message: string }>>(),
    ServerFunction = Packeteer.packetFunction<<{ message: string }, { number: number }>>()
  },

  Client = {
    ClientEvent = Packeteer.event<<{ message: string }>>()
  },
})

Related: Understanding Network Schemas

The Server and Client sections define packet ownership:

• Server packets are used for server -> client communication.
• Client packets are used for client -> server communication.

Starting Packeteer

Packeteer must be started on the server once using initializeServer().

local Packeteer = require(path.to.Packeteer)
local NetworkingFolder = game.ReplicatedStorage.Networking

Packeteer.initializeServer(NetworkingFolder)