Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 2 KB

README.md

File metadata and controls

49 lines (35 loc) · 2 KB
Raw

Alveus Sanctuary Chat Bot

This is the Twitch Chat bot for Alveus Sanctuary, allowing stream viewers to control the tech running the Livecams. You can access the stream at twitch.tv/alveussanctuary.

See also

Tech stack

This project uses Docker to run a Node.js app.

For development:

  • Node.js
  • Prettier (code formatting)
  • ESLint (code linting)
  • Docker (Compose)

External APIs

  • Twurple Twitch API Library
  • Courier Notification Platform

How to contribute

Hey there! Welcome to Alveus.gg! There's a few ways that you can help contribute.

  1. If you find a bug - you can fill out a bug report
  2. If you have an idea that would make Alveus better - please fill out an idea issue
  3. If you have development experience, take a look at our issues labeled good first issue, read our contributing guide and agree to our code of conduct before you get started.

Development setup

Local development

  1. Install Node.js (see engines in package.json for the required versions).
  2. Copy .env.example to .env and open your copy in a text editor and fill it:
    1. Twitch Client Id, Secret, and Token Path.
    2. OBS Websocket Address and Key.
    3. Axis Camera Username, Password, and IP Addresses.
    4. Courier Key.
    5. OBSBot Address and Port.
    6. Unifi Address, Username, Password, and a map of Mac addresses to Names.
  3. Add Twitch API tokens to tokens folder.
  4. Configure the settings src/config/config.js.
  5. Run docker compose up -d.