For support, please visit us in discord: https://discord.gg/MR947AvtVJ

Lily's & Azure's Cluster Chat brings the ability to chat between clustered maps and/or discord in real-time!

This mod requires some setup to work. At minimum, required options must be set in GameUserSettings.ini and an api/webhook should be available to connect to using the configured settings. info about API at bottom of the page.

Configuration

Options should be placed under the header [LACC] in GameUserSettings.ini.

Either `URL` OR `DiscordWebhookURL` is required for this mod to function

URL= - Optional URL for endpoint (The format for this needs to be ws://ip:port or wss:// if you are using SSL)
Token= - Required security token, sent to the backend api to establish connection (see Server Api section below)
DiscordWebhookURL= - Optional URL for posting chat to a Discord channel
DiscordWebhookIcon= - Optional URL to override discord Webhook Icon (only used for discord post)
TribeAlliedChat=True - Optional toggle for Tribe/Allied cross-chat
Name= - Optional custom name for the map
VerboseLogging=False - Optional toggle to log all messages received
BlockInGameSettings=False - Blocks the InGame settings from being used/loaded
CompatibilityMode=False - This mode allows the mod to function with others when they have replaced chat (Will lose some extra functions soon to be added to chat I.E ChatCommands)
WelcomeMessage= - Optional message to be displayed in chat when player joins
WelcomeMessageMode=0 - Mode for how this message is sent
AutoReconnectDelay=600 - Time in seconds before mod tries autoreconnection if socket is dead
DepartMessage= - Optional message to be displayed in chat when player leaves
DepartMessageMode=0 - Mode for how this message is sent
ChatCommandPrefix=/ - Prefix for Chat Command activation
AllowOnlineCountPvP=False - Overrides the visibility for showing online player count in PvP
DisabledChatCommandsCSV= - CSV list of command names to disable on boot
MapColour= - r,g,b,a string for map colour to be displayed with API messages (Between 0 - 1)
CustomMessageFormat= <RichColor Color="$mapColour$">[$timestamp$] [$mapName$] $playerName$$tribeName$ $sendMode$</>: $message$ - Custom message formatting for display API messages
AdminOverridesMapColour=True - Uses Admin colour in chat instead of set Map Colour
DisableMapColour=False - Removes custom map colour from API messages and uses default ark colours
BlockedPrefixCSV= - A CSV of blocked prefixes to be not sent to the API
PassSystemMessages=True - Pass System messages to API (Welcome/Depart Messages)
SystemName= - Optional name for these messages to be sent by
MessageColourCSV=1,1,1,1 - Colour to change the messages from the API (default is white)
EmojiParseMode=0 - How the mod handles emojis and coloured messages (will need changing to match how you set your custom message format)

WelcomeMessage has the following arguments (Note - This is optional but without this the first message sent in compatibility mode by a player could be missed):

$playerName$ = Player Name
$tribeName$ = Tribe Name
$mapName$ = Map Name

WelcomeMessageMode has the following options:

0 = Off
1 = Sent to Player
2 = Sent to Tribe
3 = Sent to Global

DepartMessage has the following arguments:

$playerName$ = Player Name
$tribeName$ = Tribe Name
$mapName$ = Map Name

DepartMessageMode has the following options:

0 = Off
1 = Sent to Tribe
2 = Sent to Global

CustomMessageFormat has the following arguments:

$mapColour$ = r,g,b,a value for map colour (Between 0 - 1)
$messageColour$ = r,g,b,a value for message colour (Between 0 - 1)
$timestamp$ = timestamp of message recieved (players local time)
$mapName$ = Custom map name
$playerName$ = Player name of sender
$tribeName$ = Tribe name of sender
$message$ = Message content
$sendMode$ = Mode the chat was sent in
$chatTypeColour$ = r,g,b,a value for default ark message colours

EmojiParseMode has the following options:

0 = Off
1 = messageColour
2 = mapColour
3 = chatTypeColour

there is also a PayloadVersion option for anyone building their own API to integrate the mod with, by default it will send the version baked into the mod (3 currently). Editing this is not advised unless you know what you're doing.

Commands

ScriptCommand reconnectLACC - Attempts reconnection and handshake with the api
ScriptCommand forceLoadTribeMaps - Force loads tribe mapping data from SaveGame file
ScriptCommand forceClearTribeMaps - Resets the tribe mapping data in the server's SaveGame file
ScriptCommand openLACCConfig - Opens the in-game config menu
ScriptCommand openLACCChatCommands - Opens in-game Chat Commands UI
ScriptCommand openLACCUserGroups - Opens in-game User Group UI

Chat Commands:

Comes with defaults that can be disbaled of:

whisper (Allows whispers between two online players. /whisper [PlayerName] [message])
listplayers (Opens a UI that shows all Online Players)
ping (responds with pong)
suicide (kills player without the implant delay)
sethome (sets the players home location for home)
clearhome (removes set home)
home (if not home is set, it will use the last bed the player spawned in)
waypoint (quickly places a waypoint at current player location with an optional name. /waypoint [name])

Each command has the following options:

Chat Response
Console Command
URL to open
Cooldown
Level
Enabled

each of these options will take the following arguments:

{playerName} = Player Name
{eosID} = EOS ID
{playerID} = Player ID

Server Api

LACC requires either a webhook or an api to function. In this you have a few options:

Purchase Lily's API

Lily has pre-built a solution and will be selling access via her discord: https://discord.gg/MR947AvtVJ

Lily's API includes a discord bot for 2-way communication and enables cluster chat (There is a self host and hosted version available)
All features made available by Lily's api are available to users wishing to build their own solution.

Build your own

Assumptions and Data formats are documented here: https://github.com/Azuremoon13/LACC/wiki/Creating-a-Server

Use Discord Webhooks:

This guide provided by Discord can instruct you in setting up a webhook: https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks

LACC: Lily and Azure's Cluster Chat