Skip to content
This repository has been archived by the owner on Jul 12, 2019. It is now read-only.

Latest commit

 

History

History
73 lines (47 loc) · 4.17 KB

README.md

File metadata and controls

73 lines (47 loc) · 4.17 KB
Raw

LiveSplit.SplitsBet Build Status Stories in Ready

More fun for your viewers!

Made by @GyooRunsStuff

Many thanks to @CryZe107 and @0x0ade!

Summary

SplitsBet is a plugin that adds a small bot to your chat (under your name). The goal of this bot is to allow viewers to guess what the time of your segments will be. The closer they are to reality, the more points!

How does it work?

Commands

  • !start (Broadcaster only) Starts the bot. Viewers can bet whenever a message inviting them to do so appears. Moderators can be allowed to use it if the option is set in the settings.
  • !stop (Broadcaster only) Stops the bot. Viewers can't bet anymore. Moderators can be allowed to use it if the option is set in the settings.
  • !bet (hh:m)m:ss Guess the time for the current split. Hours and first digit of minutes are optional (Example: 4:20 is a valid time).
  • !unbet Cancels your bet for the current split. Watch out, there's a points penalty!
  • Special bets: They are used for mini events in the middle of a run, for instance the Secret Slide in Mario 64 or Dampe's time attack in OoT. 3 subcommands are available :
    • !specialbet start (Broadcaster/Mods only) Starts a special bet. It can be done anytime as long as the run is already started
    • !specialbet (hh:m)m:ss Guess the time for the special bet. You can't cancel a special bet
    • !specialbet stop (hh:m)m:ss (Broadcaster/Mods only) Ends the special bet. Can be done anytime as long as the run is still going. Yhen you type this, you must input manually the time that has been done (i.e you do Dampe in 47 seconds, then you must type !specialbet stop 47
  • !checkbet Verify your bet
  • !betcommands Shows the available commands
  • !score Shows your score during a run
  • !highscore Shows the current highest score
  • !version Shows the current version of SplitsBet in use

Score system

The current score system works so:

  • The closer you are to the time of the segment, the more points
  • The amount of points you get is multiplicated by a coefficient (from 0 to 1) that decreases as the time goes on: Obviously, it'll be easier to guess a split if you bet near the end of it, thus you will have less points than someone who guessed it right at the very beginning of it.

These 2 parameters are managed with gaussians, which is, to me, the fairest way to calculate the score: it won't decrease too much if you're close enough, but will decrease kinda fast when you start being too far. However, the scoring system is most likely to be changed sooner or later

Long term

When the plugin is stable enough, I want to go to the next level by offering a web platform where all the scores will be centralized, for every stream that uses SplitsBet. This site will show stats and ranks for each broadcaster and player, and possibly more!

Download

Check the releases page to get the latest version or take the risk and download a development build!

Install plugin

Once you downloaded the plugin, unzip it in "path/to/LiveSplit"/Components

Then, add it to your layout:

Edit Layout ➞ "+" ➞ Control ➞ Splits Bet Bot

A window will show, asking for your Twitch credentials (WARNING: If you already linked your Twitch credentials to Livesplit, this window will not appear. The bot is ready to use), fill it and it's good to go! Don't forget to type !start in the chat otherwise the bets will be disabled. 😃

Changelog

See complete changelog here

v0.6

Fixes

  • Fixed several issues coming from a confusion between variables (Affected : Unbet, Highscore, several commands after unsplitting)

Features

  • Due to better stability after bugfixing, SubSplits integration is back. Splits Selector... not yet