Skip to content

Latest commit

 

History

History
53 lines (31 loc) · 2.04 KB

README.md

File metadata and controls

53 lines (31 loc) · 2.04 KB
Raw

Silex Socket Service

CI

Silex Socket Service is the Socket.IO websocket and http API that acts as a bridge between dcc clients and front-end apps.

Introduction

In the Silex pipeline, the front-end application is not integrated directly in the DCC software like Maya or Houdini. Instead, silex-front is a web application running in Electron.

Since we need to communicate between the Python client and the interface, we use websockets. The server handles multiple dcc clients connections and forward messages back and forth to the interface.

Using Socket.IO is a good solution for this bidirectional communication.

For additional information go to the Wiki!

Installation

The package manager used is Yarn. Clone the repository and install the dependencies:

$ git clone https://github.com/ArtFXDev/silex-socket-service
$ cd silex-socket-service
$ yarn install # Install the dependencies

Usage

Available scripts

  • 🚀 yarn start -> Start the HTTP server with WS and Express routes listeners

  • 🧪 yarn test -> Run unit tests

Libraries

Here are the main libraries and packages used:

Library Version
Socket.IO 4.4.0
Express 4.17.1

Contributing

Pull requests and issues are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT @ArtFX