Skip to content

Latest commit

 

History

History
157 lines (127 loc) · 5.94 KB

README.md

File metadata and controls

157 lines (127 loc) · 5.94 KB
Raw

Comfy.JS

We built this Comfy Twitch Chat Module live on Twitch for Coding Cafe!

Comfy.JS lets you integrate with Twitch chat for your Twitch channel SUPER EASILY in just a few lines of code.

Instafluff

Come and hang out with us at the Comfiest Corner on Twitch!

https://twitch.tv/instafluff

https://twitter.com/instafluffTV

Instructions

Node

  1. Install comfy.js
npm install comfy.js --save
  1. Respond to !commands your channel
var ComfyJS = require("comfy.js");
ComfyJS.onCommand = ( user, command, message, flags ) => {
  if( flags.broadcaster && command == "test" ) {
    console.log( "!test was typed in chat" );
  }
}
ComfyJS.Init( "MyTwitchChannel" );

Browser

  1. Add comfy.js
<script src="comfy.min.js"></script>
  1. Respond to !commands your channel
<html>
  <head>
    <script src="comfy.min.js"></script>
  </head>
  <body>
    <script type="text/javascript">
      ComfyJS.onCommand = ( user, command, message, flags ) => {
        if( flags.broadcaster && command == "test" ) {
          console.log( "!test was typed in chat" );
        }
      }
      ComfyJS.Init( "MyTwitchChannel" );
    </script>
  </body>
</html>

Flags

Currently, the flags possible in onCommand() are:

  • broadcaster
  • mod
  • subscriber
  • vip

Reading Chat Messages

You can read chat messages by using the onChat() handler

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

Sending Chat Messages

Sending Chat Messages can be done through ComfyJS.Say( message ) but requires an OAUTH password when connecting to chat.

Securely adding your password

  1. Get a Twitch Chat OAuth Password Token - https://twitchapps.com/tmi/
  2. Install dotenv
npm install dotenv --save
  1. Create a file named .env that looks like this:
TWITCHUSER=[YOUR-USERNAME-HERE]
OAUTH=[YOUR-OAUTH-PASS HERE] # e.g. OAUTH=oauth:kjh12bn1hsj78445234
  1. Initialize with the Username and OAUTH password
var ComfyJS = require("comfy.js");
ComfyJS.onCommand = ( user, command, message, flags ) => {
  if( command == "test" ) {
    ComfyJS.Say( "replying to !test" );
  }
}
ComfyJS.Init( process.env.TWITCHUSER, process.env.OAUTH );

Joining a Different Channel

You can join a different channel or groups of channels by specifying in the Init()

Joining a Single Channel

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

Joining Multiple Channels

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

All Supported Events

  • onCommand( user, command, message, flags, extra )
    • Responds to "!" commands
  • onChat( user, message, flags, self, extra )
    • Responds to user chatting
  • onWhisper( user, message, flags, self, extra )
    • Responds to user whisper event
  • onMessageDeleted( id, extra )
    • Responds to chat message deleted
  • onJoin( user, self )
    • Responds to user joining the chat
  • onPart( user, self )
    • Responds to user leaving the chat
  • onHosted( user, viewers, autohost )
    • Responds to channel being hosted
    • Requires being authorized as the broadcaster
  • onRaid( user, viewers )
    • Responds to raid event
  • onCheer( message, bits, extra )
    • Responds to user cheering
  • onSub( user, message, subTierInfo, extra )
    • Responds to user channel subscription
  • onResub( user, message, streamMonths, cumulativeMonths, subTierInfo, extra )
    • Responds to user channel subscription anniversary
  • onSubGift( gifterUser, streakMonths, recipientUser, senderCount, subTierInfo, extra )
    • Responds to user gift subscription
  • onSubMysteryGift( gifterUser, numbOfSubs, senderCount, subTierInfo, extra )
    • Responds to user sending gift subscriptions
  • onGiftSubContinue( user, sender, extra )
    • Responds to user continuing gift subscription

Credits

Thank you too all the participants of this project!

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

Thank you to everyone that helped in turning Comfy.JS into a browser module!

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