Installation

---

Click the button below to get redirected to Roblox's library page. Take the asset from there and use the Toolbox in Studio to insert it into your game. Place the folder in ServerScriptService

Basic usage

---

Open the "Settings" script and insert your username into the "Whitelist" setting. When you join the game, you should see an icon on the right side of your topbar. When you enable it, everything you say should get shown on the host gui.

Name overrides

---

By editing the "Names" setting, you can override the names that will appear in messages. By default it changes "gabys2005" to "egg"

Rich Text

---

By editing the "RichTextEnabled" setting, you can enable rich text in messages. By default it is disabled. Rich text allows you to use a custom syntax to format your messages with per-character changes/animations. It's mostly useful for NPC hosts where you can control the gui and bubble chat separately.

Rich Text syntax:

• {bold}This text will be in bold

  

• {cursive}This text will be cursive

  

• {color:255 0 0}This text will be red

  

• {anim:Rainbow}This text will have a rainbow animation

  
  

  {anim:Tilt}This text will have a tilt animation

  
  

  {anim:Shake}This text will have a shake animation

  

• {eanim:FadeIn}This text will fade in

  
  

  {eanim:JumpIn}This text will jump in

  
  

  {eanim:Rainbow}This text will use a rainbow to show up

  

• ...{reset}This text will have all of it's formatting reset

  Any formatting applied before {reset} will be forgotten

• 								This sentence will have a {color:0 255 0}green {bold}bold{reset} word in the middle of it.

  

API

---

Using the api

local api = require(game.ServerScriptService.HostGui.Api)

---

Method: api:SendMessage()

Arguments:

• author: string - required - the username that will appear as the author
• message: string - required - the message that will appear
• ignoreNameOverrides: boolean - optional - if true, the api will ignore the "Names" setting, FALSE by default
• filter: boolean - optional - if true, the api will filter the message before showing it, FALSE by default
• filterUserId: number - required if filter is true - the UserId of the person that sent the message, used for filtering
• useRichText: boolean - if true, the gui will use rich text with a custom syntax allowing for per-letter animations etc.

Examples:

api:SendMessage("gabys2005", "hello")

				api:SendMessage("gabys2005", "aaaa", true)

				api:SendMessage("DarticFernandez", "egg", false, true, 242801959)

---

Event: api.MessageSent

Fired whenever a message is sent. Arguments passed on are the same as above

api.MessageSent:Connect(function(author, message, overrides, filter, filterId, useRichText)

				    print(author, "sent a message:", message, "with settings:", overrides, filter, filterId, useRichText)

				end)