diff --git a/README.md b/README.md index 2397aec..9712c5f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@

Twitch Subathon Countdown Template

-

This is the template I created for my Twitch Subathon Countdowns

+

This is a Twitch Subathon Countdown originally by JayexDesigns.

+

The CSS Code is updated by Johnnycyan. The JS Files are updated by leabdd to add functionalities.


Description

@@ -8,6 +9,11 @@

When you open the index.html you get to chose between "Reset" or "Start".


+

Shortcuts

+

To pause the Timer: CTRL+ALT+P

+

To enable/disable Happy Hour: CTRL+ALT+H

+
+

Preview


@@ -15,6 +21,9 @@

Usage

After cloning this repository you'll have to edit the "config.js" file with any plain text editor, then change the value of the variables according to what you want:

+

Twitch

+

To get your Subs and Bits you just have to add your Channel Name.

+

Streamlabs Token

To get the token you'll have to go to the API settings tab of your Streamlabs dashboard then click on API Tokens, copy your socket API token and finally paste the code on the "streamlabs_token" variable in the "config.js" file.

@@ -30,8 +39,19 @@

Initial Time

You can set the initial time of the timer by setting the hours, minutes and seconds to be added when the timer is created.

+

Happy Hour

+

If this is true, you can turn enable Happy Hour with the Shortcut. If it is false, the feature is disabled and cant be enabled.

+

You have to set the Happy Hour time values manually.

+ +

Bulk

+

This enables that multiple Subs get added to the timer at once.

+

For Example when a user gifts 10 Subs.

+

Other Values

Change the other values to set the amount of seconds that will be added for the subscriptions, donations... And the minimum donation amounts to trigger the countdown increase.

Add To OBS

To add it to OBS you just have to drag the "index.html" file to the sources section or add a browser source that points to the "index.html" file.

+ +

Known Problems

+Only Streamelements Token in config.js does not add time for Subscriptions. Emulate with the Overlay Editor does work.