Skip to content

Commit 4a87574

Browse files
authored
Feat: Add the reasons behind this fork
1 parent e34b7dc commit 4a87574

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

Diff for: README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,25 @@ All code credits go towards LOOHP, who has given permission for this fork to be
1616

1717
This fork also removes support for 1.21, 1.21.2 and 1.20.5.\
1818
1.20.5 was just a client update, and 1.21 contains bugs and exploits, so it is not recommended to use these versions.\
19-
1.20, 1.20.1, 1.20.2, 1.20.4, 1.20.6, 1.21.1, 1.21.3, 1.21.4 are still supported.
19+
1.20, 1.20.1, 1.20.2, 1.20.4, 1.20.6, 1.21.1, 1.21.3, 1.21.4 are still supported.\
20+
Additionally, this plugin will include the filtered messages from your chat plugin if supported.
2021

2122
> [!WARNING]
2223
> If you encounter bugs while using this fork, **do not report this to the original author!**\
2324
> You should create an issue for [this fork](https://github.com/TerraByteDev/MultiChat-DIscordSRV-Addon/issues).
2425
26+
## Why fork this?
27+
Yes, InteractiveChat can be, and is designed to, work alongside other chat plugins (e.g. ChatControl).\
28+
However, from what I've seen, InteractiveChat uses a not-insignificant portion of the server thread (TL;DR, it has caused lag in many cases).
29+
30+
Some of this has been addressed very recently, such as the previously-not-configurable fixed processing thread pool of **32 threads** however this will not do much.
31+
32+
Additionally, some will prefer having a plugin that hooks *directly* into their chat plugin!\
33+
Like mentioned before, this plugin also allows the messages that are passed through to DiscordSRV to be *filtered*.\
34+
In many cases, chat plugins will not edit the AsyncChatEvent when filtered, or will just cancel it. This results in one of two outcomes:
35+
1. The message is not sent at all to discord.
36+
2. The unfiltered message is sent to discord.
37+
2538
## Missing Features
2639
Right now, this fork does not support the following features (that the original plugin *does* support):
2740
- [ ] Proxy support

0 commit comments

Comments
 (0)