discord-ipc-proxy's Introduction

discord-ipc-proxy

A tool to analyze the Discord's IPC/WebSocket communication between server and client. Acts as a middleware between an application (browser, game) and Discord.

Usage

Clone this repo.
npm i to fetch all needed dependencies.
npm start to launch proxy.
Launch Discord. It shouldn't be launched before launching proxy.

The proxy will periodically output to its STDOUT a JSON-formatted messages about the communication between Discord IPC/WS servers and applications connecting to them. This can be used by 3rd-party software to visualize it in more human-readable way (GUI, colorized CLI).

About

This package was designed to help with the development of Discord WebSocket/IPC protocol reimplementations, trying to create a universal bridge that passes entire communication to the another client or server. A diagram showing how it should initialize looks as below:

sequenceDiagram
  participant OS as Operating system
  actor C as Browser/Application
  actor B as IPC Bridge
  actor S as Discord
  activate OS;
  activate B;
  critical setup server
    B->>OS: Initialize server, reserve port/path.
  option all in use or taken
    B--XB: Throw error, clean-up
    B--XOS: End process life
  end
  activate S;
  S->>OS: Initialize server, reserve port/path.
  C->>B: (Open connection)
  activate C;
  critical setup client
    B->S: (Open connection, reuse params/origin)
  option server unavailable
    B->B: "Null proxying" (receives messages but doesn't proxy them)
    B--XOS: End process life
  option closure by Discord
    S->>B: Close with "n" code
    B->>C: Close with "n" code
  option closure by client
    C->>B: Close with "n" code
    B->>S: Close with "n" code
  end
  deactivate C;
  deactivate S;
  deactivate B;
  deactivate OS;

discord-ipc-proxy's People

Contributors

Stargazers

Watchers