twitch bot
1.0.0
Crea fácilmente chatbots para Twitch.tv
Instalar a través de 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 se emite cuando el bot se ha conectado al servidor IRC.
Bot . on ( 'connected' , ( ) => ... )join - ()Este evento se emite cuando un canal se une exitosamente.
Bot . on ( 'join' , channel => ... )part - ()Este evento se emite cuando un canal se abandona exitosamente.
Bot . on ( 'part' , channel => ... )message - (chatter: Object) Emitido cuando se envía un evento PRIVSMSG a través de IRC. Los atributos de los objetos de Chatter se pueden encontrar en el sitio para desarrolladores de 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) Se emite cuando se agota el tiempo de espera de un usuario en el chat. El atributo ban_reason es null cuando no se utiliza ningún mensaje de motivo.
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)Se emite cuando un usuario se suscribe a un canal y elige compartir la suscripción en el 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) Se emite cuando un usuario es excluido permanentemente del chat. El atributo ban_reason es null cuando no se utiliza ningún mensaje de motivo.
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)Se emite cuando se produce algún error en el canal IRC de Twitch o al intentar conectarse a un canal.
Login authentication failedEste error ocurre cuando su nombre de usuario de Twitch o su oauth son incorrectos o no son válidos.
Respuesta:
{ message: 'Login authentication failed' }
Improperly formatted auth Este error ocurre cuando su contraseña de oauth no tiene el formato correcto. El formato válido debe ser "oauth:your-oauth-password-123" .
Respuesta:
{ message: 'Improperly formatted auth' }
Your message was not sent because you are sending messages too quicklyEste error ocurre cuando un mensaje no se envía debido a que se envía demasiado rápido. Puedes evitar esto haciendo que el bot sea moderador en el canal, si corresponde/está permitido.
Respuesta:
{ 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 se emite cuando la conexión irc se destruye mediante el método Bot.close() .
Bot . on ( 'close' , ( ) => {
console . log ( 'closed bot irc connection' )
} ) join(channel: String)Intenta unirse a un canal. Si tiene éxito, emite el evento 'unirse'.
Bot . on ( 'join' , channel => {
console . log ( `Bot joined ${ channel } ` )
} )
Bot . join ( 'channel2' )part(channel: String)Intenta salir de un canal. Si tiene éxito, emite el evento 'parte'.
Bot . on ( 'part' , channel => {
console . log ( `Bot left ${ channel } ` )
} )
Bot . part ( 'channel2' )say(message: String, channel: []Channel, err: Callback) Envía un mensaje en el canal de Twitch actualmente conectado. El parámetro channels no es necesario cuando se conecta a un solo canal. Se proporciona una devolución de llamada opcional para validar si el mensaje se envió correctamente.
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) Tiempo de espera para un usuario del chat. El parámetro channels no es necesario cuando se conecta a un solo canal. duration predeterminada es 600 segundos. Mensaje 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) Prohibir permanentemente a un usuario del chat. El parámetro channels no es necesario cuando se conecta a un solo canal. Mensaje 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()Cierra la conexión irc de Twitch. El bot será eliminado del canal Twitch Y del servidor irc.
Bot . close ( ) Para ejecutar el conjunto de pruebas se requieren al menos dos cuentas de Twitch, una cuenta de moderador y una cuenta normal. El canal utilizado debe ser el mismo. Esto es para que los métodos de tiempo de espera/prohibición se puedan probar con la cuenta mod. Usando estas dos cuentas, configure las siguientes variables de entorno:
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 ejecutar las pruebas (con tecnología Mocha), use el siguiente comando:
yarn test
