中文说明请点这里 (Chinese README)

ws2tcp

ws2tcp is a Fabric-based Minecraft client mod that allows players to connect to Minecraft servers via the WebSocket protocol. This mod is useful for scenarios where you need to access servers through a WebSocket proxy, such as cloud gaming, CDN, or NAT traversal.

Features

• Proxy local port 25565 to a specified WebSocket address
• Automatically read and save proxy configuration
• Automatically add the local proxy server to the server list
• Simple graphical interface with multi-language support (English and Simplified Chinese)

Installation

1. Requirements

   • Minecraft 1.21.4
   • Fabric Loader 0.16.12 or above

2. Install the Mod

   • Download the built ws2tcp jar file
   • Place it into your .minecraft/mods/ directory

3. Start the Game

   • Launch the Minecraft client as usual

Usage

1. Go to the Multiplayer screen and click the "Enable WebSocket Proxy" button
2. Enter the WebSocket server address (e.g., example.com:8080) and click "Done"
3. After the proxy starts, a local server (127.0.0.1:25565) will be automatically added to your server list
4. You can stop the proxy at any time via the interface

Configuration

• Config file path: config/ws2tcp-client.properties
• You can edit it manually or generate it via the GUI

Language Support

• Supports Simplified Chinese (zh_cn) and English (en_us)
• Automatically switches based on the game language

FAQ

• Error when loading on server
  This mod is client-side only. It will automatically exit if loaded on a server.

Development & Building

1. Clone this repository
2. Open with IDEA or VSCode, ensure you have JDK 21
3. Build with:

   ./gradlew build
   

4. The built jar will be in build/libs/

License

This project is licensed under the Apache-2.0 License.

---

Feel free to submit issues or pull requests if you have questions