A (moderately) simple p5.js library for connecting to websocket servers like the one at https://p5-websocket.glitch.me/.
The intention of this library is to make sketch-to-sketch communication as simple as possible. It was originally built for teaching, so we've tried to hide as much of the complexity of browser-based networking as possible.
There's an example sketch at examples/sketch.js
First, download dist/p5.websocket.min.js and add it to your sketch's index.html file or use a CDN (content delivery network) to get the code straight from GitHub:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" />
<script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/p5.js"></script>
<script src="https://cdn.jsdelivr.net/gh/abachman/p5.websocket/dist/p5.websocket.min.js"></script>
<script src="sketch.js"></script>
</head>
<body></body>
</html>A simple sketch that communicates with other sketches must include at least three things, a single call to connectWebsocket in the sketch setup, a user defined function messageReceived, and calls to sendMessage wherever you want your sketch to send data.
let myColor = [100, 100, 100];
function setup() {
createCanvas(200, 200);
noStroke();
// **1** Connect to the chat.reasonable.systems p5 websocket server on the
// channel named "p5.websocket-example". Every sketch on the same channel
// will receive messages from this sketch in its `messageReceived` function.
connectWebsocket("wss://chat.reasonable.systems/p5.websocket-example");
}
function draw() {
background(255);
fill(myColor);
ellipse(width / 2, height / 2, width);
}
function mousePressed() {
// **2** Send a message on the connected channel.
sendMessage({ color: [random(255), random(255), random(255)] });
}
// **3** Receive a message on the connected channel.
function messageReceived(data) {
myColor = data.color;
}You can play with a copy of this sketch here.
connectWebsocket(url, options)
sendMessage(message)
NOTE: uid in the functions below is the unique ID assigned to a given connection by p5-websocket-server.
onConnection(uid) when this sketch has finished connecting. The uid received is this sketch's own.
onDisconnection when this sketch has finished disconnecting. Usually only if the websocket server restarts or internet goes in-and-out.
connectReceived(uid) when another session connects.
disconnectReceived(uid) when another session disconnects.
messageReceived(data, uid) when a message is received from a session. If config includes { echo: true } (the default) then the given sketch will receive its own messages.
- Clone this repository and run
npm install. - Run
npm run dev. - In another terminal, serve
example/as a static site.
$ npm install
$ npm run dev
> [email protected] dev
> parcel watch src/index.js -d example/ --out-file example/p5.websocket.js
✨ Built in 2.83s.
# in another terminal
$ npm run serve
┌──────────────────────────────────────────┐
│ │
│ Serving! │
│ │
│ - Local: http://localhost:3000 │
│ - Network: http://192.168.1.19:3000 │
│ │
│ Copied local address to clipboard! │
│ │
└──────────────────────────────────────────┘Check out the p5.websocket reference server.