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) PRIVSMSG 이벤트가 IRC를 통해 전송될 때 발생합니다. 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)채널에 참여하려고 시도합니다. 성공하면 'join' 이벤트를 발생시킵니다.
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 ( ) 테스트 스위트를 실행하려면 최소 2개의 트위치 계정(모더레이터 계정 1개, 일반 계정 1개)이 필요합니다. 사용되는 채널은 동일해야 합니다. 이는 시간 초과/금지 방법을 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
