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 つの Twitch アカウント、1 つのモデレーター アカウントと 1 つの通常アカウントが必要です。使用するチャンネルは同じである必要があります。これは、MOD アカウントでタイムアウト/禁止メソッドをテストできるようにするためです。これら 2 つのアカウントを使用して、次の環境変数を設定します。
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
