twitch bot
1.0.0
Crie facilmente bots de bate-papo para Twitch.tv
Instalar via 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 - ()Este evento é emitido quando o bot se conecta ao servidor IRC.
Bot . on ( 'connected' , ( ) => ... )join - ()Este evento é emitido quando um canal é ingressado com sucesso.
Bot . on ( 'join' , channel => ... )part - ()Este evento é emitido quando um canal é abandonado com sucesso.
Bot . on ( 'part' , channel => ... )message - (chatter: Object) Emitido quando um evento PRIVSMSG é enviado por IRC. Os atributos do objeto Chatter podem ser encontrados no site de desenvolvedores do 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) Emitido quando um usuário atinge o tempo limite no chat. O atributo ban_reason é null quando nenhuma mensagem de motivo é usada.
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)Emitido quando um usuário se inscreve em um canal e opta por compartilhar a assinatura no chat.
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) Emitido quando um usuário é banido permanentemente do chat. O atributo ban_reason é null quando nenhuma mensagem de motivo é usada.
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)Emitido quando ocorre algum erro no canal Twitch IRC ou ao tentar se conectar a um canal.
Login authentication failedEste erro ocorre quando seu nome de usuário do Twitch ou oauth estão incorretos/inválidos.
Resposta:
{ message: 'Login authentication failed' }
Improperly formatted auth Este erro ocorre quando sua senha oauth não está formatada corretamente. O formato válido deve ser "oauth:your-oauth-password-123" .
Resposta:
{ message: 'Improperly formatted auth' }
Your message was not sent because you are sending messages too quicklyEste erro ocorre quando uma mensagem não é enviada devido ao envio de mensagens muito rápido. Você pode evitar isso tornando o bot um moderador do canal, se aplicável/permitido.
Resposta:
{ 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 - () Este evento é emitido quando a conexão irc é destruída através do método Bot.close() .
Bot . on ( 'close' , ( ) => {
console . log ( 'closed bot irc connection' )
} ) join(channel: String)Tenta entrar em um canal. Se for bem-sucedido, emite o evento 'join'.
Bot . on ( 'join' , channel => {
console . log ( `Bot joined ${ channel } ` )
} )
Bot . join ( 'channel2' )part(channel: String)Tentativas de sair de um canal. Se for bem-sucedido, emite o evento 'part'.
Bot . on ( 'part' , channel => {
console . log ( `Bot left ${ channel } ` )
} )
Bot . part ( 'channel2' )say(message: String, channel: []Channel, err: Callback) Envie uma mensagem no canal Twitch atualmente conectado. parâmetro channels não é necessário quando conectado a um único canal. Um retorno de chamada opcional é fornecido para validar se a mensagem foi enviada corretamente.
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) Tempo limite de um usuário no chat. parâmetro channels não é necessário quando conectado a um único canal. duration padrão é 600 segundos. Mensagem reason opcional.
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) Banir permanentemente um usuário do chat. parâmetro channels não é necessário quando conectado a um único canal. Mensagem reason opcional.
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()Fecha a conexão irc do Twitch. O bot será removido do canal Twitch E do servidor IRC.
Bot . close ( ) A execução do conjunto de testes requer pelo menos duas contas Twitch, uma conta de moderador e uma conta normal. O canal usado deve ser o mesmo - Isto é para que os métodos de tempo limite/banimento possam ser testados com a conta mod. Usando essas duas contas, defina as seguintes variáveis de ambiente:
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_channelPara executar os testes (alimentados com Mocha), use o seguinte comando:
yarn test
