https://github.com/litermc/miss
A Mod that forward Minecraft connection on websocket
https://github.com/litermc/miss
minecraft minecraft-mod websocket
Last synced: 2 months ago
JSON representation
A Mod that forward Minecraft connection on websocket
- Host: GitHub
- URL: https://github.com/litermc/miss
- Owner: LiterMC
- License: gpl-3.0
- Created: 2025-01-26T16:20:54.000Z (over 1 year ago)
- Default Branch: 1.19.2
- Last Pushed: 2025-02-21T21:45:07.000Z (over 1 year ago)
- Last Synced: 2025-04-10T02:54:56.327Z (about 1 year ago)
- Topics: minecraft, minecraft-mod, websocket
- Language: Java
- Homepage:
- Size: 504 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MISS
[](https://modrinth.com/mod/miss)
[](https://github.com/LiterMC/MISS/)
[](LICENSE)
MISS uses WebSocket to forward your Minecraft connection.
## Features
- Support Websocket protocol on both client and server
- Use same port on the server to detect WebSocket connection
## Reqirements
- Minecraft JE 1.19+
- Nginx 1.18+ (optional)
- SSL certificate (optional)
- Java 17+
## Install
#### Server side
1. Download from [Modrinth](https://modrinth.com/mod/miss/versions)
2. Put the mod into `mods` folder
3. Restart Minecraft server
#### Client side
1. Download from [Modrinth](https://modrinth.com/mod/miss/versions)
2. Put the mod into `mods` folder
3. Restart Minecraft client
## Nginx Configuration
Example:
```nginx
server {
listen 443 ssl;
server_name mc.example.com;
ssl_certificate /path/to/fullchain.pem;
ssl_certificate_key /path/to/privkey.pem;
# You also can forward different paths to different servers
location / {
proxy_pass http://ip_or_hostname:25565;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "Upgrade";
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
}
```
## How to connect
1. Input `wss://mc.example.com` to the `Server Address` bar
2. Join the server
---
# MISS
MISS 是一个 Minecraft 模组，用于通过 WebSocket 转发 Minecraft 连接。这使得你可以通过 WebSocket 协议连接到 Minecraft 服务器，提供了一种新的网络传输方式。
## 功能特性
- 通过 WebSocket 协议转发 Minecraft 连接。
- 支持 Minecraft 客户端与服务器之间的双向通信。
## 前置要求
- Minecraft Java 版 1.19+
- Nginx 1.18+
- 有效域名与SSL证书 (可选)
- Java 17+
## 模组安装
#### 服务端
1. 从 [Modrinth](https://modrinth.com/mod/miss/versions) 下载对应版本
2. 将文件放入服务端 `mods` 目录
3. 重启 Minecraft 服务器
#### 客户端
1. 从 [Modrinth](https://modrinth.com/mod/miss/versions) 下载对应版本
2. 将文件放入客户端 `mods` 目录
3. 启动 Minecraft 客户端
## Nginx配置
反向代理服务器配置示例：
```nginx
# 假设用户访问的域名是 mc.example.com，且已申请 SSL 证书
server {
listen 443 ssl;
server_name mc.example.com;
ssl_certificate /path/to/fullchain.pem;
ssl_certificate_key /path/to/privkey.pem;
# 该 location 其实也可以使用不同的 path 转发到不同的服务器
location / {
proxy_pass http://ip:25565; # 转发 Minecraft 服务器的地址（可以是域名或IP）
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "Upgrade";
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
}
```
请根据实际情况修改配置文件中的域名和证书路径。
## 如何连接服务器
1. 安装客户端 MOD 后
2. 启动游戏
3. 添加服务器并在地址栏输入：
`wss://mc.example.com`
4. 点击"加入服务器"按钮
## 注意事项
- 确保443端口已打开，且你的服务器支持 WebSocket 协议。
- 确保你的 Minecraft 服务器配置允许通过 WebSocket 连接。
- 使用此模组时，请确保你的网络环境支持 WebSocket 协议。