twitch bot
1.0.0
轻松为 Twitch.tv 创建聊天机器人
通过 NPM 安装
$ npm install twitch-bot
const TwitchBot = require ( 'twitch-bot' )
const Bot = new TwitchBot ( {
username : 'Kappa_Bot' ,
oauth : 'oauth:dwiaj91j1KKona9j9d1420' ,
channels : [ 'twitch' ]
} )
Bot . on ( 'join' , channel => {
console . log ( `Joined channel: ${ channel } ` )
} )
Bot . on ( 'error' , err => {
console . log ( err )
} )
Bot . on ( 'message' , chatter => {
if ( chatter . message === '!test' ) {
Bot . say ( 'Command executed! PogChamp' )
}
} ) connectedjoinpartmessagetimeoutsubscriptionbanerrorclosejoin() ）part()say()timeout()ban()close()connected - ()当机器人连接到 IRC 服务器时，会发出此事件。
Bot . on ( 'connected' , ( ) => ... )join - ()当频道成功加入时会发出此事件。
Bot . on ( 'join' , channel => ... )part - ()当成功离开频道时会发出此事件。
Bot . on ( 'part' , channel => ... )message - (chatter: Object)当通过 IRC 发送PRIVSMSG事件时发出。 Chatter 对象属性可以在 Twitch 开发者网站上找到
Bot . on ( 'message' , chatter => ... ) { color : '#3C78FD' ,
display_name : 'kritzware' ,
emotes : '88:18-25' ,
id : 'c5ee7248-3cea-43f5-ae44-2916d9a1325a' ,
mod : true ,
room_id : 44667418 ,
sent_ts : 1501541672959 ,
subscriber : true ,
tmi_sent_ts : 1501541673368 ,
turbo : false ,
user_id : 44667418 ,
user_type : 'mod' ,
badges : { broadcaster : 1 , subscriber : 0 } ,
channel : '#kritzware' ,
message : 'This is a message PogChamp' ,
username : 'Kritzware' }timeout - (event: Object)当用户在聊天中超时时发出。当没有使用原因消息时， ban_reason属性为null 。
kritzware: "/timeout {user} {duration} {reason}" Bot . on ( 'timeout' , event => ... ) { ban_duration : 10 , // seconds
ban_reason : 'Using a banned word' ,
room_id : 44667418 ,
target_user_id : 37798112 ,
tmi_sent_ts : 1503346029068 ,
type : 'timeout' ,
channel : '#kritzware' ,
target_username : 'blarev' }subscription - (event: Object)当用户订阅频道并选择在聊天中共享订阅时发出。
Bot . on ( 'subscription' , event => ... ) {
"badges" : {
"broadcaster" : 1 ,
"staff" : 1 ,
"turbo" : 1
} ,
"channel" : "#dallas" ,
"color" : "#008000" ,
"display_name" : "ronni" ,
"emotes" : null ,
"id" : "db25007f-7a18-43eb-9379-80131e44d633" ,
"login" : "ronni" ,
"message" : "Great stream -- keep it up!" , // null if no message given
"mod" : 0 ,
"msg_id" : "resub" ,
"msg_param_months" : 6 ,
"msg_param_sub_plan" : "Prime" ,
"msg_param_sub_plan_name" : "Prime" ,
"room_id" : 1337 ,
"subscriber" : 1 ,
"system_msg" : "ronni has subscribed for 6 months!" ,
"tmi_sent_ts" : 1507246572675 ,
"turbo" : 1 ,
"user_id" : 1337 ,
"user_type" : "staff"
}ban - (event: Object)当用户被永久禁止聊天时发出。当没有使用原因消息时， ban_reason属性为null 。
Bot . on ( 'ban' , event => ... ) kritzware: "/ban {user} {reason}" { ban_reason : 'Using a banned word' ,
room_id : 44667418 ,
target_user_id : 37798112 ,
tmi_sent_ts : 1503346078025 ,
type : 'ban' ,
channel : '#kritzware' ,
target_username : 'blarev' }error - (err: Object)当 Twitch IRC 频道中发生任何错误或尝试连接到频道时发出。
Login authentication failed当您的 twitch 用户名或 oauth 不正确/无效时，就会出现此错误。
回复：
{ message: 'Login authentication failed' }
Improperly formatted auth当您的 oauth 密码格式不正确时，会出现此错误。有效格式应为"oauth:your-oauth-password-123" 。
回复：
{ message: 'Improperly formatted auth' }
Your message was not sent because you are sending messages too quickly当由于发送消息太快而导致消息发送失败时，就会出现此错误。如果适用/允许，您可以通过让机器人成为频道中的主持人来避免这种情况。
回复：
{ message : 'Your message was not sent because you are sending messages too quickly' } Bot . on ( 'error' , err => ... ) { message : 'Some error happened in the IRC channel' }close - ()当通过Bot.close()方法销毁 irc 连接时会发出此事件。
Bot . on ( 'close' , ( ) => {
console . log ( 'closed bot irc connection' )
} ) join(channel: String)尝试加入频道。如果成功，则发出“加入”事件。
Bot . on ( 'join' , channel => {
console . log ( `Bot joined ${ channel } ` )
} )
Bot . join ( 'channel2' )part(channel: String)尝试离开频道。如果成功，则发出 'part' 事件。
Bot . on ( 'part' , channel => {
console . log ( `Bot left ${ channel } ` )
} )
Bot . part ( 'channel2' )say(message: String, channel: []Channel, err: Callback)在当前连接的 Twitch 频道中发送消息。连接到单个通道时不需要channels参数。提供可选的回调来验证消息是否正确发送。
Bot . say ( 'This is a message' )
Bot . say ( 'Pretend this message is over 500 characters' , err => {
sent : false ,
message : 'Exceeded PRIVMSG character limit (500)'
ts : '2017-08-13T16:38:54.989Z'
} )
// If connected to multiple channels
Bot . say ( 'message to #channel1' , 'channel1' )
Bot . say ( 'message to #channel2' , 'channel2' )timeout(username: String, channel: []Channel, duration: int, reason: String)使用户的聊天超时。连接到单个通道时不需要channels参数。默认持续duration为 600 秒。可选reason消息。
Bot . timeout ( 'kritzware' , 10 )
// "kritzware was timed out for 10 seconds"
Bot . timeout ( 'kritzware' , 5 , 'Using a banned word' )
// "kritzware was timed out for 5 seconds, reason: 'Using a banned word'"
Bot . on ( 'message' , chatter => {
if ( chatter . message === 'xD' ) Bot . timeout ( chatter . username , 10 )
} )ban(username: String, reason: String)永久禁止用户聊天。连接到单个通道时不需要channels参数。可选reason消息。
Bot . ban ( 'kritzware' )
// "kritzware is now banned from the room"
Bot . timeout ( 'kritzware' , 'Using a banned word' )
// "kritzware is now banned from the room, reason: 'Using a banned word'"
Bot . on ( 'message' , chatter => {
if ( chatter . message === 'Ban me!' ) Bot . ban ( chatter . username )
} )close()关闭 Twitch irc 连接。机器人将从 Twitch 频道和 irc 服务器中删除。
Bot . close ( ) 运行测试套件需要至少两个 twitch 帐户、一个主持人帐户和一个普通帐户。使用的频道必须相同 - 这样可以使用 mod 帐户测试超时/禁止方法。使用这两个帐户，设置以下环境变量：
TWITCHBOT_USERNAME = mod_username
TWITCHBOT_OAUTH = oauth : mod - oauth - token
TWITCHBOT_CHANNEL = mod_channel
TWITCHBOT_USERNAME_NON_MOD = non_mod_username
TWITCHBOT_OAUTH_NON_MOD = oauth : non - mod - oauth - token
TWITCHBOT_CHANNEL_NON_MOD = mod_channel要运行测试（由 Mocha 提供支持），请使用以下命令：
yarn test
