# @epicgames-ps/lib-pixelstreamingsignalling

A library for developers wanting to implement tools and applications that signal Pixel Streaming applications.

## Building

To build the `Signalling` module invoke the following commands in the `Common` and `Signalling` directories.

```bash
npm install
npm run build
```

This will result in a `/dist` output directory.

**Note:** If you just want to get a signalling server up and running refer to ["Getting Started"](../README.md#getting-started).

### NPM package contents
- ES6 module
- CommonJS
- Type definitions
- Source maps

## Documentation

- [Protocol Notes](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/master/Common/docs/Protocol.md)
- [Protocol Messages](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/master/Common/docs/messages.md)

The API documentation is [here](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/tree/master/Signalling/docs) and covers details of all exported components of the library.