Skip to content

Latest commit

 

History

35 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mc-skin-wrap-http-server

MC Skin Wrap

轻量级 HTTP 服务器,封装 Minecraft 皮肤/头像/服务器状态 API,适合自建代理服务。

🎯 目标用户: 大陆开发者 or Minecraft玩家 等。 (因为海外用户可直接调用原始 API,无需本项目

GitHub Gitee

Windows x64 | ARM64 Linux x64 | ARM64 macOS x64 | ARM64

💬 使用问题 / 🐛 Bug反馈 / 👨‍💻 开发交流,聊天吹水,欢迎加入QQ群:259248174 🎉(这个群G了

💬 使用问题 / 🐛 Bug反馈 / 👨‍💻 开发交流,聊天吹水,欢迎加入QQ群:1085190201 🎉

💡 在群里直接艾特我,回复的更快哦~ ✨

🚀 简介

MC Skin Wrap 是一个简单的 HTTP 服务器,封装了常用的 Minecraft 相关 API,提供统一接口:

返回示例:

🎭 玩家头像 🧥 玩家皮肤 📊 服务器状态
avatar skin server_status

💡 使用场景举例

把这个服务部署到阿美莉卡 or 其他海外地区的 VPS 上,然后让你的前端网页机器人插件来调用——一个方便的代理,绕过墙或简化 API 访问。

💡 国内也能用! 本项目支持在 config.json 中配置代理,支持 http / https / socks4 / socks5 / socks5h 协议,在国内直接跑也没问题~

典型场景:

  • 你有一个前端网站或 Koishi/Discord 机器人插件
  • 你需要获取 MC 玩家头像/皮肤,或者查询 Java 服务器状态
  • 直接调用 API 在你的网络环境下很慢或被墙
  • → 把 MC Skin Wrap 部署到海外服务器,作为统一的 API 网关调用!

✨ 主要特性

  • 双实现版本
    • Go 版: 高性能、低内存占用、单二进制文件 — 推荐生产环境使用
    • Python 版: 易于修改和扩展 — 适合原型开发和演示
  • 跨平台: Windows、Linux、macOS(x64 & ARM64)。
  • 代理支持: 可选 HTTP/SOCKS5 代理用于上游请求。
  • Swagger 文档: 内置 API 文档(Go 版)。
  • 可配置: JSON 配置文件,支持 host、port、root path、代理等。

📖 开发文档

💡 开发者/部署者: 想了解如何构建、测试或调试?请查阅对应文档:

文档 说明
【📘 Go 开发指南】doc/dev.go.md 构建、测试、Swagger 文档生成、一键 curl 测试命令
【📗 Python 开发指南】doc/dev.py.md 环境搭建、快速启动、一键 curl 测试命令
【📙 Git 操作指南】doc/dev.git.md 生产环境同步、常用命令
【🚀 Go 生产部署指南】doc/prod.go.md 安装脚本、screen 后台、Nginx 反代 + CORS 踩坑

🌐 在线体验

🎉 懒得自己部署? 直接用作者的公开接口试试吧~

(2RMB/月的小鸡,上面没别的东西,被打了就打了,就当玩了 😂)

✨ 开源代码不够,还免费提供公开接口 —— 如此慷慨的作者,不来个 ⭐ Star 说不过去吧?

🖥️ 2RMB/月的 狐蒂云 小鸡,到期时间:2026-08-19 18:29

📢 怕作者忘记续费?欢迎在 Issue 或 QQ 群里提醒我续费~ (防止自己忘记捏 😋)

① 狐蒂云 (已失效 — 服务商跑路了)

接口 在线地址
🎭 玩家头像 hidden
🧥 玩家皮肤 hidden
📊 服务器状态 hidden
📚 Swagger 文档 hidden

② 腾讯 EdgeOne CDN 加速 — 全球节点 + 边缘缓存 (已失效 — 服务商跑路了)

接口 在线地址
🎭 玩家头像 https://eo-us-hudiyun.vincentzyu233.cn/nginx_gin_skin/gin_skin_wrap/mcjava/avatar/VincentZyu
🧥 玩家皮肤 https://eo-us-hudiyun.vincentzyu233.cn/nginx_gin_skin/gin_skin_wrap/mcjava/skin/VincentZyu
📊 服务器状态 https://eo-us-hudiyun.vincentzyu233.cn/nginx_gin_skin/gin_skin_wrap/mcjava/server_status/bc.vincentzyu233.cn
📚 Swagger 文档 https://eo-us-hudiyun.vincentzyu233.cn/nginx_gin_skin/gin_skin_wrap/docs/index.html

⚠️ EdgeOne 线路的 Swagger 文档好像有点问题,懒得修了,反正其他两个线路的文档能用 😂~~

③ Cloudflare CDN — 隐藏源站 IP + DDoS 防护 + 缓存 (已失效 — 服务商跑路了)

接口 在线地址
🎭 玩家头像 https://cf-us-hudiyun.vincentzyu233.cn/nginx_gin_skin/gin_skin_wrap/mcjava/avatar/VincentZyu
🧥 玩家皮肤 https://cf-us-hudiyun.vincentzyu233.cn/nginx_gin_skin/gin_skin_wrap/mcjava/skin/VincentZyu
📊 服务器状态 https://cf-us-hudiyun.vincentzyu233.cn/nginx_gin_skin/gin_skin_wrap/mcjava/server_status/bc.vincentzyu233.cn
📚 Swagger 文档 https://cf-us-hudiyun.vincentzyu233.cn/nginx_gin_skin/gin_skin_wrap/docs/index.html
~~

④ 阿里云 — Nginx + Let's Encrypt(无 CDN)

接口 在线地址
🎭 玩家头像 hidden
🧥 玩家皮肤 hidden
📊 服务器状态 hidden
📚 Swagger 文档 hidden

⑤ 腾讯 EdgeOne CDN 加速 — 全球节点 + 边缘缓存

接口 在线地址
🎭 玩家头像 https://eo-sh-xwl.vincentzyu233.cn/nginx_gin_skin/gin_skin_wrap/mcjava/avatar/VincentZyu
🧥 玩家皮肤 https://eo-sh-xwl.vincentzyu233.cn/nginx_gin_skin/gin_skin_wrap/mcjava/skin/VincentZyu
📊 服务器状态 https://eo-sh-xwl.vincentzyu233.cn/nginx_gin_skin/gin_skin_wrap/mcjava/server_status/bc.vincentzyu233.cn
📚 Swagger 文档 https://eo-sh-xwl.vincentzyu233.cn/nginx_gin_skin/gin_skin_wrap/docs/index.html

三种接入方式对比:

特性 ① 直连 ② EdgeOne ③ Cloudflare
SSL 证书 Let's Encrypt (自管) EdgeOne 托管 CF 自动签发
CDN 缓存 ✅ 图片缓存 30 天 ✅ 静态资源自动缓存
隐藏源站 IP
DDoS 防护 ✅ 基础防护 ✅ 基础防护
大陆加速 ✅ 全球节点(含亚太) ⚠️ 免费版无大陆节点
海外加速
配置复杂度 Nginx + certbot 需配置回源 + 证书 一键开橙色云

💡 推荐: 大陆用户优先使用 ② EdgeOne 线路;海外用户三条线路体验接近。

📦 快速开始

🐧 Linux 一键部署(推荐)

在你的海外 Linux 服务器上执行:

# 直接安装最新版(GitHub)
curl -fsSL https://raw.githubusercontent.com/VincentZyuApps/mc-skin-wrap-http-server/main/doc/scripts/install.sh | bash

# 安装指定版本
MC_SKIN_WRAP_VERSION=v0.0.2-beta.5 bash -c "$(curl -fsSL https://raw.githubusercontent.com/VincentZyuApps/mc-skin-wrap-http-server/main/doc/scripts/install.sh)"

🇨🇳 国内 Gitee 镜像(大陆用户推荐):

# 从 Gitee 安装
curl -fsSL https://gitee.com/vincent-zyu/mc-skin-wrap-http-server/raw/main/doc/scripts/install_gitee.sh | bash

# 安装指定版本
MC_SKIN_WRAP_VERSION=v0.0.2-beta.5 bash -c "$(curl -fsSL https://gitee.com/vincent-zyu/mc-skin-wrap-http-server/raw/main/doc/scripts/install_gitee.sh)"

脚本会自动检测系统架构 (x64/ARM64),显示最近 10 个可用版本,交互式引导安装。

💡 想要自己搭建生产环境(Nginx 反代 + HTTPS + CDN 加速)? 参考 生产部署指南 →

Go 版本(推荐生产环境)

# 从 Releases 下载并解压,然后:
cd mc-skin-wrap_<version>_<os>_<arch>

# 按需编辑 config.json
./mc-skin-wrap-go        # Linux/macOS
./mc-skin-wrap-go.exe    # Windows

💡 保持后台运行: Linux/macOS 推荐使用 screentmux 挂在后台;Windows 保持 CMD / PowerShell 窗口开着即可。

Python 版本(用于原型开发)

cd py

# 安装依赖,推荐使用uv:
uv venv --python 3.12
uv pip install -r requirements.txt

# 运行
uv run python main.py

🔗 API 端点

端点 描述
GET /mcjava/avatar/{name} 获取玩家头像 (PNG)
GET /mcjava/skin/{name} 获取玩家皮肤 (PNG)
GET /mcjava/server_status/{addr} 获取 Java 服务器状态 (JSON)
GET /docs/ Swagger UI (Go: gin-swagger, Python: FastAPI 自带)

⚙️ 配置说明

编辑 config.json

{
  "host": "0.0.0.0",
  "port": 60311,
  "root_path": "/gin_skin_wrap",
  "cors_allow_origins": ["*"],
  "proxy_enabled": false,
  "proxy_protocol": "http",
  "proxy_host": "127.0.0.1",
  "proxy_port": 7890,
  "log_level": "info"
}

反向代理部署时,Nginx 需要额外透传 X-Forwarded-HostX-Forwarded-ProtoX-Forwarded-Prefix,这样 Go 版 Swagger UI 的 Try it out 才会自动拼出正确的外部 URL。

📁 项目结构

mc-skin-wrap-http-server/
├── assets/             # 🎨 项目资源 (favicon 等)
│   ├── favicon.ico
│   ├── gen_favicon.sh
│   └── VincentZyu.Minecraft.png
├── go/                 # 💙 Go 版本 (生产环境推荐)
│   ├── main.go
│   ├── build.py        # 交叉编译脚本
│   ├── local_dev.py    # 本地开发辅助
│   ├── config.example.json
│   ├── go.mod
│   ├── go.sum
│   └── docs/           # Swagger 生成文件
│       ├── docs.go
│       ├── swagger.json
│       └── swagger.yaml
├── py/                 # 🐍 Python 版本 (原型演示)
│   ├── main.py
│   ├── local_dev.py    # 本地开发辅助
│   ├── config.example.json
│   ├── requirements.txt
│   └── favicon.ico
├── doc/                # 📖 开发文档
│   ├── dev.go.md
│   ├── dev.py.md
│   ├── dev.git.md
│   ├── prod.go.md
│   └── scripts/        # 一键安装脚本
│       ├── install.sh
│       └── install_gitee.sh
└── dist/               # 📦 构建产物

About

🎮 Minecraft Java版 皮肤/头像/服务器状态 API 代理 · 🇨🇳 大陆加速 · 💙Go+🐍Py 双版本 · 📦 Win/Linux/macOS

Resources

Stars

5 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages