Skip to content

Commit

Permalink
Improvements to the Readme (#469)
Browse files Browse the repository at this point in the history
* Update README.md

* Update en_us.json

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update en_us.json

* Update de_de.json

* Update README.md

* Update README.md

* Update README.md

* Update README.md
  • Loading branch information
christopherplaysminecraft authored Apr 11, 2024
1 parent 644bb6b commit 6290333
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 18 deletions.
50 changes: 34 additions & 16 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,53 @@

<a href="https://www.curseforge.com/minecraft/mc-mods/no-chat-reports"><img alt="curseforge" height="28" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/available/curseforge_vector.svg"></a> <a href="https://modrinth.com/mod/no-chat-reports"><img alt="modrinth" height="28" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/available/modrinth_vector.svg"></a> <a href="https://github.com/Aizistral-Studios/No-Chat-Reports"><img alt="github" height="28" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/available/github_vector.svg"></a> <a href="https://gitlab.com/Aizistral-Studios/No-Chat-Reports"><img alt="gitlab" height="28" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/available/gitlab_vector.svg"></a>

This mod strips cryptographic signatures that since 1.19 are attached to every message sent in the chat. Removing them makes it impossible to track and associate your chat messages with your Minecraft and, by extension, Microsoft account.
This mod strips cryptographic signatures which are attached to every chat message sent from 1.19 and onwards. Removing them makes it impossible to track and associate your chat messages with your Minecraft client, and, by extension, Microsoft account.

**As of 1.19.1, it also disables Player Chat Reporting.**
**As of 1.19.1, it also disables Player Chat Reporting**

Please notice that, while I am aware of [Guardian](https://github.com/nodusclient/guardian) and certain other exploits that allow you to counteract reporting system on client against the will of the server, I am consciously choosing to not integrate them as part of this mod. No Chat Reports will remain effective on client side only if given server allows it to be. If you do not like servers that enforce chat signing and fully support chat reporting - I advise to simply not play on them.
Please notice that, while I am aware of [Guardian](https://github.com/nodusclient/guardian) and certain other exploits that allow you to counteract reporting systems on the client against the will of the server, I am consciously choosing to not integrate them as part of this mod. No Chat Reports will only remain effective on the client side if the server allows it to be. If you do not like servers that enforce chat signing and fully support chat reporting - I advise to simply not play on them.

Also, while there are many plugins out there that "borrow" the name and even icon of my mod, please be aware that **I have not authored any of them** and cannot say how well they do their job.

## Installation and Use:
Also, while there are many plugins out there that "borrow" the name and even icon of NoChatReports, please be aware that **I have not authored any of them** and cannot say how well they do their job.

This mod supports both Forge and Fabric, just download the version for respective modloader. It can be installed on either client, server, or both sides, and will function differently depending on which sides it is present at:
## Installation and Usage:

**1. Only Client:** Client will refuse to send account's public key to the server, and signatures will be stripped from the messages that you send. This way it won't be useful to try and report your messages, as there will be no proof they were actually sent from your account. Server will relay them unless `enforce-secure-profile` option is set to true in server options (which it is by default since 1.19.1), in which case you will not be able to join, unless you agree to send signed messages (the mod will supply warning screen);
NoChatReports supports both Fabric and Forge, just download the version for your respective modloader and game version. It can be installed on either the client, server, or on both sides, and will function differently depending on which sides it is present on:

**2. Only Server:** Clients will still attach signatures when sending messages to the server, but server will strip them before relaying them to other players. This way chat reporting will not work for any players that join. You can enable player to system message conversion in config, to prevent players without the mod from seeing them as "Not Secure"
**1. Only Client:** The client will refuse to send the account's public key to the server, and signatures will be stripped from the messages that you send. This way it won't be useful to try and report your messages, as there will be no proof that they were actually sent from your account. The server will relay them unless the `enforce-secure-profile` option is set to `true` in the `server.properties` file (which it is by default since 1.19.1)

**3. Both Client and Server:** Signature will be stripped on client side before sending messages to server, server will make no attempt to verify message signatures. Chat reporting and "Only Show Secure Chat" will not function, and players will be notified that those features are disabled by the mod when trying to use them.
If the server does require you to sign messages and you are on either 1.19.1 or 1.19.2, you will not be able to join the server unless you agree to send signed messages (NoChatReports will supply a warning screen), if you are on 1.19.3 or higher, you will still be able to join the server, but will not be able to use chat-related commands (other commands do still work)

Although the mod can function when present on only one of the sides, it can be configured to demand itself to be installed on another side in order to play. This way you can install it on server and require all clients that join to have this mod in order to have full functionality, but can also leave it server-only if you prefer. Configuration files are located in <u>NoChatReports</u> subfolder of default config folder.
**2. Only Server:** Clients will still attach signatures when sending messages to the server, but the server will strip them before relaying them to other players. This way chat reporting will not work for any players that join. You can enable the conversion of player to system messages in the config, to prevent players without the mod from seeing them as "Not Secure"

Additionally, if installed on client, this mod will disable telemetry (similarly to how [No Telemetry](https://modrinth.com/mod/no-telemetry) does).
As of 1.20.2 the server cannot disable the "unsigned messages" warning on the client. It can only be disabled if the client has NoChatReports (or a similar mod) installed.

To make Velocity compatible with this mod, set `force-key-authentication = false` in `velocity.toml`. Thanks to [MrMelon54](https://github.com/MrMelon54) for pointing this out.
**3. Both Client and Server:** Signatures will be stripped on the client side before sending messages to the server, which will not attempt to verify message signatures. Chat reporting and "Only Show Secure Chat" will not function, and players will be notified that those features are disabled by the mod when trying to use them.

Although NoChatReports can function when it is only present on one of either sides, NoChatReports can be configured to demand itself to be installed on the respective other side in order to play. This way you can install it on the server and require all clients that join to have NoChatReports installed, but you can also leave it server-only if you prefer.

Additionally, if installed on the client, NoChatReports will disable Telemetry (similar to what [No Telemetry](https://modrinth.com/mod/no-telemetry) does).

To make sure that your server is compatible with NoChatReports, you can take a look at [this part of the wiki](https://github.com/Aizistral-Studios/No-Chat-Reports/wiki/Protecting-Server-Players).

## Configuration

The configuration files are located in the `NoChatReports` subfolder of the default config folder.

`NCR-Client.json` stores Client-Side settings

`NCR-Common.json` stores Server-Side settings

`NCR-Encryption.json` stores Chat Encryption settings (Only effective on the client)

`NCR-ServerPreferences.json` stores Per-Server Signing Modes

You can find more information [here](https://github.com/Aizistral-Studios/No-Chat-Reports/wiki/Configuration-Files/).

## Chat Encryption
I have put together a video dedicated to chat encryption, you can watch it to learn how to use it (and whether you should): https://www.youtube.com/watch?v=e7RzNP32k-s
I have put together a video dedicated to Chat Encryption, watching it will help you to learn how it is used (and whether you should): https://www.youtube.com/watch?v=e7RzNP32k-s

## Documentation:
You can find documentation and other information relevant to this mod on the [wiki](https://github.com/Aizistral-Studios/No-Chat-Reports/wiki/). It currently features following articles:
You can find documentation and other information relevant to this mod on the [wiki](https://github.com/Aizistral-Studios/No-Chat-Reports/wiki/). It currently features the following articles:
- [Configuration Files](https://github.com/Aizistral-Studios/No-Chat-Reports/wiki/Configuration-Files/)
- [Protecting Server Players](https://github.com/Aizistral-Studios/No-Chat-Reports/wiki/Protecting-Server-Players/)
- [How to Get Safe Server Status](https://github.com/Aizistral-Studios/No-Chat-Reports/wiki/How-to-Get-Safe-Server-Status)
Expand All @@ -40,7 +58,7 @@ You can find documentation and other information relevant to this mod on the [wi


## For Developers:
If you develop your own mod, plugin or other server software that in some way prevents chat reports, you can make No Chat Reports on client recognize servers with your software as safe. I wrote [a small article about this](https://github.com/Aizistral-Studios/No-Chat-Reports/wiki/How-to-Get-Safe-Server-Status). For clarification or further inquiries - contact me via Discord, link in "External resources".
If you develop your own mod, plugin or other server software that in some way prevents chat reports, you can make clients with No Chat Reports installed recognize servers running your software as safe. I wrote [a small article](https://github.com/Aizistral-Studios/No-Chat-Reports/wiki/How-to-Get-Safe-Server-Status) about this. For clarification or further inquiries - contact me via Discord, link in "External resources".

## Reasoning:
See my videos for an explanation of how message signatures and chat reporting work in the game, their failures and the reasoning behind the creation of this mod:
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/assets/nochatreports/lang/de_de.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"modmenu.descriptionTranslation.nochatreports": "Entfernt kryptographische Signaturen von Chatnachrichten, sodass sie nicht nachverfolgt oder mit deinem Mojang/Microsoft-Account in Verbindung gebracht werden können, wodurch sie nicht an Mojang gemeldet werden können.",
"modmenu.descriptionTranslation.nochatreports": "Entfernt kryptographische Signaturen von Chatnachrichten, sodass sie nicht nachverfolgt oder mit deinem Microsoft-Account in Verbindung gebracht werden können, wodurch sie nicht an Mojang gemeldet werden können.",
"key.nochatreports.ctrl": "Strg",
"key.nochatreports.cmd": "Cmd",
"gui.nochatreports.secure_chat": "Diese Option kann nicht mit No Chat Reports verwendet werden, da keine Signaturen zum Verifizieren vorhanden sind.",
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/assets/nochatreports/lang/en_us.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"modmenu.descriptionTranslation.nochatreports": "Strips cryptographic signatures from player messages, making it impossible to track and associate them with your Mojang/Microsoft account, as well as to use the Player Chat Reporting feature.",
"modmenu.descriptionTranslation.nochatreports": "Strips cryptographic signatures from player messages, making it impossible to track and associate them with your Microsoft account, as well as to use the Player Chat Reporting feature.",
"key.nochatreports.ctrl": "Ctrl",
"key.nochatreports.cmd": "Cmd",
"gui.nochatreports.secure_chat": "This option cannot work with No Chat Reports, since there are no signatures to verify.",
Expand Down

0 comments on commit 6290333

Please sign in to comment.