Git Product home page Git Product logo

beat-saber-twitch-integration's Introduction

Beat Saber Twitch Integration Plugin

For all you streamers out there who want song requests in your chat!

Installation

  1. Download the latest release and extract to the root of your Beat Saber installation directory.
  2. Edit the config (located in Plugins/Config/TwitchIntegration.xml)
    Add your Twitch username, an OAuth token that you can get here: https://twitchapps.com/tmi (this does require the oauth: prefix)
    Lastly, add the channel to monitor. (This doesn't have to be the same as your twitch login, ie if you're using a bot to do requests)

Usage

Mod Commands

Command Description
!next Jumps the queue ahead to the next song.
!clearall Clears the queue.
!remove Allows you to remove a song from the queue. Used like !remove <BeatsaverID>
!block Allows you to ban a song from ever getting requested again. Used like !block <BeatsaverID>

Basic Commands

Command Description
!bsr Allows you to request a song, can be used with song name or Beatsaver ID.
!add Another version of !bsr but without the song name option.
!queue Shows all songs in queue.
!blist Shows all banned songs.
!qhelp Shows the commands.

Config Options

Option Description
Username The username the bot will post under, this needs to match the name of the account you generated your oauth token under.
Oauth The Oauth token for the bot to login to twitch with. Gained from here.
Channel The twitch channel the bot should listen to, in most cases this will be the same as Username.
Moderator Only Sets whether or not to make requests mod only. Can only be true or false.
Subscriber Only Same as above but for subs too.
ViewerRequestLimit The maximum amount of songs a view can have in queue at any given time.
SubscriberLimitOverride A higher limit than the above for subs to have in the queue at any given time.

beat-saber-twitch-integration's People

Contributors

derpierre65 avatar luludotdev avatar soliel avatar

Watchers

 avatar

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.