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
