AnkhBot by AnkhHeart Documentation

AnkhBot by AnkhHeart Documentation

Overview

 Console: The place where the bot will throw in chat logs

 Dashboard: Allows you to change your stream title & game. If you’re a partner you can

also run commercials. In order to use this you have to connect your twitch account which can be done under Credentials -> Streamer Login

 Regular Commands: Where normal commands can be added

 Timed Commands: Where your timed/looping messages can be added  Quotes: Where your quotes can be added

 Give Away: Raffle window that allows you to do giveaways  Settings: Allows you to tweak some settings

 Credentials: Where you can input information to connect to Twitch and/or Google  Sync To Google: Let’s you sync all your data to a Google Spreadsheet

 Extra Features: This is where extra features that aren’t part of the core will appear  Help: This is where you can find Documentation about the bot and an About section

Setup (Twitch)

 Make a new Twitch.tv account specifically for the bot

 Go to Credentials -> Bot Login

 Username: Enter the bot’s twitch username ex: ankhybot  Oauth-Token: This is where the generated token will appear

 Channel: Type in the channel you want to the bot to connect to ex: edemonster  Port: Set the port you wish to connect to

 Click Generate Oauth-Token in order to go through the token generating process, which will happen in the browser window that’ll appear out of nowhere. In here you must log into twitch using the Bot’s Twitch.tv Account.

 Click Connect to connect the bot to the Channel

Streamer Login

 Go to Credentials -> Streamer Login

 Username: Enter your own twitch user name

 Oauth-Token: This iw here the generated token will appear

 Generate Oauth-Token: Shows a browser on the side so you can log in to twitch and have it generate one for you

Setup (Google Docs)

 Make a Gmail account if you do not have one yet: http://www.gmail.com

 Make sure you’re logged into it then go to:

https://docs.google.com/spreadsheets/d/1VyOz0GqCWBCdRaEHXWcjPtFn4KH5su6EK57 66ZDFFuk

 Go to File -> Make a Copy

 Name the copy BotData(BotNameHereInLowerCase) ex: BotDatacasca_bot

 Within the bot go to Credentials -> Google Login

 Email: Enter your Gmail email-adress  Password: Type in your email’s password  Click Connect

 If you don’t get a popup saying that the login failed everything is ok

 If you are sure your password is correct go to https://www.google.com/settings/security and make sure two step authentication is disabled & Access for less secure apps is

Dashboard

 Basic: Allows you to Refresh your Stream Title & Game and Update them from the bot

itself. For this you have to connect your twitch account under Credentials -> Streamer Login.

 Manual Commercial: Allows you to start a commercial with just a click of a button  Automatic Commercial: Allows you to setup an automated timer that runs a commercial

for you after X amount of time. This resets itself so you can set it up to go off on an hourly basis and it’ll do its job after every hour. If you wish you can warn the viewers in chat or just have a Sound play a few seconds before the commercial is about to roll.

 Automated Hosting: Allows the bot to host channels for you by queuing them up. In

order for this feature to work the bot must be made an editor in your channel. This can be done by going to http://www.twitch.tv/(YourName)/dashboard/permissions

Regular Commands







!follow promouse)





Timed Commands







whenever the interval(can be found under settings) hits



Quotes

 ID: Numeric value representing a pre-existing quote, Leave this empty if you’re adding one manually

Give Away

 Raffle Keyword: Set the keyword that people have to type in order to join

 Moderator/Subscriber/Normal Viewers: Checking any of these sets who can enter your give away

 Must Be Follower: If checked it’ll only pick a follower as the winner. If someone that’s not following wins the bot will instantly look for someone else that is hopefully following. So the non-follower will never be notified of winning.

 Notify Winner in Chat: Will throw a message to the user in chat telling him that he won

 Entered Users: Shows a list of people that have entered

 Winner: Shows the winner & the messages the winner typed into chat after winning, so you can figure out if he wants the prize or not

SFX System

 Command: Set the command that you wish to use here ex: !scream

 Permission: Set the permission as to who can use the command

 Enabled: True/False allows you to Enable/Disable the command to be used within chat  Cooldown: The amount of minutes a command can’t be voted for after the SFX has

started playing

 Min Votes: Min amount of votes before the SFX gets executed/played

Currency System

Here you can see the Currency System in which you can customize various things like the

Command, Response. You can even create your own Custom Ranks. Aside from that you

can set the pay-out amount and possible bonuses depending on a user’s rank. Obviously you can also set the Interval at which it hands out payments.

Display Points: !points (Will change depending on the currency command you set in the

currency system)

Adding Points: !points add (name) (amount) Removing Points: !points remove (name) (amount)

Adding Points to Everyone in Chat: !points add +viewers (amount)

Removing Points from Everyone in Chat: !points remove +viewers (amount) Getting Top 5: !points top

Response Parameters:

 $user : Replaced by the person that uses the command  $points : Replaced by the amount of points the user has  $rank : Replaced with the current rank the user has

 $hours: Replaced by the amount of hours they’ve been in your channel  $level: Replaced by the user’s level

 $nxtlevelreq : Replaced by the amount of points needed to level up  $nxtrankreq : Replaced by the amount of points required for rank up

 $nxtrank : Replaced by the next possible rank that can be achieved, do mind if the user has a custom rank he can only achieve another custom rank not a normal one







Preprogrammed Commands (In Chat)

Permission Levels

 +a(on edit) or Blank(on add) : Everyone

!Commands (reg | param | timer)

 Description: This will show you a list of commands that you can use

 An example: !Commands reg

 Response: Regular Commands: !links, !cookies, !steam, !twitter

!Command add (command) (permlvl: optional) (response)

 Description: This will allow you to add a command to the bot through chat (Must be an editor or the caster)

 An example of adding: !Command Add !Cookies +r Give me all the cookies!

 Response: (user) -> !Cookies has been added! Permission: Regulars | Response: Give me

all the cookies!

!Command remove (command)

 Description: This will allow you to remove a command from the bot through chat (Must be an editor or the caster)

 An example of removing: !Command Remove !Cookies  Response: (user) -> !Cookies has been removed!

!Command Edit (command) (permlvl: optional) (response)

 Description: This will allow you to edit a command within the bot through chat (Must be an editor or the caster)

 An example of editing: !Command Edit !Cookies +c All cookies belong to me

 Response: (user) -> !Cookies has been edited! Permission: Caster | Response: All cookies

belong to me

!Timer Add (command) (permlvl: optional) (response)

 Description: This will allow you to add a timer to the bot through chat (Must be an editor or the caster

 An example of adding: !Timer Add !Cake +e Give me all the cake!

 Response: (user) -> !Cake has been added! Permission: Editors | Response: Give me all

!Timer Remove (command)

 Description: This will allow you to remove a timer from the bot through chat (Must be an editor or the caster)

 An example of removing: !Timer Remove !Cake  Response: (user) -> !Cake has been removed!

!Timer Edit (command) (permlvl: optional) (response)

 Description: This will allow you to edit a timer within the bot through chat (Must be an editor or the caster)

 An example of editing: !Timer Edit !Cake +s I don’t want that cake!

 Response: (user) -> !Cake has been edited! Permission: Subscribers | Response: I don’t

want that cake!

!Enable (timer/command)

 Description: This will allow you to enable/disable the use of a certain Command or Timer

 An example of enabling: !Enable !cake false

 Response: (user) -> !cake has been disabled and can no longer be used.

!Activate (timer)

 Description: This will Activate/De-Activate a timer, preventing it from automatically executing itself after the interval

 An example of activating: !Activate !cake false

 Response: (user) -> !cake has been de-activated and will no longer execute itself automatically.

!Quote

 Description: This will return a random quote

 An example: !Quote

 Response: Quote #33: “I felt so pretty when he touched me there! [03/07/2014][The Last

of Us]”

!Quote (num)

 Description: This will return the quote you select

 An example: !Quote 17

 Response: Quote #17: "I just got tongued by Rachel,... That just happened." [Resident

Evil: Revelations][7/7/2014]

!Quotes

 Description: This will return how many quotes exist and what the range is

!Quote Add (text)

 Description: This will allow you to add a quote to the bot

 An example of adding: !Quote Add “I didn’t mean to touch him there!”

 Response: (user) -> Quote #1 has been added: “I didn’t mean to touch him there!

[02/08/2014] [Bioshock 2]”

!Quote Remove (ID)

 Description: This will allow you to remove a quote from the bot

 An example of removing: !Quote Remove 10  Response: (user) -> Quote #10 has been removed!

!Quote Edit (ID) (text)

 Description: This will allow you to edit a quote

 An example of editing: !Quote Edit 7 “I felt like a real woman! [02/08/2014][Bioshock 2]”  Response: (user) -> Quote #7 has been edited: “I felt like a real woman! [02/08/2014]

[Bioshock 2]”

!Update

 Description: This will start the syncing process to your google document. If you have connected your google account to the bot and have a copy of the template

 An example of syncing: !update

 Response: (user) -> Started syncing information to the Google Spreadsheet.

!Permit (name)

 Description: This will let you permit a user to post a link within 30 seconds

 An example of syncing: !Permit promouse

 Response: Promouse -> You have been permitted to post a link within 30 seconds.

!Reg Add (name)

 Description: This will allow you to add a person to the list of Regulars

 An example of adding: !Reg Add KrystalRayne

 Response: (user) -> Successfully added KrystalRayne as a Regular.

!Reg Remove (name)

 Description: This will allow you to remove a user as Regular

 An example of removing: !Reg Remove Edemonser

 Response: (user) -> Successfully removed Edemonster, they are no longer a Regular.

String Replacement

There are parameters that automatically get replaced by the bot with certain things, which can range from the current game to the twitch url of the user or even his name:

 $mygame: Gets the current game you’re playing  $user: Gets the user that calls the command  $mystatus: Gets your status from twitch  $myurl: Gets your twitch url

 $botname: Grabs the bot’s name

 $target: Grabs the target of a command, Useful when working with Single Parameter

commands

 $randuser: Picks a random active chatter in your chat, but if there are none it’ll target the

caster

 $url: Grabs the $caster’s twitch url

 $game: Grabs the $caster’s current/last played game  $status: Grabs the $caster’s status from twitch.

 $time: Grabs your current time and displays it as Mon 10:30:42 AM

 $randquote: Grabs a random quote from your quote data base in case you want to use

it within a timer

 $randextraquote: Grabs a random response from the ExtraQuoteLike – System which is

Death Counter

Above here you can see the default layout of the death counter. You can fully customize the message that the !Death command outputs or even customize which command you want to use for the counter.

Once you Create/Use the command it’ll be linked to an executive command which will work for the purpose of counting your deaths in games like Dark Souls. In this one would

increment deaths by typing “!Death +” in chat. This would increase the amount of deaths. The same goes for decreasing deaths when typing “!Death -” or you can just set the deaths manually by typing !Death 10. This would set the amount of deaths to 10 and overwrite the current amount.

If someone would just call the ”!Death command it would output “Deaths: 10” in this case. So you never have to retype the message again, all you do is edit the amount of deaths.

Extra Quote-Like System

This system will pretty much work the same as quotes, except you can customize the command that you will be using. This is just a secondary system that you can use together with the quote one in case you want random Gifs, Puns, Links or anything that comes to mind.

It works the same as quotes so in chat you can type !Gif Add (text) and it’ll save it for you.

!Gif Remove (id) will remove it, !Gif Edit (id) (text) will edit it. That is only in this case since

the command that it’s using is !Gif. But if you’d change it to !link it would work just like !link

add (text).

Contact

If you’re having any problems with the bot or there happen are bugs please let me know. This can be done by either sending me a message on twitch.tv/ankhheart or tweeting me @AnkhHeart.