earu / easychat

A modular Garry's Mod chat addon for both users and developers. (EOL 2025)

IMPORTANT NOTE

EasyChat will reach its end of life on the 1st of January 2025. Beyond this point no support will be offered and no feature will be fixed or added. Feel free to fork and maintain your own version of this repository if you so wish.

An open-source advanced chat addon for users and developers.

Modular, fully customizable and developer-friendly. EasyChat provides a vast amount of features for both users and developers.

Contributing

Any contributions are welcome, please follow the naming conventions already present in the source code.

Details

• The Lua editor which was previously part of this repo has been moved here.

List of URLs & APIs used

Internals:

• https://api.github.com/repos/Earu/EasyChat/commits/master (version checking)
• https://raw.githubusercontent.com/Earu/EasyChat/master/external_data/transliteration_lookup.json (character lookup)
• https://raw.githubusercontent.com/Earu/EasyChat/master/external_data/steam_emoticons.txt (steam emotes)
• https://raw.githubusercontent.com/Earu/EasyChat/master/external_data/twemojis.json (twemoji emotes)
• https://raw.githubusercontent.com/Earu/EasyChat/master/external_data/twemojis.txt.lzma (twemoji emotes)
• http://3kv.in:9006/stats/submit (anonymous server stats)
• https://paypal.me/easychat (donations)

Unlikely to go down:

• http://steamcommunity-a.akamaihd.net/economy/emoticonhover/ (steam emotes)
• https://steamcommunity.com/profiles/%s (menus opening steam profiles)
• https://api.imgur.com/3/image.json (pasting images in the chat)
• https://fonts.googleapis.com/css2?family=Roboto:wght@400&display=swap (font)
• https://twemoji.maxcdn.com/v/latest/72x72/%s.png (twemoji emotes)
• https://translate.yandex.com/developers/keys (translation keys)
• https://translate.yandex.net/api/v1.5/tr.json/translate?key=%s&text=%s&lang=%s (translation)

Uncertain:

• https://api.betterttv.net/2/emotes (BTTV emotes)
• https://cdn.betterttv.net/emote/%s/3x (BTTV emotes)
• http://sprays.xerasin.com/gifinfo.php?url=%s (animated emotes)
• http://sprays.xerasin.com/getimage2.php?url=%s&type=vtf (animated emotes)
• https://api.frankerfacez.com/v1/set/global (FFZ emotes)

easychat's Issues

[easychat-master] HTTP failed - ISteamHTTP isn't available!

[easychat-master] HTTP failed - ISteamHTTP isn't available!
--
1200 | 1. Fetch - lua/includes/modules/http.lua:42
1201 | 2. unknown - addons/easychat-master/lua/easychat/unicode_transliterator.lua:25
1202 | 3. include - [C]:-1
1203 | 4. Init - addons/easychat-master/lua/easychat/easychat.lua:272
1204 | 5. fn - addons/easychat-master/lua/easychat/easychat.lua:291
1205 | 6. unknown - addons/ulib/lua/ulib/shared/hook.lua:109
1206 |  
1207 |  
1208 |  
1209 | [easychat-master] HTTP failed - ISteamHTTP isn't available!
1210 | 1. Fetch - lua/includes/modules/http.lua:42
1211 | 2. unknown - addons/easychat-master/lua/easychat/unicode_transliterator.lua:25
1212 | 3. include - [C]:-1
1213 | 4. Init - addons/easychat-master/lua/easychat/easychat.lua:272
1214 | 5. fn - addons/easychat-master/lua/easychat/easychat.lua:291
1215 | 6. unknown - addons/ulib/lua/ulib/shared/hook.lua:109

EasyChat Indicator doesn't activate

I have a Problem where I can't active to Indicate something or someone, if I try to activate it, it deacivates.

I have a Youtube Video where you can watch on what I mean:
https://youtu.be/6TuGUsLtV58

Unable to use ESC, console after attempting to enter chat.

My friend, after trying to talk in chat, got frozen up, with no ability to press ESC but only leave the game. I have no idea why that happens, but I can try to ask about the error dump.

Chat tags aren't rendered when chat is opened

Unsure if this is intended or not, but when I open the chat UI I see the following:
blobles: <color=153,0,0>test

But closed, it renders as blobles: test but with 'test' in a dark red, as intended. Running the most recent version.

Buttons to open chat are repeating

Everytime someone tries to press the button 'U' or 'Y' to open the chat, it automatically show up these letters,before typing anything. It's a little annoying to delete every single time these letters before type something...

ULIB/ULX Related Error

[ulib] lua/easychat/modules/cmds_auto_completion.lua:265: attempt to perform arithmetic on local 'arg_w' (a nil value)

1. fn - lua/easychat/modules/cmds_auto_completion.lua:265
2. unknown - addons/ulib/lua/ulib/shared/hook.lua:109 (x16)

Thanks for checking this out.

Cant click on links posted in the chat

Facepunch/garrysmod-issues#4358

Autocompletion handles uppercase in commands incorrectly

Probably no chat entry is matched with uppercase parts of the command.

Example code:

EasyChat.CmdSuggestions:AddSuggestionHandler("Example","/", {ABC = {}, ZABC = {}, Abc = {}, ZAbc = {}, Zabc = {}, abc = {}, zabc = {}})
(run with lua_run_cl)

Behaviour (all suggestions are in original order):

• When entry is /, suggestions are /ABC, /abc, /ZABC, /ZAbc, /Zabc, /abc, /zabc
• When entry is /a in any case, suggestions are /Zabc, /abc, /zabc (/ABC, /ZABC and /ZAbc are missing)
• When entry is /z in any case, suggestion is /zabc (/ZABC and /ZAbc are missing)
• When entry is /b in any case, suggestions are /Abc, /ZAbc, /Zabc, /abc, /zabc (/ABC, /ZABC and /ZAbc are missing)
• When entry is /c in any case, suggestions are /Abc, /ZAbc, /Zabc, /abc, /zabc (/ABC, /ZABC and /ZAbc are missing)
• When entry is /ab in any case, suggestions are /Zabc, /abc, /zabc (/ABC, /ZABC and /ZAbc are missing)
• When entry is /bc in any case, suggestions are /Abc, /ZAbc, /Zabc, /abc, /zabc (/ABC, /ZABC and /ZAbc are missing)
• When entry is /abc in any case, suggestion is /Zabc, /abc, /zabc (/ABC, /ZABC and /ZAbc are missing)

Use derma skin colors instead of defaulting to black when using "Use Derma Skin"

Themer users wouldnt be able to read text if they used a dark derma skin, which most users probably would.

Using polish characters

How can I enable writing characters like ś,ć,ą,...

Hey!

Hey I notice you're having issue with your workshop runner. You are running on windows, the latest one from 7 months ago ran properly on ubuntu.

Steam Profile Picture Support

This would be a great function to have!

Stronghold

[>KEKSQUAD|3|STEAM_0:1:23860033] Lua Error:
[ERROR] lua/easychat/modules/client/chatsoundsdocking.lua:10: attempt to index field 'StartChat' (a nil value)

1. fn - lua/easychat/modules/client/chatsoundsdocking.lua:10
2. Run - addons/ulib/lua/ulib/shared/hook.lua:109
3. ECOpen - lua/easychat/easychat.lua:252
4. fn - lua/easychat/easychat.lua:728
5. unknown - addons/ulib/lua/ulib/shared/hook.lua:109

Does this whenever a chat is opened/joining in.

easychat_only_local oversights

Mainly just greentext found so far but theres probably other text modifying modules that don't have checks

EZ Chat

EZ chat but no EZ linux/windows 64bit slog/gm_sourcenet . Could you possibly include a 64bit build ?

Time stamp is okay, but what about the time to the text stay in the chat?

Can you put a cvar and/or in the main menu to people modify the time the text stay in the chat before fade away? It would be helpful...

ChatHUD/Chat history seem to randomly break

text max width seemed to have lowered itself and sometimes froze the client for a bit

link parsing broke somehow, also froze client for a bit

Missing PM's tab also Position is too low for players joining.

Does this chatbox have a pms tab? Also, the chatbox's position is too low and gets cut off when players join.

Disable LUA window and simplify settings one

How can I do that ?

#breencast.br_overwatch07

Can't see other players' messages.

As per your request, I have opened the issue here.

I have used Addon Conflict Hooks Finder and have found nothing that could interfere with EasyChat.
If you know of any other ways to check for conflicts that don't involve deleting addons, I'm all ears.

notagain check breaks luatab when using stripped down notagain

Using a stripped down notagain version, such as the Metastruct fork for only chatsounds causes the luatab to break from assuming luadev loaded through notagain.

Auto-completion Lua Error

[ulib] lua/easychat/modules/cmds_auto_completion.lua:261: attempt to compare number with nil

1. fn - lua/easychat/modules/cmds_auto_completion.lua:261
2. unknown - addons/ulib/lua/ulib/shared/hook.lua:109 (x240)

Spams the console when you begin typing anything after !

RichNick returns SteamName and not player Nick which breaks DarkRP compatibility

In this commit e80bf9f all :Nick calls were changed to :RichNick.

DarkRP changes the players names in Nick, and by not using Nick, the chat will use players Steam names, and not their RP names.

For the purpose of this image, I set my RP name to "Test" with DarkRP.

But my name doesn't show up as Test in the Chat box when I speak.

Emoticon Code

Hi, it's me again :)
I looked at all the settings, but I couldn't find any disabling of displaying the code of the sent smiley in the chat. The smiley is displayed only when the chat window is closed, and if you open it, you can only see the code that really interferes.

Is it possible to fix this?
Thanks.

Ignore Module file incorrectly exploding

when you load module_ignore_list.txt the contents do not get exploded properly and shows as 1 item in the table

1	=	easychat/modules/client/voice_hud.lua
easychat/modules/indications.lua
easychat/modules/join_leave.lua

i believe this is due to the extra parameters passed into
local lines = ("\r?\n"):Explode(file_contents)
switching to
local lines = ("\n"):Explode(file_contents)
fixes the current problem of wanting to ignore multiple modules

how the contents in my module_ignore_list.txt are listed

easychat/modules/client/voice_hud.lua
easychat/modules/indications.lua
easychat/modules/join_leave.lua

I also have noticed when you have multiple modules ignored, the list in the easychat settings menu doesn't list them all, more than likely due to the same issue of not exploding the file properly

TextEntryX has poor performance when holding down keys

Starfall module Error

Due to my server not having starfall installed, there is a lua error everytime there its a chat message sent

lua/easychat/modules/client/starfall_compat.lua:19: attempt to index field 'SF' (a nil value)

hook.Add("ECPostAddText", TAG, function()
	_G.SF.runningOps = previous_ops_state
end)

This hook just needs a check for if "SF" is valid

For now I can just disable this module to fix it

chat.AddText disregards all arguments if one argument is nil

Really really long images crash

Culprit image: https://i.ibb.co/H78XxgG/fucked.png

how to hide the chatbox from easychat?

For programming how can i hide the chatbox so that no text popups? ( if someone sends you a text )

Sourcenet Requirement for EasyChat?

When I was launching a dedicated server, I saw a line saying that if I needed console command, sourcenet or slog was required to be installed. However, I followed the link to Sourcenet (gm_sourcenet) and couldn't find a way to install it. Could someone help me? Thanks!

EasyChat opens regardless of Wire keyboard input lock settings

EasyChat will open even when using a Wire keyboard with Lock player controls with keyboard option enabled

Yandex Translate API no longer gives free keys

The included auto-translator uses the Yandex translate API, of which the free service has been discontinued for users.

Perhaps switching to an alternative API is an option? I'm not familiar with translation APIs myself so I couldn't give any recommendations. I know this would probably mean rewriting the way the addon handles the translate requests, but I still think the translate feature is very useful to have, especially when integrated into the addon like it is.
Perhaps something along the lines of LibreTranslate would be preferable?
https://libretranslate.com/

EasyChat keeps reporting out of date even when updated.

Module disabling

Is it possible to disable modules using commands, or with code?

Error with starfall

Hello, when i trying to spawn a starfall chip he spawns but in console i see this error:
addons/easychat/lua/easychat/easychat.lua:755: Regex is too complex! 2 ext search length too long (500 max)
Starfall HUD enabled by licen777. NOTE: Type 'sf_hud_unlink' in the console to disconnect yourself from all HUDs.

Can you fix this please?

TODOs

General

• aowl/ULX auto-complete (help?) support (reference here)
• built-in color sets for customization
• auto-translation of messages in the chat (ex: ru -> en)
• settings pos x, y and width of chathud
• [ ] setting to show player avatars
• team server configuration (should override client setting?) (reference here)
• rate-limiting messages (anti-spam) @Python1320
• auto-completion peeking (preview)
• color picker
• make sure not to show auto-completion for commands if FAdmin is detected
• add a way to add words that mention you (mention filter?)

Admin & DM Tabs

• [ ] rework/merge into a more advanced "chatrooms" tab where admins is a default chatroom
• DarkRP admin chat needs to be routed into the admin chat tab

"False" together with the text

Hello, I installed this addon with the version from July 26 and I had a problem with the chat.
When sending any text to the general ('say') chat, the inscription "false" appears before my text. I tested it with the original gmod chat and there was no such problem. Also, if I send the text in the "admins" tab, then there is also no such problem there.

I looked through the code, but also didn't find anything. I hope you can help :)

Legacy Richtext links goes to the previous link

Exploit causes client crashes

Hello,

Someone joined my server and entered this into the chat, which caused all clients to disconnect and they were unable to reconnect until the server was restarted.

<font=BigChatText>: <translate=rand(-500,500), rand(-500,500)>JEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISHJEWISH

Murder

Can u fix it for murder?
https://i.imgur.com/xQXmVba.gif

Please add a PM tab asap

I will pay you if necessary. We just need PM capability as soon as possible.

server_config.lua:247: attempt to call field 'GetTab' (a nil value)

[EasyChat] lua/easychat/server_config.lua:247: attempt to call field 'GetTab' (a nil value)

1. process_tabs_config - lua/easychat/server_config.lua:247
2. func - lua/easychat/server_config.lua:277
   3. unknown - lua/includes/extensions/net.lua:32

This was displayed in my RCON window for my server. I unfortunately do not have repro steps available at this time.

Wrong Wiki entry

ECOpenURL´s Argument should only the player but your code says its thats the url
Is that correct or am i just stupid?

Colors

How can i disable colors for all players except admins/mods/higher priority users?

Question about net

Why use sourcenet vs other net libraries? Sourcenet helps handle stuff like net.receive and net.send right ? Why use something with no documentation? WHY

URLs in chat

For some reason, sending links in chat as a random chance of crashing people's games.

Would there be a way to implement a convar to disable image embed'ing entirely? instead of forcing the convar of people's games to disable clientside?

I currently force this to be false to fix, but when you guys update the file again, i have to re-patch it

EasyChat/lua/easychat/easychat.lua

Line 1540 in de9c17a

if is_image_url(url) then

Make command autocomplete more of an API

Would be nice to have an API for admin mods and what not to add to instead of hardcoding every single admin mod into the base or doing "hacks" to be identified as another admin mod.

ECPostLoadModules.EasyChatDefaultSettings fails and errors

[Hook] ECPostLoadModules -> "EasyChatDefaultSettings" failed: addons/easychat/lua/easychat/client/settings.lua:812: attempt to index global 'settings' (a nil value)
stack traceback:
	addons/easychat/lua/easychat/client/settings.lua:812: in function 'add_legacy_settings'
	addons/easychat/lua/easychat/client/settings.lua:818: in function 'func'
	addons/srvaddons/lua/notagain/essential/postinit/hook_overwrites.lua:195: in function <addons/srvaddons/lua/notagain/essential/postinit/hook_overwrites.lua:181>
	[C]: in function 'xpcall'
	addons/srvaddons/lua/notagain/essential/postinit/hook_overwrites.lua:237: in function <addons/srvaddons/lua/notagain/essential/postinit/hook_overwrites.lua:221>
	[C]: in function 'xpcall'
	addons/easychat/lua/easychat/easychat.lua:106: in function 'safe_hook_run'
	addons/easychat/lua/easychat/easychat.lua:2014: in function 'Init'
	addons/easychat/lua/easychat/easychat.lua:2395: in function <addons/easychat/lua/easychat/easychat.lua:2393>