Note: this repository is no longer being updated. Please consider other, more feature rich alternatives such as @rbxts/net.

SimpleSignals

A Roblox-TS RemoteEvent/RemoteFunction/BindableEvent wrapper which puts and end to the hassle of managing events. You can get straight to connecting and firing without any WaitForChild/Instance.new boilerplate, while your event instances get created automatically in the background.

Usage

1SimpleClient.on("z", callbackFunc);

You can import the module this way on the server:

1import { Server as SimpleSignals } from "@rbxts/simplesignals";

and on the client:

1import { Client as SimpleSignals } from "@rbxts/simplesignals";

SimpleSignals manages events cleanly, without you having to instantiate or to WaitForChild:

1SimpleClient.on("printX", (player, x) => {
2	print(x);
3});

1SimpleClient.fire("printX", "X");

You never have to create objects you only use once:

1const printX = new Instance("RemoteEvent");
2printX.Name = "printX";
3printX.Parent = game.GetService("ReplicatedStorage");
4
5printX.OnServerEvent.Connect((player, x) => {
6	print(x);
7});

1const printX = game.GetService("ReplicatedStorage").WaitForChild("printX");
2
3printX.FireServer("X");

API

The library also has JSDoc comments provided.

Examples

Redeem a code for a reward

main.server.ts

1import { Server as simple } from "@rbxts/simplesignals";
2
3const rewards = {
4	ABC123: 500,
5	"1thousand": 1000,
6};
7simple.on("redeemCode", (player, code: string) => {
8	const reward = rewards[code];
9
10	if (reward) {
11		print(`${player.Name} just got ${reward} Coins!`);
12	}
13});

main.client.ts

1import { Client as simple } from "@rbxts/simplesignals";
2import { Players } from "@rbxts/services";
3const LocalPlayer = Players.LocalPlayer;
4
5const screenGui = new Instance("ScreenGui");
6screenGui.Parent = LocalPlayer.WaitForChild("PlayerGui") as Folder;
7const textBox = new Instance("TextBox");
8textBox.Position = UDim2.fromScale(0.5, 0.5);
9textBox.Parent = screenGui;
10
11textBox.FocusLost.Connect((enterPressed) => {
12	if (enterPressed) simple.fire("redeemCode", textBox.Text);
13});