Skip to content
This repository has been archived by the owner on Mar 26, 2022. It is now read-only.

Latest commit

 

History

History
58 lines (30 loc) · 1.71 KB

README.md

File metadata and controls

58 lines (30 loc) · 1.71 KB
Raw

environment

Modular sound system based on WebSockets using the user's browser as audio player.

Terms and Definitions

This section explains terms and definitions used withing this project.

User / Client

Defines the software or person playing or receiving the sounds to be played and sound updates to be executed. Typically the audio player website or an browser addon.

Actor

Defines the software sending sounds to be played and updates to be executed to the processor to be delivered to the user. The actor can be a external dashboard or a software communicating with another system (e.g. a Spigot server plugin).

Processor / Server

Defines the software processing sound and update requests sent by the actor and forwarding them to the user. It provides two WebSocket servers. One for internal communication and the other for external communication.

Live Demo

Navigate to the Demo Actor and follow the steps to check out some of the basic functionality environment provides.

Build

Update protocol for Kotlin

  1. protoc -I=protocol --java_out=protocol-kotlin:/src/main/java protocol/*.proto
  2. cd protocol-kotlin
  3. mvn clean install

Update protocol for JavaScript

  1. cp -r protocol/*.proto demo-js/public/protocol

Build actor api for Kotlin

  1. cd actor-api-kotlin
  2. mvn clean install

Build processor for Kotlin

  1. cd processor-kotlin
  2. mvn clean install

Build JavaScript demo application

  1. npm install
  2. npm run build

License

This code is licensed under the Apache 2.0 License. You can grab a copy of it here. The license is also provided in the project.