https://github.com/lachee/hypecorner-api

API for HypeCorner that handles the orchestra and blacklist
https://github.com/lachee/hypecorner-api

api nodejs-server rainbow-six-siege twitch

Last synced: about 2 months ago
JSON representation

API for HypeCorner that handles the orchestra and blacklist

• Host: GitHub
• URL: https://github.com/lachee/hypecorner-api
• Owner: Lachee
• License: mit
• Created: 2020-07-25T15:01:51.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T20:40:52.000Z (about 2 years ago)
• Last Synced: 2024-05-01T13:55:33.493Z (8 months ago)
• Topics: api, nodejs-server, rainbow-six-siege, twitch
• Language: JavaScript
• Homepage: https://github.com/Lachee/hypecorner
• Size: 1.67 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# Hypecorner API - Orchestra

This is the Orchestra that handles blacklisting and orchestration of channels. 

Check out the HypeCorner Bot at [github.com/lachee/hypecorner](https://github.com/lachee/hypecorner)

Check out [HypeCorner.tv](https://hypecorner.tv), a live instance of this!

.

.

.

## Usage

Really stupid easy. 

1. `npm install`

2. `node index.js`

## API

API isn't documented yet since this is private use at the moment. In general though:

* `/api/gateway` is a websocket you can connect to. It sends events for different things.

* `/api/blacklist` lists blacklisted channels

* `/api/blacklist/:name` gets the reason of a channel blacklist

* `/api/channel` gets the current channel.

every other endpoint requires authorization. See code for details.

## Attribution

This project uses some assets that require attribution. Please find them in `ATTRIBUTION` files.

- `public/sound/ATTRIBUTION` list of sound attributions