banchogo

banchogo

This module is currently WIP

Inspired by banchojs

TODO

• Multiplayer support
• Better Reconnect mechanism
• Tests
• Examples
• Documentation
• readme

Bot Account

// TODO:

Please DON'T create a separate account for your bot. This will be considered multi-accounting and may restrict both of your accounts

Like banchojs, this package uses rate limits for normal user accounts by default

Getting Started

Install module with go get github.com/robloxxa/banchogo

package main

import (
	"fmt"
	"github.com/robloxxa/banchogo"
	"os"
	"os/signal"
	"syscall"
)

func main() {
	client := banchogo.NewBanchoClient(banchogo.ClientOptions{
		Username: "robloxxa",
		Password: "irc_password",
	})

	client.OnceConnect(func() {
		fmt.Println("Connected!")
	})

	client.OnMessage(func(msg *banchogo.PrivateMessage) {
		fmt.Println(msg.User.Name() + ": " + msg.Content())
	})

	err := client.Connect()
	if err != nil {
		panic(err)
	}
    
	// Banchogo launch their own goroutines and doesn't block main one.
	// We can block main goroutine by waiting for a CTRL-C input
	// OR
	// We can use <-client.Done channel which will be closed on Disconnect
	fmt.Println("Bot is now running. Press CTRL-C to exit.")
	sc := make(chan os.Signal, 1)
	signal.Notify(sc, syscall.SIGINT, syscall.SIGTERM, os.Interrupt)
	<-sc
    // Gracefully shutting down, stopping all goroutines and properly disconnect from IRC
	client.Disconnect()
}

Event Problem

Since this module aimed to be easy and similar to banchojs, a banchogo Event system is synchronous like Node.js.

This can be problematic if you use methods like user.Where(), user.Whois(), user.Stats(), etc., which block reading goroutine until it hits timeout while you wait response from channel.

client.OnMessage(func(m *PrivateMessage) {
	data := <-m.User.Where()
	// ...it will hang here until timeout
	// this is because response is ahead and can't be obtained in same goroutine where event emitted
}) 

But it is nothing to worry about, just run these methods in separate goroutine

client.OnMessage(func(m *PrivateMessage) {
	go func() {
        data := <-m.User.Where()
		fmt.Println("data: ", data)
	}()
}) 

Basically, if you see that method returns a chan, you should consider calling it in separate from emitted event goroutine

Compatability

This package uses go generics with was introduced in go 1.19.

All versions below 1.19 are incompatible.

Special thanks

ThePooN and his community - For creating banchojs, which inspired me to make this package, and for saving my time understanding how bancho works

TheHowl - For go osu api wrapper go-osuapi