customspeak

README

CustomSpeak

Discord bot for custom overlay

Usage

• invite bot to your server by link
• connect to voice channel
• run cs.exe from releases page
• type in discord !!cs
• get status images in ./SERVER_NAME_CHANNEL_NAME/USERNAME.png
• you can change default images in on.png and off.png
• if you want custom image for one user, you can create ./custom/USERNAME/on.png

Documentation

Index

• Constants
• func Close()
• func Init() error
• func Serve(email string, password string) error
• func StartUI(view *qml.QQmlApplicationEngine)
• type ConfigStruct
• type Event
• type MocBridge
• type Plugin
  • func NewPlugin() *Plugin
  • func (p Plugin) Close()
  • func (p Plugin) GetDescription() string
  • func (p Plugin) GetName() string
  • func (p Plugin) GetVersion() string
  • func (p Plugin) Init() error
  • func (p Plugin) StartUI(view *qml.QQmlApplicationEngine)

Constants

const Description string = "Custom Discord layer for OBS"

Description is description

const Name string = "customspeak"

Name is plugin ID

const Version string = "0.3.0"

Version is version

Functions

func Close

func Close()

func Init

func Init() error

func Serve

func Serve(email string, password string) error

func StartUI

func StartUI(view *qml.QQmlApplicationEngine)

Types

type ConfigStruct

type ConfigStruct struct {
	Email    string `default:""`
	Password string `default:""`
	Token    string `default:""`
}

type Event

type Event struct {
	Username string
	Speak    bool
}

type MocBridge

type MocBridge struct {
	core.QObject
	// contains filtered or unexported fields
}

type Plugin

type Plugin struct{}

func NewPlugin

func NewPlugin() *Plugin

func (Plugin) Close

func (p Plugin) Close()

func (Plugin) GetDescription

func (p Plugin) GetDescription() string

GetDescription is desc getter

func (Plugin) GetName

func (p Plugin) GetName() string

GetName is name getter

func (Plugin) GetVersion

func (p Plugin) GetVersion() string

GetVersion is version getter

func (Plugin) Init

func (p Plugin) Init() error

func (Plugin) StartUI

func (p Plugin) StartUI(view *qml.QQmlApplicationEngine)