Skip to content

4: Front End

tarrynt whitty edited this page Jan 25, 2024 · 3 revisions

using the front end

at this point the application should be loaded. each module has its own box

image

stats recording

During a stream the bot will record information about your stream. these stats can be handy to use while your channel grows. knowing what streams where better then others so you can focus on what works or test new formats.

image

At the top it will state "no stream" for title and game, this means it is not recording. this happens ether if you have not gone live yet, or if you are live it is because you opened the bot after you went live

if you opened the bot after you went live but want to start recording stats now just click "Start Stream stats recording" this will send a fake "go live" command to the bot.

if you opened the bot before going life. just simply go live and it will start recording.

it will record the name of the stream and update the name if you change it. it will record time of name changes to the database

it will do the same with game changes

it will also record number of followers gained during that stream and record in the database when that follower was gained and who the follower is

it will do the same for subs, gifted subs, bits donated, shoutouts received and raids received.

when ever someone sends a chat message in the stream it will add 1 to the "messages sent count" and if that user has not spoken before this stream it will add 1 to the "chatters" stat, letting you know number of chatters and messages.

it will also record to the database when the message was. who sent it and contents. just in case you need this information.

the stat recording will stop when you end stream or if you click "end stream stats recording"

chat box

image

this chat box will display the last 250 messages send in your chat, this updates every second. in the future i will add the option to swap this out for having a embed of twitch chat if this is something your prefer

if you type a message into "message" and click send it will send a message in chat as your account. in the future i will add a feature to use a bot account rather then your own account.

command settings

image

this is broken in 2 (or 3) areas

at the top is a refresh button. if for any reason the data is not current (say a super admin updated a command in chat rather then the front end) click refresh to get the updated data. this should be automated in the future

add a command will allow you to add a basic command. right now there is no "variables" you can prefill here but you can make a basic command and basic response system.

command name will be the name for the command, if i enter "hello" as the command name the command in chat will be !hello

response is the response the bot will give when the command is run, if i enter "world" and someone in chat does !hello the bot will reply "world"

once you have entered you command click "add" to add it to the bot

Last we have the "command list"

the top command is the "where" command. this is for mabinogi players. if you host public content you can update this with a channel a user can run the !where command to find out where they need to go to join. the numbered box is channel. the 2nd box is what location. update these boxes and click update to update the contents if you change location.

under the where command will be a list of all the commands you have created

minigames

minigames is a module built to give your chat something extra to do for extra interactions. the questions and answers can be configured to your liking, see wikipage for it

image

to start a trivia game select start trivia, to start a wordle game select start wordle

when a minigame is running users in chat will need to run !signup to join minigames, each user only needs to do this once ever as it gets recorded into the database

image

if your running trivia it will show the question, the multichoice answers and the correct answer in the UI. it will also send the questions and multichoice answers to chat for your viewers

image

if you run wordle it will show the word they need to guess at the top. it will show under this the number of guesses they have done, the wrong letters they have entered, same for misplaced and correct. lastly it will show all guessed words. they can use !guess [word] to guess.

each time a user wins they will get a number of points related to what was entered in the config. this gets recorded in the database, right now the points do nothing but in the future a system for spending points can be added.

action log

image

this is a simple module that will record events happening on the bot and print them into the module's box this is a stand in for looking at the terminal or opening output.log

raids to shoutout

this module is a system to help with shouting out of raiders

when you have no raids it will look like this

image

if you have raids it will look like this

brave_jpbSFkl9KG

The boxes will show a profile image of the raider, their name and number of viewers they bought with them

you can click "soft shoutout" to send out a /shoutout command to chat, this will shout out the channel and give users a link to view their channel

you can click "loud shoutout" if you have a bot that uses the !so command it will attempt to use it. it will send a !so [channel name] command for you, if this plays clips for you, it will play a clip.

when you select ether option it will remove them from the list.

give away machine

this can be used to give away things or to pick someone from a list

image

to use it, enter the command you want your veiwers to enter to join inside of the give away command box. if i enter "test" the command will become !test

then select "start" the give away will start and veiwers will need to enter that command to be added to the pool of people. If they user is subbed they will be entered into the pool twice.

if you need to pause entrys click the pause button. this will toggle between running and paused.

if you need to pull a user from the list select "pull". it will pull someone at random and show their name, if they are subbed and if they follow. you can then click "announce" to inform them they won or click "remove" to remove them from the list

brave_9O6JHFaHw6

click "stop" to end the give away and reset for next give away

next up

learn other functions of the bot https://github.com/riskdoe/Project-Tada/wiki/5:-ChatBot-functions

learn how to edit minigames https://github.com/riskdoe/Project-Tada/wiki/6:-Minigame-settings