Skip to content

Commit 770dc17

Browse files
committed
docs: improve project description for clarity and safety
1 parent 383cff2 commit 770dc17

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,51 @@
11
# NetUtils
22

3-
> **This tool is for educational and debugging purposes only.** Using it to gain an unfair advantage or perform exploits (such as item duplication) on multiplayer servers is a violation of most server rules and platform terms of service. The developers do not condone cheating/duping. Use this mod at your own risk and only where you have explicit permission.
3+
A powerful networking utility for Minecraft protocol debugging, state synchronization testing, and network analysis. Built on the Architectury API for **Fabric** and **NeoForge**.
44

5-
A networking utility for protocol debugging and state synchronization testing.
5+
> [!WARNING]
6+
> **This tool is for educational and debugging purposes only.** Using it to gain an unfair advantage or perform exploits on multiplayer servers is a violation of most server rules and platform terms of service. The developers do not condone cheating/duping. Use this mod at your own risk and only where you have explicit permission.
67
7-
<img width="1365" height="697" alt="image" src="https://github.com/user-attachments/assets/b84ae327-eb51-4112-ab92-cca66619e079" />
8+
---
89

10+
## What specifically does this project provide?
911

12+
NetUtils adds a comprehensive suite of client-side debugging tools that allow you to interact with the Minecraft networking layer in ways the vanilla client cannot:
13+
14+
- **Packet Flow Control**: Intercept, delay, or completely toggle outgoing packets to test server-side response times and handling.
15+
- **Inventory State Manipulation**: Experiment with client-server desynchronization (e.g., closing screens locally without notifying the server) to test state handling logic.
16+
- **Detailed Data Extraction**: View internal menu information (Sync IDs, Class names), list villager trades with internal IDs, and inspect GUI slot metadata.
17+
- **Resource Pack Management**: Bypass or force-deny server-requested resource packs for testing environment isolation.
18+
- **Enhanced Client-Side Commands**: A custom command system (using the `^` prefix) for low-level interaction, including raw packet sending and loop execution.
19+
20+
## Why should you use NetUtils?
21+
22+
- **Mod & Plugin Development**: If you are developing a mod or server plugin that relies on complex inventory or networking logic, NetUtils is an invaluable tool for stress-testing your code against "illegal" or unexpected client states.
23+
- **Protocol Education**: Perfect for developers and researchers who want to understand the Minecraft networking protocol by observing and manipulating packets in real-time.
24+
- **Network Resilience Testing**: Use the desynchronization and packet delay features to verify that your server's anti-cheat or state-recovery systems are robust.
25+
26+
## Critical Information & Safety
27+
28+
- **Clean & Transparent**: This project is maintained as a safe, open-source alternative to historical versions of similar utilities (like UIUtils v1.0.2) which were known to contain security vulnerabilities.
29+
- **Multiplayer Usage**: Using this on public servers will likely result in a permanent ban. It is intended for use in private development environments.
30+
- **Compatibility**: Requires **Minecraft 1.21.11** and the **Architectury API**.
31+
32+
---
1033

1134
## Features
35+
1236
- **Packet Control**: Delay or toggle outgoing packets.
1337
- **Synchronization**: Simulate client-server desynchronization for state handling tests.
1438
- **Inventory Control**: Close inventory screens without sending packets to the server.
1539
- **Resource Pack Control**: Bypass or force-deny server resource packs.
1640

1741
## Usage
42+
1843
Press **V** to restore the last closed screen.
1944

2045
## Client Commands
46+
2147
All commands use the `^` prefix and can be typed in regular chat or the custom chat input field.
48+
2249
- `^help` - Show all commands
2350
- `^toggle` - Enable/disable mod features
2451
- `^menuinfo` - Display GUI info (class, slots, sync ID)
@@ -33,11 +60,13 @@ All commands use the `^` prefix and can be typed in regular chat or the custom c
3360
- `^save`/`^load` - Save or restore the current screen state
3461

3562
## Building
63+
3664
Run the following command to build for both Fabric and NeoForge:
3765
```bash
3866
./gradlew collectJars
3967
```
4068
The output jars will be in `build/libs/`.
4169

4270
## License
71+
4372
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)