Skip to content

bryson-g/websyn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Installation

Node.js

npm i https://github.com/bryson-g/Websyn.git

Lua

local websyn = loadstring(game:HttpGet('https://raw.githubusercontent.com/bryson-g/Websyn/main/rbx-counterpart/client.lua'))()

Usage

Example #1: Server log arguments:

Node.js (server)

const websyn = require('websyn');

const server = new websyn(8000); // Optional socket parameter, default is 8000

// Username of the sender will always be the first parameter
server.connect('EventNameHere', (username, ...args) => {
    console.log(`${username} has triggered this event`);
    console.log(args);

    /* 
    Expected output: 
       <username> has triggered this event
       ['hello', 'goodbye']
    */
});

Lua (client)

local websyn = loadstring(game:HttpGet('https://raw.githubusercontent.com/bryson-g/Websyn/main/rbx-counterpart/client.lua'))()

local client, server = websyn.create("8000") -- Optional socket parameter, default is 8000

server.EventNameHere:Send('hello', 'goodbye'); -- Only string paremeters allowed

Example #2: Trigger client event from server:

Node.js (server)

const websyn = require('websyn');

const server = new websyn();
server.send({
    event: 'PrintArgs',
    username: '', // example username
    args: ['burger', 'burrito', 'taco']
});

Lua (client)

local websyn = loadstring(game:HttpGet('https://raw.githubusercontent.com/bryson-g/Websyn/main/rbx-counterpart/client.lua'))()

local client, server = websyn.create()
client.PrintArgs:Connect(function(...)
    for i,v in next, {...} do
        print(i,v)
    end
end)

About

📦 A utility package for websocket communication between front-end and back-end deployed applications, for Synapse tooling.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors