What is Red?

Red is a networking library for Roblox that combines blazingly fast performance with a simple API. With Red's tiny size, it is suitable for any project, from tiny experiments to games that serve millions of players.

Features

⚡Blazingly Fast

Red achieves high performance by packing events in a compressed format, using up to 75% less bandwidth. Red uses a single remote event with identifiers to reduce bandwidth, and increase performance.

⚙️No Config

Red is designed to work out of the box with no configuration required. Just require the library and begin developing. No config means less boilerplate and more time to focus on what matters: your project.

🔐Type Safety

Red is written with type safety in mind, so you can use Luau and get full intellisense and linting right in your editor. Full intellisense without any extra work means faster development with autocomplete and catching bugs before they happen.

🔎Obfuscation

As part of it's optimization features, Red obfuscates network data to make it harder for cheaters to read networking logs. This makes it significantly harder for cheaters to reverse engineer and cheat in your game.

Documentation

Red's documentation can be found here.

Implementing SharedEvents

Figured I could take a shot at implementing these so you no longer have to explicitly call :Server and :Client when requiring events.

I've read the code you wrote for this around a month ago but since your mind may have changed on how to implement it in that time, I think it would be good to get it figured out here.

Call Modes

Call

Only one listener. It is called directly in a new thread, rather than going through the slight overhead of a Signal object.

Signal

Any number of listeners. Slightly worse for performance as it needs to go through the Signal:Fire code, which while very small, does add some slight overhead.

Event Declaration

Follows the same format as regular events

local ReplicatedStorage = game:GetService("ReplicatedStorage")
local Red = require(ReplicatedStorage.Packages.Red)

return Red.SharedEvent({
    Name = "Name",
    Unreliable = false,
    CallMode = "Signal"
}, function() end)

If the Reliability and CallMode, are not specified, it will choose sensible defaults.

local ReplicatedStorage = game:GetService("ReplicatedStorage")
local Red = require(ReplicatedStorage.Packages.Red)

-- Defaults to Reliable, and Signal call mode.
return Red.SharedEvent("Identifier", function() end)

Usage

Call Mode

-- Client
local SharedEvent = require(ReplicatedStorage.SharedEvent)
SharedEvent:SetClientListener(...)
SharedEvent:FireServer(...)

SharedEvent:FireClient(...) -- errors

-- Server
local SharedEvent = require(ReplicatedStorage.SharedEvent)
SharedEvent:SetServerListener(...)
SharedEvent:FireClient(...)

SharedEvent:FireServer(...) -- errors

Signal Mode

-- Client
local SharedEvent = require(ReplicatedStorage.SharedEvent)
SharedEvent:OnClient(...)
SharedEvent:FireServer(...)

SharedEvent:FireClient(...) -- errors

-- Server
local SharedEvent = require(ReplicatedStorage.SharedEvent)
SharedEvent:OnServer(...)
SharedEvent:FireClient(...)

SharedEvent:FireServer(...) -- errors

Final Note

I'm happy to write the tests for these once the implementation is finalized, but what were the issues in implementation you encountered when writing them? Would be useful to know so I don't end up running into the same brick wall.

red-blox / red Goto Github PK

red's Introduction

What is Red?

Features

⚡Blazingly Fast

⚙️No Config

🔐Type Safety

🔎Obfuscation

Documentation

red's People

Contributors

Stargazers

Watchers

Forkers

red's Issues