# play-live-server

> Simple servers which enable distributed musical performance

Latest version **1.0.2** (published 2021-02-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install play-live-server
pnpm add play-live-server
yarn add play-live-server
bun add play-live-server
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-02-05 |
| First published | 2018-02-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 3 MB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| Author | Ben Michel |
| Maintainers | obensource |
| Keywords | ['audio', 'music', 'realtime', 'distributed', 'performance', 'ws', 'websockets', 'P2P', 'peer2peer', 'peer-to-peer', 'web, audio', 'web, MIDI', 'server'] |

## Links

- npm: https://www.npmjs.com/package/play-live-server
- Repository: https://github.com/obensource/play-live-server
- Homepage: https://github.com/obensource/play-live-server#readme
- Issues: https://github.com/obensource/play-live-server/issues
- npm.io page: https://npm.io/package/play-live-server

## Dependencies (4)

- [ws](https://npm.io/package/ws.md) ^4.1.0
- [joi](https://npm.io/package/joi.md) ^17.3.0
- [@hapi/hapi](https://npm.io/package/@hapi/hapi.md) ^20.1.0
- [@hapi/inert](https://npm.io/package/@hapi/inert.md) ^6.0.3

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2021-02-05
- 1.0.1 — 2018-02-05
- 1.0.0 — 2018-02-05

## README

# Play Live Server

<img src="remote-performer.png" alt="remote-performance-app" width="625px"/>

__A set of simple servers that enable realtime distributed music & audio performance application development.__

This module aims to provision servers that actualize useful patterns of musical collaboration for geographically distributed performers.

## Installation
$`npm install play-live-server`

## Use
### Import
Import **Play Live Server** into your app’s startup script (eg. `src/app.js`): <br/>
`const PlayLiveServer = require(‘play-live-server’)`

### Call With `appPath` & `type` parameters
```js
const path = require('path')

PlayLiveServer({appPath: path.join(__dirname, '/static'), type: 'p2p'})
```
* Required parameters
  * `appPath`: Provides the directory path of your app's index to the server route handler. It should be the directory where your bundle is injected into your index file (eg. static/index.html).
  * `type`: Select the server type.<br/>
  Currently supported types: `'broadcast'`, `'p2p'`

## Under Development
This module is not ready for prime-time yet, and is currently under active developement. The only reason it was published was to secure the registry name. Still, great things to come! 🙌
## 
##### License: [ISC](https://opensource.org/licenses/ISC)

---
_Source: https://npm.io/package/play-live-server · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._