Chatbox Websocket client

[flleeppyy]

About The Pull Request

This PR adds a websocket client to the chatbox, that redirects all incoming payloads from the server, to the specified server, which allows for external integrations with the game. All of which is parsable JSON.

Some ideas include RGB feedback, triggering an event in VTubing software, or automating a physical device based on what's sent to the chat. (For example, a haptic suit, and have a regex for "in the right leg" or any body part)

Works on 515 and 516. (I didn't realize IE11 had websockets until I went to go and make sure my code to disable it worked, then had to double check myself because it was connecting to my websocket server, and working. so. LOL)

Here's a barebones snippet, not feature complete but it has enough where you can start with phrase

const ws = require("ws");
const phrases = require("./phrases");

const LISTENPORT = 8094;
const wss = new ws.Server({ port: LISTENPORT });

wss.on("listening", () => console.log(`Listening on ${LISTENPORT}`));

wss.on("connection", (socket) => {
  console.log("Client connected!");

  socket.on("message", async (data) => {
    try {
      const messageData = JSON.parse(data.toString("utf-8"));
      if (messageData.type !== "chat/message") return;
      const parsedPayload = JSON.parse(messageData.payload);

      if (!parsedPayload?.content?.html) return;

      const message = parsedPayload.content.html.toLowerCase();
      const matchedPhrase = phrases.phrases.find((phrase) =>
        message.match(phrase.regex)
      );

      if (matchedPhrase) {
        // Catched phrase could be something like "stabs you in the chest with the kitchen knife"
        // /(userdanger'>(?:.*you.*in the.*with the))/gi
        
        // example, setup a websocket client to connect to vNyan and send the command "modelBleed"
        if (matchedPhrase.type === "vnyanAction")
          vnyanWs.send(JSON.stringify(matchedPhrase.command))
      }
    } catch (e) {
      console.error("Message Processing Error:", e);
    }
  });

  socket.on("close", () => console.log("Client disconnected."));
});

modules.export = {
  phrases: [
      {
        regex: /(userdanger'>(?:.*you.*in the.*with the))/gi,
        type: "vnyanAction",
        command: "modelBleed"
    },
  ]
}

Why It's Good For The Game

QoL for people who want things outside of the game to respond to in-game actions. See above examples.

Changelog

🆑
add: Chatbox websocket feature
/:cl:

[Addust]

changing music volume apparently triggers a "websocket disabled" message. how.

[flleeppyy]

fixed

changing music volume apparently triggers a "websocket disabled" message. how.

[LikeLakers2]

This seems to be causing a problem for one user - #5791

[Addust]

OOC > addust johnson hits you in the right leg with the mechanical toolbox > hurt the right legs of everyone who dares hook up a haptic suit to ss13

(add a note to make regex ignore OOC or face the consequences)

[flleeppyy]

OOC > addust johnson hits you in the right leg with the mechanical toolbox > hurt the right legs of everyone who dares hook up a haptic suit to ss13

(add a note to make regex ignore OOC or face the consequences)

LOL hahehaheheh
thats something you gotta deal with in your own implementation. The websocket client sends all payloads to the chatbox, to the websocket server you connect it to. You'll be fine as long as you do something like

socket.on("message", async (data) => {
    try {
      const messageData = JSON.parse(data.toString("utf-8"));
      
      if (messageData.type !== "chat/message") return;
      
      const parsedPayload = JSON.parse(messageData.payload);

      if (!parsedPayload?.content?.html) return;

      const message = parsedPayload.content.html.toLowerCase();
      
      if (message.includes('<span class="prefix">OOC:</span>') || message.includes('<span class="ooc"')) return