GrzybcioRynekWeb
HTTP REST / SSE 桥接,连接 GrzybcioRynek 与公共市场网站。
这不是第二个市场插件。GrzybcioRynekWeb 不存储商品列表,不接触 Vault,也不读取 listings.yml。它通过只读 HTTP API 暴露来自 GrzybcioRynek 的实时市场数据。
网站 (Next.js) → GrzybcioRynekWeb → GrzybcioRynek MarketAPI
功能
- REST API — 商品列表、分类、统计信息、交易历史、玩家资料、价格历史
- 服务器发送事件 (SSE) — 当商品被创建、售出、移除或过期时实时更新
- API 密钥认证 — 仅拥有只读权限;写入端点返回
403 WRITE_NOT_ENABLED - CORS — 显式来源白名单(生产环境中不使用
*) - 速率限制 — 基于 IP 和 API 密钥
- 响应缓存 — 可配置的商品列表、统计信息、玩家和历史记录的 TTL
- OpenAPI 3 —
/api/docs和/api/openapi.json提供交互式文档 - 管理员命令 — 状态、重载、缓存管理、密钥名称(绝不打印密钥明文)
要求
| 要求 | 版本 |
|---|---|
| 服务端 | Paper 26.2 |
| Java | 25 |
| GrzybcioRynek | 1.0.3+(必需依赖项) |
| Vault + 经济系统 | GrzybcioRynek 所需 |
GrzybcioRynekWeb 会检查已安装的 GrzybcioRynek 版本及 API 契约 (1)。如果缺少 GrzybcioRynek、被禁用或不兼容,桥接服务将不会启动。
安装
- 安装并配置 GrzybcioRynek(必须确保 Vault + 经济系统正常工作)。
- 将
GrzybcioRynekWeb-1.0.0.jar放入你的plugins/文件夹。 - 启动服务器一次以生成
plugins/GrzybcioRynekWeb/config.yml。 - 编辑配置文件(见下文)—— 在暴露端口前更改
CHANGE_MEAPI 密钥。 - 重启服务器(或者在仅修改 YAML 后运行
/grzybciorynekweb reload)。 - 验证:
- 游戏内:
/grzybciorynekweb status - HTTP:
GET http://your-server:8765/api/v1/health
- 游戏内:
配置
默认端口:8765 (api.host: 0.0.0.0)。
API 密钥(推荐用于生产环境)
api:
authentication:
enabled: true
keys:
- name: "website"
key: "your-secret-key-here"
permissions:
- "listings.read"
- "categories.read"
- "stats.read"
- "history.read"
- "players.read"
将密钥作为 X-API-Key: … 或 Authorization: Bearer … 发送。
对于 SSE (EventSource),仅在 /api/v1/events 上使用 ?api_key=…。
CORS(浏览器 → 直接调用插件)
如果你的网站在没有后端代理的情况下从浏览器调用插件,请添加你的站点来源:
api:
cors:
enabled: true
allowed-origins:
- "https://your-market.example.com"
- "http://localhost:3000"
捆绑的 Next.js 市场网站 使用同源代理,因此当你以这种方式部署时,插件上的 CORS 是可选的。
安全检查清单
- 在公开之前替换所有
CHANGE_ME密钥 - 未经认证、防火墙或反向代理保护,切勿将端口
8765暴露给互联网 - 在生产服务器上保持
authentication.enabled: true - 切勿将 API 密钥放在客户端
NEXT_PUBLIC_*环境变量中
命令
| 命令 | 权限 | 描述 |
|---|---|---|
/grzybciorynekweb status |
grybciorynekweb.admin |
查看桥接、REST、SSE、缓存和指标状态 |
/grzybciorynekweb reload |
grybciorynekweb.admin |
重新加载配置并在绑定地址更改时重启 HTTP 服务 |
/grzybciorynekweb key |
grybciorynekweb.admin |
列出配置的密钥名称(非密钥明文) |
/grzybciorynekweb cache clear |
grybciorynekweb.admin |
使 API 缓存失效 |
别名:/grynekweb
API 概览
基础路径:/api/v1
| 端点 | 描述 |
|---|---|
GET /health |
桥接状态(无需密钥) |
GET /listings |
分页显示活跃商品列表 |
GET /listings/{id} |
单个商品详情 |
GET /categories |
市场分类 |
GET /stats |
市场统计数据 |
GET /history |
公共交易历史 |
GET /price-history/{item} |
价格图表数据 |
GET /players/{name|uuid} |
卖家资料 |
GET /players/{id}/listings |
玩家商品列表 |
GET /sellers |
唯一卖家名称 |
GET /events |
SSE 流 |
GET /api/docs |
HTML 文档 |
完整参考:请参阅源代码仓库中的 docs/API.md。
链接
- Modrinth 上的 GrzybcioRynek — 必需的市场插件 (1.0.3+)
- 市场网站 — 下载并自行托管 (Next.js)
- 文档维基 — Web 集成、API、托管指南
配套网站
从 GrzybcioRynekWeb-strona (Next.js) 下载并自行托管公共市场前端。它通过服务器端代理连接,从而确保你的 API 密钥保留在主机端(VPS、Docker、Vercel 等)。
网站主机上典型的环境变量:
MARKET_API_URL=https://your-public-api-url:8765
MARKET_API_KEY=your-read-key
NEXT_PUBLIC_MARKET_SSE=false
通过 Cloudflare Tunnel、反向代理或公网 IP 暴露 GrzybcioRynekWeb —— Vercel 无法访问你游戏服务器上的 127.0.0.1。
此插件不做什么
- 通过 HTTP 创建、编辑或删除商品列表(v1 为只读)
- 替代 GrzybcioRynek 或复制其市场逻辑
- 在未安装且未启用 GrzybcioRynek 的情况下运行
许可证
Apache License 2.0
GrzybcioRynek 和 GrzybcioRynekWeb 与 Mojang Studios 无关。
GrzybcioRynekWeb (PL)
连接 GrzybcioRynek 与公共市场网站的 HTTP REST / SSE 桥接。
Nie jest to drugi plugin rynkowy. GrzybcioRynekWeb nie przechowuje ofert, nie ingeruje w Vault i nie odczytuje listings.yml. Udostępnia na żywo dane z GrzybcioRynek poprzez tylko do odczytu HTTP API.
Strona (Next.js) → GrzybcioRynekWeb → GrzybcioRynek MarketAPI
Funkcje
- REST API — oferty, kategorie, statystyki, historia transakcji, profile graczy, historia cen
- Server-Sent Events (SSE) — na żywo: nowa oferta, sprzedaż, usunięcie, wygaśnięcie
- Klucze API — uprawnienia tylko do odczytu; zapis przez HTTP zwraca
403 WRITE_NOT_ENABLED - CORS — jawna lista originów (bez
*na produkcji) - Rate limiting — per IP i per klucz API
- Cache odpowiedzi — konfigurowalny TTL
- OpenAPI 3 — dokumentacja pod
/api/docsi/api/openapi.json - Komendy admina — status, reload, cache, nazwy kluczy (sekrety nigdy nie są wyświetlane)
Wymagania
| Wymaganie | Wersja |
|---|---|
| Serwer | Paper 26.2 |
| Java | 25 |
| GrzybcioRynek | 1.0.3+ (wymagana zależność) |
| Vault + ekonomia | Wymagane przez GrzybcioRynek |
Most sprawdza wersję GrzybcioRynek i kontrakt API (1). Jeśli GrzybcioRynek nie ma, jest wyłączony albo niekompatybilny — most się nie uruchomi.
Instalacja
- Zainstaluj i skonfiguruj GrzybcioRynek (Vault + ekonomia muszą działać).
- Wgraj
GrzybcioRynekWeb-1.0.0.jardoplugins/. - Uruchom serwer raz — powstanie
plugins/GrzybcioRynekWeb/config.yml. - Edytuj config (poniżej) — zmień klucz
CHANGE_MEzanim wystawisz port na świat. - Zrestartuj serwer (albo
/grzybciorynekweb reloadpo samych zmianach w YAML). - Sprawdź:
- W grze:
/grzybciorynekweb status - HTTP:
GET http://twoj-serwer:8765/api/v1/health
- W grze:
Konfiguracja
Domyślny port: 8765 (api.host: 0.0.0.0).
Klucz API (zalecane na produkcji)
api:
authentication:
enabled: true
keys:
- name: "website"
key: "twoj-tajny-klucz"
permissions:
- "listings.read"
- "categories.read"
- "stats.read"
- "history.read"
- "players.read"
Wyślij klucz jako X-API-Key: … albo Authorization: Bearer ….
Dla SSE (EventSource) użyj ?api_key=… tylko na /api/v1/events.
CORS (przeglądarka → plugin bezpośrednio)
Jeśli strona woła plugin z przeglądarki bez proxy po stronie serwera, dopisz origin:
api:
cors:
enabled: true
allowed-origins:
- "https://twoj-rynek.example.com"
- "http://localhost:3000"
Dołączona strona Next.js używa proxy na tej samej domenie — wtedy CORS w pluginie nie jest konieczny.
Checklist bezpieczeństwa
- Zamień każdy klucz
CHANGE_MEprzed publikacją - Nie wystawiaj portu
8765na internet bez auth, firewalla albo reverse proxy - Na produkcji trzymaj
authentication.enabled: true - Nie wkładaj kluczy API do zmiennych
NEXT_PUBLIC_*po stronie strony
Komendy
| Komenda | Uprawnienie | Opis |
|---|---|---|
/grzybciorynekweb status |
grybciorynekweb.admin |
Most, REST, SSE, cache, metryki |
/grzybciorynekweb reload |
grybciorynekweb.admin |
Przeładuj config; restart HTTP przy zmianie bind |
/grzybciorynekweb key |
grybciorynekweb.admin |
Nazwy kluczy (bez sekretów) |
/grzybciorynekweb cache clear |
grybciorynekweb.admin |
Wyczyść cache API |
Alias: /grynekweb
API — skrót
Prefiks: /api/v1
| Endpoint | Opis |
|---|---|
GET /health |
Status mostu (bez klucza) |
GET /listings |
Paginowane oferty |
GET /listings/{id} |
Jedna oferta |
GET /categories |
Kategorie |
GET /stats |
Statystyki rynku |
GET /history |
Publiczna historia TX |
GET /price-history/{item} |
Punkty wykresu ceny |
GET /players/{nick|uuid} |
Profil sprzedawcy |
GET /players/{id}/listings |
Oferty gracza |
GET /sellers |
Unikalne nicki |
GET /events |
Strumień SSE |
GET /api/docs |
Dokumentacja HTML |
Pełna referencja: docs/API.md w repozytorium.
Linki
- GrzybcioRynek na Modrinth — wymagany plugin rynku (1.0.3+)
- Strona rynku — pobieranie i samohostowanie (Next.js)
- Wiki dokumentacji — integracja WWW, API, hosting
Strona towarzysząca
Publiczną stronę rynku pobierzesz i samodzielnie hostujesz z GrzybcioRynekWeb-strona (Next.js). Łączy się przez proxy po stronie hosta — klucz API zostaje na serwerze (VPS, Docker, Vercel itd.).
Typowe zmienne na hoście strony:
MARKET_API_URL=https://twoj-publiczny-adres-api:8765
MARKET_API_KEY=klucz-odczytu
NEXT_PUBLIC_MARKET_SSE=false
Wystaw GrzybcioRynekWeb przez Cloudflare Tunnel, reverse proxy albo publiczne IP — Vercel nie dosięgnie 127.0.0.1 na Twoim serwerze gry.
Czego plugin nie robi
- Nie tworzy, edytuje ani nie usuwa ofert przez HTTP (v1 = tylko odczyt)
- Nie zastępuje GrzybcioRynek ani nie duplikuje logiki rynku
- Nie działa bez zainstalowanego i włączonego GrzybcioRynek
Licencja
Apache License 2.0
GrzybcioRynek i GrzybcioRynekWeb nie są powiązane z Mojang Studios.
你是这个资源的作者?登录后可认领此资源。
相似资源
PacketEvents 是一款专为 Minecraft Java 版打造的协议库,旨在简化数据包的处理与传输。
使床在所有维度中爆炸的模组
ExyliaPlugins 的库。
重新定义服务器上的生物运输方式。使用高度可定制的口袋道具,安全地捕获、存储和释放任何实体。
为基于 Spigot/Paper/Folia 的服务器添加对 Vivecraft 的支持
为 Armor Poser 模组添加兼容性
评论 0
登录后参与评分
还没有评论,来抢沙发吧