NicksBot

Short Description:

Custom bot for nick12272

Full Description

Custom bot for Nick12272's room. Current modules included are: spamKill,Notices,tipGoal,userInfo,mobileRoomInfo,mobilePm,thankYou,nickAge,spamPorn,Help

spamKill - user-friendly module for blocking spambots
The goal of spamKill is to block spam while still being friendly to legitimate users.
It does not use word filters that cause unnecessary blocks, and does not require users to solve
capcha problems or retype messages that were intercepted. While this bot will not prevent all spam
spam, it will block the most common spam messages generated by chatroom bots. It works as follows:
When a grey user types a message in chat for the first time, they are greeted with the following message:
> Please enter the number "NN" to send your message. You only need to do this once, thanks for helping battle spam!
If the user enters the requested number, their message is sent, and they will the be able to chat freely without
future prompts. If the requested number is not entered (and most bots will not), the message will not be sent and
the user will continue to be prompted each time they enter an new message
Commands
  > /spamkill  Display spamKill status (enabled or disabled)
  > /spamkill on  Enable spamKill (spamKill is enabled by default at startup)
  > /spamkill off  Disable spamKill

Notices - create and manage recurring room notices
Allows recurring room notices to be setup and managed. Notices can be setup when the bot starts or via commands.
For each notice you must specify the name, a message (i.e. the notice text that will be displayed), and the
time interval (in seconds) at which it will repeat (use time interval "0" to display message manually only
After a notice is setup, it can be turned off, or displayed one time manually using the "/n" command
Commands
  > /n  List all of the Notices that have been setup
  > /n add [name] [timer] [msg]  Create a new notice named [name], with message [msg], that will be displayed every [timer] seconds
  > /n [name]  Manually display notice [name] immediately (this will not effect the regularly scheduled display of the notice)
  > /n off  Turn off the recurring notice named [name] -- it can still be displayed manually

tipGoal - set and manage Tip Goals
Establishes a tip goal, tracks how much has been collected against the goal and displays it
as a room notice, and notifies you when the goal is met. Commands allow you to check the goal status,
stop/restart the goal, replace the goal, and change the goal target or amount collected.
Commands
  > /g  Show the goal, amount collected, and notice timer (displayed to the user typing the command only)
  > /g [amt] [timer] [desc]  Set the goal to [amt] with description [desc], with notice displayed timer [timer] minutes
  > /g [amt]  Change the goal target amount to [amt], keeping the same description, timer, and amount collected
  > /g stop  Disable the tip goal.
  > /g restart  Restart the the tip goal, using previously set amount, description, and timer, Amount collected gets reset to 0
  > /g sofar [amt]  Change the amount collected against the goal to [amt]
  > /g show  Display the goal and its status as a room notice now

userInfo - Displays user info to performer when a user chats
Whenever a user types a chat message, a notice is displayed to the performer
showing the user's name, color, and gender

mobileRoomInfo - displays user and follower count notices to the broadcaster
This module is meant to supplement the mobile broadcastng app.
It displays the room user count and optionally the follower count to the broadcaster in a repeating notice.
For the follower count to be shown, it needs to be initialized by broacsater or a mod after the bot is started
Once the follower count is initialized, it will be automatically updated when users follow/unfollow
Commands
  > /ri  Display room info to the user who issued the command
  > /ri timer [timer]  Change how often the room info notice is displayed to [timer] minutes
  > /ri f [fcount]  This command must be run by the broadcaster/mod to initialize the follower count to [fcount] before it will be displayed

mobilePm - allows mods to PM the broadcaster
This module is meant to supplement the mobile broadcastng app by allowing mods to PM the broadcaster
The PMs show up as notices that are displayed only to the brioadcaster
Commands
  > /pm [message]  The [message] text is displayed as a private notice seen only by the broadcaster

thankYou - displays thank you notices for tips and follows
Displays a notice to the room thanking a user who tips, or a user that follows

nickAge - displays Nick12272's age
Displays a repeating notice with Nick12272's age (timing is specified when bot is started)

spamPorn - repeatedly displays porn gif to the broadcaster
Repeatedly displays randomly selected porn gifs (from a list of CB emoticons provided) to the broadcaster
Commands
  > /sp set [emote1,emote2...]  Set the list of CB emaoticons the gif will be randomly chosen from
  > /sp  Start displaying the gifs
  > /sp stop  Stop displaying the gifs

Help - get help on Bot functions and commands
Get help by typing /help, /h, or /?
Commands
  > /h  Get help on the Bot, and a list of all functions in the bot
  > /h [function]  Get help on one of the functions in the bot, including it's commands
  > /h *  Display an auto-genertaed html description of the bot, that can be cut and paste into the Bot's description screen