vimm-chat-lib-new
TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

Vimm-Chat-Lib

Usage

const Channel = ["channel1","channel2","ETC"]; // Your channel's username

const Vimm = require("vimm-chat-lib-new")

const chat = new Vimm.VimmChat({
	token: "BOT TOKEN HERE",
	debug: false // Outputs heartbeat logs if true.
	
})

function Connect(){

	chat.connect(Channel).then(meta => {
	
		chat.on("message", msg => {
			
			if (msg.roles[0].bot == true) return
			
			// msg displays the following when a message is said in chat.
			//{
			//      roles: [{
                        //         admins: false,
                        //         developer: false,
                        //         broadcaster: false,
                        //         moderators: false,
                        //         bot: false,
                        //         subscriber: false,
                        //         premiumT1: false,
                        //         premiumT2: false,
                        //         premiumT3: false,
                        //         supporter: false
			//      }]
  			//	mtype: 'message',
  			//	message: 'test',
  			//	chatter: 'username',
			//      channel: 'channelname',
			//      prefix: '[bot]'
			//}
			
			if (msg.message == "!hey") {
				chat.sendMessage("YOURCHANNELNAME", `HELLO THERE, NICE MEET YOU!`)
			}

			// BOT MESSAGE LAYOUT
			
			//{
			//      roles: [{
                        //         admins: false,
                        //         developer: false,
                        //         broadcaster: false,
                        //         moderators: false,
                        //         bot: true,
                        //         subscriber: false,
                        //         premiumT1: false,
                        //         premiumT2: false,
                        //         premiumT3: false,
                        //         supporter: false
			//      }]
  			//	mtype: 'message',
  			//	message: 'HELLO THERE, NICE MEET YOU!',
  			//	chatter: 'BOTNAME',
			//      channel: 'YOURCHANNEL',
			//      prefix: '[bot]'
			//}
			
                })
		
		chat.on("close", event => {

			if(event){ // removed due to the bot not connecting - if(event == 1006)
			
				chat.connect(Channel) // If Abnormal disconnect (1006), Vimm Bot reconnects.
				
			}
			
		})
		
	})
	
}

Connect() // Initiates connection to Vimm's WS Server.

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
1.1.02latest

Version History

VersionDownloads (Last 7 Days)Published
1.1.02
1.0.31
1.0.00

Package Sidebar

Install

npm i vimm-chat-lib-new

Weekly Downloads

0

Version

1.1.0

License

ISC

Unpacked Size

65.2 kB

Total Files

17

Last publish

Collaborators

  • nekosunevr