Giter Club home page Giter Club logo

environment's Introduction

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.

environment's People

Contributors

benedikt-wueller avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

pustekuchen98

environment's Issues

Add config file

Add a config file to configure the following:

  • internal websocket address
  • external websocket address

Sleep in while loop

Add a Thread.sleep statement in the while loop which keeps the processor running to lower the CPU consumption.

Add licenses

Add the licenses of any third party library used.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.