Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/circlecloud/rbxts-socket.io
This is a full implementation of Socket.IO on Roblox.
https://github.com/circlecloud/rbxts-socket.io
rbxts roblox socket-io socketio
Last synced: about 2 months ago
JSON representation
This is a full implementation of Socket.IO on Roblox.
- Host: GitHub
- URL: https://github.com/circlecloud/rbxts-socket.io
- Owner: circlecloud
- Created: 2024-11-30T10:32:43.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-30T19:29:16.000Z (about 2 months ago)
- Last Synced: 2024-11-30T20:24:19.648Z (about 2 months ago)
- Topics: rbxts, roblox, socket-io, socketio
- Language: TypeScript
- Homepage:
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# Socket.IO implementation on Roblox
This is a full implementation of Socket.IO on Roblox.
> Because Roblox not support WebSocket, this implementation use HTTP long polling to communicate with server.
## Limit
### Roblox Limit 500 request per minute.
So this implementation will cache send packet and send request every 0.3 seconds.
you can see `src/engine.io-client/transports/polling-roblox.ts`
```ts
RunService.Heartbeat.Connect((dt) => {
RobloxGlobalConfig.resetTime -= dt;
if (RobloxGlobalConfig.resetTime < 0) {
RobloxGlobalConfig.resetTime = RobloxGlobalConfig.REQUEST_TIMES_RESET_INTERVAL;
RobloxGlobalConfig.requestTimes = 0;
}
});
task.delay(0, () => {
while (this.running) {
this.flush();
wait(0.3);
}
});
```
### Roblox request unstable.
So on Server side you need enable [connection-state-recovery](https://socket.io/docs/v4/connection-state-recovery)
```ts
import { createServer } from "http";
import { Server } from "socket.io";
const server = createServer();
const io = new Server(server, {
// enable state recovery
connectionStateRecovery: {
// the backup duration of the sessions and the packets
maxDisconnectionDuration: 2 * 60 * 1000,
// whether to skip middlewares upon successful recovery
skipMiddlewares: true,
},
pingInterval: 50000,
});
io.on("connection", (socket) => {
if (socket.recovered) {
// recovery was successful: socket.id, socket.rooms and socket.data were restored
} else {
// new or unrecoverable session
}
});
```
```ts
const client = io.connect("http://localhost:3000", {
reconnectionDelay: 10000, // defaults to 1000
reconnectionDelayMax: 10000, // defaults to 5000
});
socket.on("connect", () => {
if (socket.recovered) {
// any event missed during the disconnection period will be received now
} else {
// new or unrecoverable session
}
});
```
> more long interval and send packet one time can reduce request times to prevent triggering roblox request restrictions.
You can config use RobloxGlobalConfig
```ts
// default config
export class RobloxGlobalConfig {
/**
* Max request per minute
*/
public static MAX_REQUEST_PER_INTERVAL = 200;
/**
* Interval to reset request times
*/
public static REQUEST_TIMES_RESET_INTERVAL = 60;
/**
* Interval to flush packets
*/
public static FLUSH_PACKET_INTERVAL = 0.3;
}
// Modify config
RobloxGlobalConfig.MAX_REQUEST_PER_INTERVAL = 500;
RobloxGlobalConfig.FLUSH_PACKET_INTERVAL = 0.5;
```
## Installation
```sh
npm install @rbxts/socket.io
yarn add @rbxts/socket.io
pnpm add @rbxts/socket.io
```
## Usage
use example
```ts
import { io } from "@rbxts/socket.io";
const socket = io("http://localhost:3000");
socket.on("connect", () => {
print("connected");
});
socket.on("disconnect", () => {
print("disconnected");
});
socket.on("message", (message) => {
print(message);
});
```
namespace support
```ts
import { RunService } from "@rbxts/services";
import { io } from "@rbxts/socket.io";
const manager = new Manager("http://localhost:3000");
const socket = manager.socket("/"); // main namespace
const adminSocket = manager.socket("/admin"); // admin namespace
socket.emit("players", { onlines: Players.GetChildren().size() });
adminSocket.on("kick", (uid, reason) => {
Players.GetPlayerByUserId(uid)?.Kick(reason);
});
```