broadcast
Library to help broadcast important information to all EQBC connected toons, or a single defined toon (driver).
Using the base interface it can also be used to trigger remote commands on remote characaters. See instructions on how to do this here
Heavily inspired by Knightly's 'Write' lua script
Requirements
- MQ
- MQ2Lua
- Either or both of:
- MQ2DanNet (Preferred communication method if both are loaded)
- MQ2EQBC
Installation
Add broadcast.lua and broadcastinterface.lua to the lua folder of your MQ directory.
Broadcast Usage
local broadcast = require 'broadcast'
-- recevier(s) is either a single string reciever or a table of recievers ie {"Toon1", "Toon2"}, an empty table will send to all
broadcast.Info(recevier(s), "Information for all")
broadcast.Success(recevier(s), "We succeded")
broadcast.Fail(recevier(s), "I failed")
broadcast.Warn(recevier(s), "Im in trouble")
broadcast.Error(recevier(s), "Something went horribly wrong")
-- Handles string formatting too
broadcast.Success(recevier(s), "%s successully cast %s", mq.TLO.Me.Name, 'Complete Heal')-- Config options
local broadcast = require 'broadcast'
broadcast.usetimestamp = false
broadcast.broadcastLevel = 'info'
broadcast.prefix = ''
broadcast.separator = '::'BroadcastInterface Usage
local broadCastInterfaceFactory = require 'broadcast/broadcastinterface'
---@alias ColorName 'Previous'|'Black'|'Blue'|'Cyan'|'Green'|'Maroon'|'Orange'|'Red'|'White'|'Yellow'
---@class BroadCastInterface
---@field Broadcast fun(message: string, recievers?: string[])
---@field ExecuteCommand fun(executeCommand: string, recievers: string[])
---@field ExecuteAllCommand fun(executeCommand: string, includeSelf?: boolean)
---@field ConnectedClients fun(): string[]
---@field ColorWrap fun(self: BroadCastInterface, text: string, color: ColorName): string
---@field ColorCodes table<ColorName, string>
local bci = broadCastInterfaceFactory()
local command = string.format('/say %s', "This is triggered remotly")
bci.ExecuteAllCommand(command, true) -- 2nd parameter is to include self and is optional (default false)
bci.ExecuteCommand(command, {"Toon1", "Toon2"}) -- 2nd parameter is a list of toons that should execute the command