Gobchat (FFXIV chat overlay)

Gobchat is an overlay with the goal to provide a better chat experience for roleplayers.

This app took a lot of inspiration from quisquous cactbot and uses the great sharlayan module from FFXIVAPP to process FFXIV's memory.

The changelog can be found here.

Die deutsche Version dieser Readme kann man hier finden.

Features
Installation
Updating Gobchat
How to use Gobchat
License

Features

Smart autoscroll

By moving the scroll bar up, autoscroll will be disabled for new messages and you can undisturbed (re)read text from the past.

By moving the scroll bar back to the bottom of the chat, autoscroll will be re-enabled!

Text formatting

Enhance your chat experience with colors! They make it easier to follow other people actions.

Will be turned into this:

Roleplay specific formatting

Gobchat applies specific colors to speech, emote and ooc comments

Text-Highlighting for key words - mentions

Case-insensitive detection for a customizable list of words, which then will be highlighted. This will help you not missing out on important messages.

Customizable formatting settings

Draggable and Resizeable

Click on the overlay to put the focus on it. By pressing and holding left-ctrl the drag- and resize-mode is activated. Indicated by a light, blue hue. To drag the overlay, simply press and hold your left mouse button and drag. To resize move your mouse to one of the four borders or corners of the overlay. The cursor will change, indicating the type of resizing. Now press and hold the left mouse button and resize.

Chat Log

Gobchat can write your chat history to a file, preserving informations you might want to look up later or just to reread fun moments. They can be found under AppData\Roaming\Gobchat.

Each time Gobchat is started it will create a new file. By default this feature is deactivated. If you want that Gobchat creates a log file, activate it in the settings.

Groups

The game allows you to sort players from your friend-list into seven predefined groups. Doing so, marks said players with a special icon in your chat, making it easier to keep track of them.

Gobchat includes these groups into its styling options and allows to create as many additional groups as you want. Each group can have a name, activated or deactivated, styled and keeps track of the players which belong to it. It's no longer required to add players to your friend-list, just to make it easier to see what they're writing.

Groups are sorted by importance. While a player can belong to multiple groups, only the style of the first matching group is applied. To change the order, just drag & drop the group to its new position.

Chat Commands

Gobchat accepts chat commands. To send a chat command to Gobchat, use the echo channel /e and type gc (short for Gobchat!). Example:

/e gc

Gobchat supports the following chat commands:

group

group

Usage:

/e gc group groupnumber add/remove/clear playername

This chat command can be used to manipulate a player group without using the config menu, for example via macros. To use the group command, type /e gc group.

Groupnumber is a number, starting from 1 and references the group you want to manipulate. The assigned number is identical to the position in the config menu..

Next is the task which should be performed. Possible values are add, remove and clear

clear

Doesn't need any additional arguments. This task will remove all players from a group. Example:

/e gc group 3 clear - will remove all players from group 3

add

Needs the full name of a player, which will be added to the group. Names are case-insensitive! When a player comes from a different server, it is also necessary to specify the server name in brackets. Placeholders like are an exception to this rule and will always be accepted.

Examples:

/e gc group 1 add M'aka Ghin / /e gc group 1 add firstname lastname
/e gc group 1 add M'aka Ghin[ultros] / /e gc group 1 add firstname lastname[servername]
/e gc group 1 add M'aka Ghin [ultros] / /e gc group 1 add firstname lastname [servername]
/e gc group 1 add <t>

remove

Needs the full name of a player, which will be removed to the group. Names are case-insensitive! When a player comes from a different server, it is also necessary to specify the server name in brackets. Placeholders like are an exception to this rule and will always be accepted.

Examples:

/e gc group 1 remove M'aka Ghin / /e gc group 1 remove firstname lastname
/e gc group 1 remove M'aka Ghin[ultros] / /e gc group 1 remove firstname lastname[servername]
/e gc group 1 remove M'aka Ghin [ultros] / /e gc group 1 remove firstname lastname [servername]
/e gc group 1 remove <t>

Installation

Dependencies

Install .NET Framework version 4.7.2 or above

Visual C++ Redistributable Packages Install redistributables x64 for 64-bit Windows Install redistributables x84 for 32-bit Windows

Installing Gobchat

Go to latest release
Download the latest version of Gobchat. The file is named gobchat-{version}.zip
Right click the zip file and go to properties. In the bottom right corner of the properties menu, click Unblock, and then "OK" to close the menu
Unzip the zip file to your prefered location. All files are already in a Gobchat folder.
Go into your Gobchat folder
Start Gobchat.exe
On start Gobchat will check for new updates
On the first start of Gobchat it will try to download CEF. CEF is a browser engine and runs Gobchats UI, which is written in HTML and Javascript

Updating Gobchat

For now the update process has to be done manually.

Repeat steps 1 to 4 of installing Gobchat and replace all files.
Done

How to use Gobchat

Running

Go into your Gobchat folder
Start Gobchat.exe
On start Gobchat checks for new updates

Within your tray a new icon will appear: This icon means Gobchat is running and looks for a active instance of FFXIV

If you are running FFXIV and Gobchat finds it, the icon will switch to , indicating that Gobchat is ready This may take a while on your first start of gobchat.

Tray Icon

Left click: Will show or hide the overlay
Right click: Will open a context menu

Closing

Right click the tray icon of Gobchat.
Click 'close'!

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License (AGPL-3.0-only) as published by the Free Software Foundation, version 3. You can find the full license here or at https://www.gnu.org/licenses/

suicidesin / gobchat Goto Github PK

gobchat's Introduction