LibGroupBroadcast allows other addons to send data to group members.
LibGroupBroadcast allows other addons to send data to group members.
It takes care of everything related to the data transfer, so authors can focus on the functionality of their addons instead of having to deal with the technical details of sending data over.
It provides tools to serialize and deserialize data, handles queuing so multiple addons can send data without interfering with each other and offers settings and insight to users.
In Update 45 ZOS introduces the first official API to share custom addon data between group members.
The new API only provides a basic data channel that can be accessed by a single addon and allows to send 32 bytes of date once every second.
In order to allow different addons to share the channel without being incompatible to each other, it is necessary to have one library that coordinates communication.
LibGroupBroadcast is essentially version 2 of LibGroupSocket, which previously did the same thing by abusing map pings as a data channel and this new version incorporates all the ideas I had gathered over the years, as well as feedback provided by m00ny, ExoY, Baertram and others.
This version is currently under heavy development and still misses some features. As such you should expect things to change a lot and breaking changes to occur without warning. It also includes some libraries that are developed alongside the base LibGroupBroadcast and can be understood as usage examples. These will be moved out as soon as the library is stable. It's also set up in a way that ensures compatibility on both live and pts, so it can be installed without worry.
The library uses unit tests to ensure long term stability. These can be run inside and outside the game with the help of Taneth and ESOLua.
While the basic functionality already works pretty well, most aspects of LibGroupBroadcast are still up for discussion. Especially the API is still subject to change, in case there is some good feedback. You can discuss it either here in the comments, or in this forum thread.
In the likely case that you find a bug while implementing your protocol, ideally you'd write a minimal test case that outlines the problem (in case you want it to get fixed fast).
If that's not possible, the next best thing you can do is sending over detailed steps on when and how you encountered that issue (e.g a copy of your protocol declaration, which data you tried to send, a LibDebugLogger save variable file, a video, etc).
As already mentioned, there are still several things on the immediate todo list:
- Improve error handling in various places and add unit tests for error cases
- Add data usage UI, to tell users which addons are using up their group broadcast bandwidth
- Add protocol inspector UI for authors
- Finalize documentation
How to use LibGroupBroadcast:
In order to know who sent what and ensure compatibility between addons, it is necessary to use ids and names which have to be globally unique across all addons. To make coordinating easy, we have created a page on the ESOUI wiki, where every author has to write down the ids and names they wish to use, before uploading their addon to ESOUI. In the interest of everyone, non-compliance will lead to addons getting rejected, or removed.
In case a collision of ids is reported for addons that are not available on ESOUI (such as console addons), any protocol which is not added to the wiki will be blocked from using a specific id, in favor of the ones mentioned on the wiki.
Before you can send data, you need to register a handler with the library. The handler symbolizes your addon in the context of the library.
It allows you to set various information, which will be displayed in the UI (once implemented).
Ideally every handler that transfers data that could be of interest to other addons, should provide other addons with a way to access the transferred data, to avoid unnecessary duplicate implementations, id and bandwidth usage.
To that end, you can optionally attach a public API. How exactly this API is shaped is entirely up to you.
Once your handler is in place, you can send data via one of two ways.
The first option is to send so called "custom events". These can be used to inform the group about something that doesn't require sending actual data. They are currently limited to 40 ids and reserved for addons that don't need all the complexity of writing their own protocol. The UI Reload handler operates in this fashion.
As simple as it gets.
For all other scenarios it is necessary to define a protocol:
There are a variety of different fields to choose from, which can be combined to create complex data structures. The following fields are available:
- FlagField: A basic boolean value
- NumericField: A number value
- PercentageField: An optimized form of NumericField that can contain a number between 0 and 1.
- StringField: A string value
- EnumField: Allows to send predefined values of any type
- OptionalField: Can wrap other fields to make them optional
- ArrayField: Can wrap a field to make it into a numeric list
- TableField: Can contain other fields to allow you to structure your data
- VariantField: Allows to send different data structures over the same protocol id
- ReservedField: A placeholder to reserve a number of bits for later use
The fields offer various options that allow LibGroupBroadcast to minimize your data usage by limiting each value to the necessary range.
Check the API reference as well as the source code for more details.
API reference
LibGroupBroadcast
RegisterHandler
Registers a handler under a unique name. A handler in this context is a library or addon that uses one or more protocols or custom events for communication.
@param addonName — The name of the addon or library that is registering the handler.
@param handlerName — An optional short name of the handler to register, which can be used in addition to the addon name to get the handler api.
@return handler — An object with methods to declare protocols and custom events with and to modify various aspects of the handler, or nil if the registration failed.
See:
- LibGroupBroadcast.GetHandlerApi
GetHandlerApi
Returns a handler's api by its unique name, if it is public.
@param handlerName — The name of the handler to get.
@return handler — The handler api table that was registered with the given handler name or nil if no api was provided.
See:
- LibGroupBroadcast.RegisterHandler
RegisterForCustomEvent
Registers a callback function to be called when a custom event is received.
@param eventName — The custom event name to register for.
@param callback — The callback function to call when the custom event is received. Receives the unitTag of the sender as an argument.
@return success — True if the callback was successfully registered, false otherwise.
UnregisterForCustomEvent
Unregisters a callback function from a custom event.
@param eventName — The custom event name to unregister from.
@param callback — The callback function to unregister. Has to be the same instance as the one registered.
@return success — True if the callback was successfully unregistered, false otherwise.
CreateArrayField
Creates and returns an ArrayField, which can be used to send the passed field multiple times.
Internally this will use a NumericField to store the length of the array and then serialize the values using the passed field.
By default the array can have up to 255 elements, but this can be changed using the options table.
@param valueField — The field that should be used for the values in the array.
@param options — The options table to use for the field.
@return field — The created ArrayField instance.
See:
- ArrayField
Options:
- minLength - number - The minimum length of the array.
- maxLength - number - The maximum length of the array.
- defaultValue - table - The default value for the field.
CreateEnumField
Creates and returns an instance of the EnumField class.
@param label — The label of the field.
@param valueTable — The array containing the possible values for the field.
@param options — The options table to use for the field.
@return field — The created EnumField instance.
See:
- EnumField
Options:
- maxValue - number - The max value of the field. Defaults to the length of the valueTable. Can be used to reserve space for future values.
- numBits - number - The number of bits to use for the field. Can be used to reserve a specific number of bits for future values.
CreateFlagField
Creates and returns an instance of the FlagField class.
@param label — The label of the field.
@param options — The options table to use for the field.
@return field — The created FlagField instance.
See:
- FlagField
Options:
- defaultValue - boolean - The default value for the field.
CreateNumericField
Creates and returns an instance of the NumericField class.
@param label — The label of the field.
@param options — The options table to use for the field.
@return field — The created NumericField instance.
See:
- NumericField
Options:
- defaultValue - number - The default value for the field
- numBits - number - The number of bits to use for the field. If not provided, it will be calculated based on the value range.
- minValue - number - The minimum value that can be sent. If not provided, it will be calculated based on the number of bits and maxValue.
- maxValue - number - The maximum value that can be sent. If not provided, it will be calculated based on the number of bits and minValue.
- precision - number - The precision to use when sending the value. Will be used to divide the value before sending and multiply it after receiving. If not provided, the value will be sent as is.
- trimValues - boolean - Whether to trim values to the range. If not provided, send will fail with a warning when the value is out of range.
CreateOptionalField
Creates and returns an instance of the OptionalField class.
@param valueField — The field that should be made optional.
@return field — The created OptionalField instance.
See:
- OptionalField
CreatePercentageField
Creates and returns an instance of the PercentageField class.
@param label — The label of the field.
@param options — The options table to use for the field.
@return field — The created PercentageField instance.
See:
- PercentageField
Options:
- defaultValue - number - The default value for the field. Must be between 0 and 1.
- numBits - number - The number of bits to use for the percentage.
CreateReservedField
Creates and returns an instance of the ReservedField class.
@param label — The label of the field.
@param numBits — The number of bits to reserve.
@return field — The created ReservedField instance.
See:
- ReservedField
CreateStringField
Creates and returns an instance of the StringField class.
@param label — The label of the field.
@param options — The options table to use for the field.
@return field — The created StringField instance.
See:
- StringField
Options:
- characters - string - The characters to use for the string. If not provided, the string will be treated as a sequence of bytes.
- minLength - number - The minimum length of the string. Defaults to 0.
- maxLength - number - The maximum length of the string. Defaults to 255.
- defaultValue - string - The default value for the field.
CreateTableField
Creates and returns an instance of the TableField class.
@param label — The label of the field.
@param valueFields — A list of fields contained in the table.
@param options — The options table to use for the field.
@return field — The created TableField instance.
See:
- TableField
Options:
- defaultValue - table - The default value for the field.
CreateVariantField
Creates and returns an instance of the VariantField class.
@param variants — A list of fields that can be used as variants.
@param options — The options table to use for the field.
@return field — The created VariantField instance.
See:
- VariantField
Options:
- defaultValue - table - The default value for the field.
- maxNumVariants - number - The maximum number of variants that can be used. Can be used to reserve space for future variants.
- numBits - number - The number of bits to use for the amount of variants. Can be used to reserve additional space to allow for future variants.
CreateFieldBaseSubclass
Creates a subclass of the FieldBase class. Can be used to create custom field types.
@return subclass — The created FieldBase subclass.
See:
- FieldBase
SetupMockInstance
Creates a new separate instance of the LibGroupBroadcast library for use in Taneth tests.
The returned table has the same API as the global LibGroupBroadcast table, but is not connected to the global state.
It also contains references to some internal objects that are not normally exposed and uses an instance of MockGameApiWrapper.
@param createWithoutSaveData — If true, the mock instance will behave like before EVENT_ADD_ON_LOADED was fired and not have any save data.
@return instance — A new instance of the library for use in tests.
See:
- LibGroupBroadcastInternal.SetupMockInstance
CustomEventOptions
displayName
A display name for use in various places.
description
A description for use in various places.
userSettings
Additional settings
isRelevantInCombat
Whether the customEvent is relevant in combat.
Handler
SetApi
Sets the API object for the handler which is returned by LibGroupBroadcast's GetHandler function.
@param api — The API object to set.
See:
- LibGroupBroadcast.GetHandlerApi
SetDisplayName
Sets a display name for the handler for use in various places.
@param displayName — The display name to set.
SetDescription
Sets a description for the handler for use in various places.
@param description — The description to set.
SetUserSettings
Sets custom settings for the handler.
@param settings — An instance of UserSettings.
DeclareCustomEvent
Declares a custom event that can be used to send messages without data to other group members with minimal overhead or throws an error if the declaration failed.
Each event id and event name has to be globally unique between all addons. In order to coordinate which values are already in use,
every author is required to reserve them on the following page on the esoui wiki, before releasing their addon to the public:
https://wiki.esoui.com/LibGroupBroadcast_IDs
@param eventId — The custom event ID to use.
@param eventName — The custom event name to use.
@param options — Configuration for the custom event
@return FireEvent — A function that can be called to request sending this custom event to other group members.
See:
- CustomEventOptions
IsCustomEventEnabled
Returns whether the user has enabled data transmission for this custom event in the settings.
You can check this before calling FireEvent, otherwise the library will show the blocked attempts in its own UI.
If you want to inform the user that your addon won't work due to the custom event being disabled,
you should only do so in a non-intrusive way (e.g. when they actively interact with features that require it).
**It is highly discouraged to show unsolicited notifications (e.g. chat messages or popups) about this.**
@param eventIdOrName — The id or name of the custom event to check.
@return IsEnabled — Whether the custom event is allowed to be sent.
DeclareProtocol
Declares a new protocol with the given ID and name and returns the Protocol object instance or throws an error if the declaration failed.
The protocol id and name have to be globally unique between all addons. In order to coordinate which values are already in use,
every author is required to reserve them on the following page on the esoui wiki, before releasing their addon to the public:
https://wiki.esoui.com/LibGroupBroadcast_IDs
@param protocolId — The ID of the protocol to declare.
@param protocolName — The name of the protocol to declare.
@return protocol — The Protocol object instance that was declared.
See:
- Protocol
Protocol
GetId
Getter for the protocol's ID.
@return id — The protocol's ID.
GetName
Getter for the protocol's name.
@return name — The protocol's name.
SetDisplayName
Sets a display name for the protocol for use in various places.
@param displayName — The display name to set.
displayName
GetDisplayName
Returns the displayName of the protocol if it was set.
@return displayName — The displayName or nil.
SetDescription
Sets a description for the protocol for use in various places.
@param description — The description to set.
description
GetDescription
Returns the description of the protocol if it was set.
@return description — The description or nil.
SetUserSettings
Sets custom settings for the protocol.
@param settings — An instance of UserSettings.
settings
GetUserSettings
Returns the custom settings of the protocol if they have been set.
@return settings — An instance of UserSettings or nil.
AddField
Adds a field to the protocol. Fields are serialized in the order they are added.
@param field — The field to add.
@return protocol — Returns the protocol for chaining.
OnData
Sets the callback to be called when data is received for this protocol.
@param callback — The callback to call when data is received.
@return protocol — Returns the protocol for chaining.
IsFinalized
Returns whether the protocol has been finalized.
@return isFinalized — Whether the protocol has been finalized.
IsEnabled
Returns whether the user has enabled data transmission for this protocol in the settings.
You can check this before calling Send, otherwise the library will show the blocked attempts in its own UI.
If you want to inform the user that your addon won't work due to the protocol being disabled,
you should only do so in a non-intrusive way (e.g. when they actively interact with features that require it).
**It is highly discouraged to show unsolicited notifications (e.g. chat messages or popups) about this.**
@return IsEnabled — Whether the protocol is allowed to send data.
Finalize
Finalizes the protocol. This must be called before the protocol can be used to send or receive data.
@param options — Optional options for the protocol.
Options:
- isRelevantInCombat - boolean - Whether the protocol is relevant in combat.
- replaceQueuedMessages - boolean - Whether to replace already queued messages with the same protocol ID when Send is called.
Send
Converts the passed values into a message and queues it for sending.
@param values — The values to send.
@param options — Optional options for the message.
@return success — Whether the message was successfully queued.
ABOUT THIS LISTING
This page describes LibGroupBroadcast by sirinsidiator. The description and screenshots are the author's own, imported from their listing on ESOUI on 26 October 2026: https://www.esoui.com/downloads/info1337-LibGroupBroadcast.html
Mythiq.net hosts no files for it. The download button goes straight to the release file on cdn.esoui.com, so you are downloading from the author's own host, not from a copy of ours.
The download count, rating and comments on this page start at zero and count Mythiq.net only. The source's own figures are not copied here — they measure a different site, and a number that cannot be checked against our own ledger is not worth printing.
Requirements
Game versions
11.3.0
11.2.0
API VERSION
Built for ESO API version 11.3.0, 11.2.0. After a patch the game marks add-ons built for the previous API as out of date; the "Allow out of date add-ons" checkbox in the add-on menu loads them anyway, and most work.
LIBRARIES
Many ESO add-ons depend on a shared library — LibAddonMenu-2.0 above all — which is installed separately, exactly like an add-on. A dependency that is missing shows as the add-on simply not appearing in the list.
CONSOLE
Add-ons are PC and Mac only. There is no way to load them on console.
Installation
1. Download the archive with the button on this page and unzip it.
2. Move the unzipped folder into your add-ons directory:
Windows — Documents\Elder Scrolls Online\live\AddOns
3. Start the game, and at the character select screen click Add-Ons.
4. Tick the add-on. If it is greyed out and marked out of date, tick "Allow out of date add-ons" at the top of the same panel.
5. Log in. Most add-ons need a /reloadui after they are first enabled.
UPDATING
Delete the old folder first. ESO loads everything it finds, and two copies of one add-on is the usual cause of "an add-on has produced an error" on login.
This release downloads from cdn.esoui.com, not from us, so
there is no checksum to compare against. Scan the archive before you unpack it.
Version history
v2.0.0Latest
22 Feb 2026 · 75 KB via cdn.esoui.com · 3 downloads Download
v2.0.0
- fixed two major issues related to flex messages (thanks Vladislav Sheludchenkov!)
- removed offline mode related features, as the game handles grouped offline players differently than expected
- moved LibGroupResources and LibGroupUIReload into separate projects
* NOTE: Make sure to install them if you have addons that rely on them!
- removed LibGroupSocket compatibility code
* NOTE: It should no longer be in use, but if by chance some addon still relies on it, you will have to manually extract it from 2.0.0-ea3 found here.
- some minor code improvements
v2.0.0-ea3:
- added setting to disable sending data in offline mode
- fixed LAM warning
- fixed error in Infinite Archive
- fixed various minor issues
- removed now unused LibGroupSocket v1 code
v2.0.0-ea2:
- implemented settings panel with options to disable custom events and protocols
- added APIs to add custom options for custom events and protocols to setting panel
- implemented behavior when player is not grouped
- changed VariantField to no longer wrap its values in an extra table
- renamed LibGroupBroadcastGroupResources to LibGroupResources
- renamed LibGroupBroadcastUIReload to LibGroupUIReload
- fixed various issues
v2.0.0-ea1:
- early access for pts
- implemented data sharing on top of new group broadcast api
- simplified protocol definition
- added unit tests
v1.3.0:
- updated to modern library standards and switched to semantic versioning
- removed all embedded libraries
- added logging and chat messages via LibDebugLogger and LibChatMessage respectively
- added global variable "LibGroupSocket" for direct access without LibStub
r2:
- reserved message type for Solinur's dps handler
- fixed settings not getting saved, even when the library is installed as a standalone addon
* NOTE: this required a small change to the way how handlers initialize their settings
- added flag to resource handler to transmit which resource pool is larger
* NOTE: when only the percentage is transmitted by a player, it will set the max value of the larger pool to 2k instead of 1k
Off-site on cdn.esoui.com —
no checksum, because we never held this file.
Link checked by our review team on 26 Oct 2026.
Tell us if something is wrong — a file that will not work, content taken from
someone else, or anything that looks unsafe. Reports go to our review team, not
to the author.
We use cookies to ensure that we give you the best experience on our website and improve your experience. By continuing to use this site you consent to such use of cookies.