ComfyJS-Download – Download des ComfyJS-Quellcodes

Comfy.JS

Wir haben dieses bequeme Twitch-Chat-Modul live auf Twitch für Coding Cafe erstellt!

Besonderer Dank: Comfy.JS ist dank tmi.js möglich, das von @AlcaDesign verwaltet wird

Mit Comfy.JS können Sie den Twitch-Chat für Ihren Twitch-Kanal GANZ EINFACH in nur wenigen Codezeilen integrieren. Hier ist ein kurzes 3-minütiges Video zur Verwendung: (Klicken Sie auf das Bild, um das Video zu öffnen)

Instafluff

Gefallen Ihnen diese Projekte? Der beste Weg, meine Open-Source-Projekte zu unterstützen, besteht darin, Comfy-Sponsor auf GitHub zu werden!

https://github.com/sponsors/instafluff

Kommen Sie und hängen Sie mit uns im Comfiest Corner auf Twitch ab!

https://twitch.tv/instafluff

Anweisungen

Knoten

Installieren Sie comfy.js

 npm install comfy.js --save

Reagiere auf !Befehle deines Kanals

{ if( flags.broadcaster && command === "test" ) { console.log( "!test was typed in chat" ); } } ComfyJS.Init( "MyTwitchChannel" );">

 var ComfyJS = require ( "comfy.js" ) ;
ComfyJS . onCommand = ( user , command , message , flags , extra ) => {
  if ( flags . broadcaster && command === "test" ) {
    console . log ( "!test was typed in chat" ) ;
  }
}
ComfyJS . Init ( "MyTwitchChannel" ) ;

Browser

Laden Sie comfy.js aus dem dist -Ordner herunter und fügen Sie es hinzu oder fügen Sie es aus dem JSDelivr-CDN hinzu:

 < script src = "comfy.min.js" > < / script >

ODER

 < script src = "https://cdn.jsdelivr.net/npm/comfy.js@latest/dist/comfy.min.js" > < / script >

Reagiere auf !Befehle deines Kanals

 < html >
  < head >
    < script src =" https://cdn.jsdelivr.net/npm/comfy.js@latest/dist/comfy.min.js " >  script >
   head >
  < body >
    < script type =" text/javascript " >
      ComfyJS . onCommand = ( user , command , message , flags , extra ) => {
        if ( flags . broadcaster && command === "test" ) {
          console . log ( "!test was typed in chat" ) ;
        }
      }
      ComfyJS . Init ( "MyTwitchChannel" ) ;
     script >
   body >
 html >

Flaggen

Derzeit sind in onCommand() und onChat() folgende Flags möglich:

Sender
Mod
Gründer
Teilnehmer
vip
hervorgehoben
benutzerdefinierte Belohnung

Zusätzlicher Parameter

Derzeit enthält der extra Parameter für onCommand() die folgenden Felder:

id (die Nachricht Nachricht)
Kanal
Raum-ID
Nachrichtentyp
NachrichtEmotes
isEmoteOnly
Benutzer-ID
Benutzername
Anzeigename
userColor
BenutzerBadges
Flaggen
Zeitstempel
customRewardId (funktioniert nur mit benutzerdefinierten Kanalprämien mit erforderlichem Text)

Wenn es sich bei der Nachricht um einen Befehl handelt, enthält der extra Parameter ein zusätzliches Feld:

seitLastCommand

Enthält Informationen zu den Zeiträumen in ms seit der letzten Verwendung desselben Befehls durch einen Benutzer oder einen bestimmten Benutzer. Dieses Feld kann praktisch zum Festlegen globaler Cooldown- oder Spam-Filter verwendet werden. Siehe Beispiele unten:

 ComfyJS . onChat = ( user , message , flags , self , extra ) => {
  if ( flags . broadcaster && command === "test" ) {
    if ( extra . sinceLastCommand . any < 100 ) {
      console . log (
        `The last '!test' command by any user was sent less than 100 ms ago`
      ) ;            
    }

    if ( extra . sinceLastCommand . user < 100 ) {
      console . log (
        `The last '!test' command by this specific user (as denoted by the 'user' parameter) was sent less than 100 ms ago`
      ) ;            
    }
  }
}

Chat-Nachrichten lesen

Sie können Chatnachrichten lesen, indem Sie den onChat() -Handler verwenden

 ComfyJS . onChat = ( user , message , flags , self , extra ) => {
  console . log ( user , message ) ;
}

Chat-Nachrichten senden

Das Senden von Chat-Nachrichten kann über ComfyJS.Say( message ) erfolgen, erfordert jedoch ein OAUTH-Passwort, wenn eine Verbindung zum Chat hergestellt wird.

Fügen Sie Ihr Passwort sicher hinzu

Holen Sie sich ein Twitch Chat OAuth-Passwort-Token – http://twitchapps.com/tmi/
Installieren Sie dotenv

 npm install dotenv --save

Erstellen Sie eine Datei mit dem Namen .env , die so aussieht:

 TWITCHUSER = [ YOUR - USERNAME - HERE ]
OAUTH = [ YOUR - OAUTH - PASS HERE ] # e . g . OAUTH = oauth : kjh12bn1hsj78445234

Initialisieren Sie mit dem Benutzernamen und dem OAUTH-Passwort

{ if( command === "test" ) { ComfyJS.Say( "replying to !test" ); } } ComfyJS.Init( process.env.TWITCHUSER, process.env.OAUTH );">

 var ComfyJS = require ( "comfy.js" ) ;
ComfyJS . onCommand = ( user , command , message , flags , extra ) => {
  if ( command === "test" ) {
    ComfyJS . Say ( "replying to !test" ) ;
  }
}
ComfyJS . Init ( process . env . TWITCHUSER , process . env . OAUTH ) ;

Einem anderen Kanal beitreten

Sie können einem anderen Kanal oder einer anderen Kanalgruppe beitreten, indem Sie in Init() Folgendes angeben:

Einem einzelnen Kanal beitreten

 ComfyJS . Init ( "MyTwitchChannel" , null , "ChannelToJoin" ) ;

Beitritt zu mehreren Kanälen

 ComfyJS . Init ( "MyTwitchChannel" , null , [ "ChannelA" , "ChannelB" , "ChannelC" ] ) ;

Einlösung von Kanalpunktprämien

Das Einlösen von Kanalpunktprämien erfordert zusätzliche Twitch-OAuth-Berechtigungsbereiche (und muss das OAuth des Kanalbesitzers sein !)

Sie können dieses Tool verwenden: https://twitchapps.com/tokengen/

Bereiche: channel:manage:redemptions channel:read:redemptions user:read:email chat:edit chat:read

 ComfyJS . onReward = ( user , reward , cost , message , extra ) => {
  console . log ( user + " redeemed " + reward + " for " + cost ) ;
}

Comfy.JS enthält Funktionen zur Verwaltung von Channel Point Rewards. Für diese Funktionen ist die ClientID erforderlich, die zum Abrufen des Twitch-OAuth-Passworts für den Kanal verwendet wird.

GetChannelRewards ( clientId, manageableOnly = true )
- Ruft die Belohnungen des Kanals ab
CreateChannelReward ( clientId, rewardInfo )
- Erstellt eine Kanalpunktbelohnung
UpdateChannelReward ( clientId, rewardId, rewardInfo )
- Aktualisiert eine Kanalpunktbelohnung (Nur mit dieser ClientID erstellte Belohnungen können aktualisiert werden)
DeleteChannelReward ( clientId, rewardId )
- Löscht eine Kanalpunktbelohnung (Nur mit dieser ClientID erstellte Belohnungen können gelöscht werden)

 let channelRewards = await ComfyJS . GetChannelRewards ( clientId , true ) ;

let customReward = await ComfyJS . CreateChannelReward ( clientId , {
    title : "Test Reward" ,
    prompt : "Test Description" ,
    cost : 100 ,
    is_enabled : true ,
    background_color : "#00E5CB" ,
    is_user_input_required : false ,
    is_max_per_stream_enabled : false ,
    max_per_stream : 0 ,
    is_max_per_user_per_stream_enabled : false ,
    max_per_user_per_stream : 0 ,
    is_global_cooldown_enabled : false ,
    global_cooldown_seconds : 0 ,
    should_redemptions_skip_request_queue : true
} ) ;

let updatedReward = await ComfyJS . UpdateChannelReward ( clientId , customReward . id , {
    title : "Test Reward (Updated)" ,
    prompt : "Updated Description" ,
    cost : 200 ,
    is_enabled : true ,
} ) ;

await ComfyJS . DeleteChannelReward ( clientId , customReward . id ) ;

Verbindung zum Server wird getrennt

Mit Disconnect() können Sie die Verbindung zum Server und allen Kanälen trennen.

 ComfyJS . Disconnect ( ) ;

Alle unterstützten Veranstaltungen

onCommand ( user, command, message, flags, extra )
- Reagiert auf „!“ Befehle
onChat ( user, message, flags, self, extra )
- Reagiert auf Benutzerchats
onWhisper ( user, message, flags, self, extra )
- Reagiert auf ein Flüsterereignis des Benutzers
onMessageDeleted ( id, extra )
- Reagiert auf gelöschte Chat-Nachricht
onReward ( user, reward, cost, message, extra )
- ERFORDERT ZUSÄTZLICHE BERECHTIGUNGSBEREICHE
- Reagiert auf Channel Point-Einlösungen
onJoin ( user, self, extra )
- Reagiert auf den Beitritt eines Benutzers zum Chat
onPart ( user, self, extra )
- Reagiert darauf, dass der Benutzer den Chat verlässt
onHosted ( user, viewers, autohost, extra )
- Reagiert auf den gehosteten Kanal
- Erfordert eine Autorisierung als Sender
onBan ( bannedUsername, extra )
- Reagiert auf die Sperrung eines Benutzers
onTimeout ( timedOutUsername, durationInSeconds, extra )
- Reagiert auf eine Zeitüberschreitung eines Benutzers
onRaid ( user, viewers, extra )
- Reagiert auf ein Raid-Ereignis
onCheer ( user, message, bits, flags, extra )
- Reagiert auf den Jubel des Benutzers
onSub ( user, message, subTierInfo, extra )
- Reagiert auf das Abonnement des Benutzerkanals
onResub ( user, message, streamMonths, cumulativeMonths, subTierInfo, extra )
- Reagiert auf den Jahrestag des Abonnements des Benutzerkanals
onSubGift ( gifterUser, streakMonths, recipientUser, senderCount, subTierInfo, extra )
- Reagiert auf das Geschenkabonnement des Benutzers
onSubMysteryGift ( gifterUser, numbOfSubs, senderCount, subTierInfo, extra )
- Reagiert auf Benutzer, die Geschenkabonnements senden
onGiftSubContinue ( user, sender, extra )
- Reagiert auf die Fortsetzung des Geschenkabonnements des Benutzers
onConnected ( address, port, isFirstConnect )
- Reagiert, wenn eine Verbindung zum Twitch-Chat hergestellt wird.
onReconnect ( reconnectCount )
- Reagiert, wenn versucht wird, die Verbindung zum Twitch-Chat wiederherzustellen.
onError ( error )
- Haken für Fehler

Credits

Vielen Dank an alle Teilnehmer dieses Projekts!

Instafluff, Instafriend, Neo_TA, ChatTranslator, fydo, That_MS_Gamer, MrRayKoma, Amarogine, HunWalk, simrose4u, sparky_pugwash, soggycoffee, blackdawn1980, BooobieTrap, lizardqueen, TastyGamers101, MalForTheWin, SourBeers, Stay_Hydrated_Bot, codeaurora, DutchGamer46, TheHungerService, BungalowGlow, koralina_211, TominationTime, itsDeke, fd_god92, SushiDay, FlyToto_, Docpinecone, katori15, ScrtSolstice, QeraiX, superravemonster, Jwh1o1, Deitypotato, Stobie, Chlapicek99, tehWokes, SuperChihuahua, FranC312, FuriousFur, Moopaloo, CreativeBuilds, donaldwm, Zorchenhimer, Grognardian, ravavyr, Chibigirl24, DR4G0N_S4MUR41, PokemoHero, rekaj3773, cunavrito, TheGeekGeneration, DevMerlin, julieee22, malfunct, blazeninja3, pookiepew, xxMiabellexx, Rlchibi

Vielen Dank an alle, die dabei geholfen haben, Comfy.JS in ein Browsermodul zu verwandeln!

Instafluff, Instafriend, ChatTranslator, Gilokk0, qbotv3, That_MS_Gamer, KitAnnLIVE, simrose4u, MacabreMan2, LuRiMer313, sparky_pugwash, AbbyFabby, sethorizer, julieee22, Numb3rY, Jwh1o1, baileydale, kevkab, Stay_Hydrated_Bot, DrJavaSaurus, Stresstest, BungalowGlow, Dr_Zero, NiteCrawla, fd_god92, DrEriksen, Codeheir, Talk2meGooseman, Sneelps, Cottonsmiles, DutchGamer46, LilyHazel, Kyoslilmonster, Guthron, DragosNox, Sciondragons, HonestDanGames, Xynal, MerlinLeWizard, FablesGames, BrainoidGames, donaldwm, Gharrotey, RIKACHET, HeyOhKei, DevMerlin, CrimsonKnightZero, ellie_pop, ItsNaomiArt, SomaPills, TheSabbyLife, bktdakid31, IsaisChannel, thegooseofwild, itsDeke, bubblesandunicorns, jellydance, MalForTheWin, Chibigirl24, Pearcington, RikuRinku, rockysenpai24, DEAD_P1XL, codeaurora, EndlessMoonfall, fromtheannex, Optik_Nerve, qerwtr546, REAZNxxx, GoonPontoon, JesseSkinner, roberttables, pookiepew, Lannonbr, SoG_Cuicui, Deitypotato, shalomhanukkahbneishimon, UpmostKek, xeiu, skatesubzero, kingswerv, K1ng440, kaisuke, kinbiko, malfunct, BooobieTrap, Kara_Kim

Vielen Dank an alle, die mitgemacht haben, um Comfy.JS die Twitch PubSub-Unterstützung für Channel Point Reward-Einlösungen hinzuzufügen!

Instafluff, Instafriend, informatthemusic, aRandomTim, Shadesofpixie, That_MS_Gamer, ToeNeeHee, httpJunkie, ryanchetty_1, calguru, chrislocality, Atanerah, rekaj3773, moshiko777, fizhes, AnnaCodes, Smokestormx, TheGeekGeneration, SavenaV, KotaKlan, rosebutterfly24, Simpathey, Spationaute, DjDesidera, JupiterZky, judybelle1, Shaezonai, Shineslove, Airsickmammal, Walaber, Jellydance, LilyHazel, PainArtist, Nickloop_TTV, VerbatimStudios, Silversurfer1989, BellaTriXrbsa, Holloway87, Asherroth86, Tiwesday, not_your_point, JenDevelops, tenaciousw, Cuicui_off, stevis5, aranhawaii, DevMerlin, wabes1, jeckle, opti_21, sparky_pugwash, tommunist_64, DutchGamer46, DoctorArgus, simrose4u, DreamGardenPanda, onelineofme, stuyksoft, Simployed, JustinZedly, Rhedone, DrMikachu, Gurkenkater, MrDemonWolf, saltipretzelz, MerlinLeWizard, Kurokirisu, Juscekame, FuriousFur, andresurrego, MissNightcrawler, karatewump, DrillsKibo, florinpop17, Axell99Design, Ahmed_Riad_1, Keegan_GDiegen, PortaalGaming, mjewl, cheppy4444dude, Soccerdude4444, klforthwind, penguinian, 10TenArt, Atndesign, DNIStream, LoveSudoNimh, prosto_artem27, lucasnramos, A_Ninja_For_Jesus_Bruh, RedChrisMS, Lineyatronic, Totte292, A_Gold_Fish, ShiDotMoe, tbdgamer, MatthewDGroves, dota2attitude, mitersyntax, SekaCakes, llamakid29, CryptoCoyote, MurdocTurner, JeanValjean80, walpolea, Jessi8712, butschibuuuu, Cmiley6, TheFlamingWings, hehe24h, cryogen_sw, DrJavaSaurus, rota22_, julieee22, bronick16, ScrtSolstice, ghostlupo86, wake_the_beast, williamcameron2, GizmoPugLife, OG24com

Expandieren