AE2 Web Integration

AE2 Web Integration

一个Applied Energistics 2的附加模组,让你无论身在何处都能在网页浏览器中查看你的终端!

应用能源学 2

AE2 Web Integration

通过桌面或移动浏览器访问你的应用能源2(Applied Energistics 2)网络。实时浏览存储与合成 CPU、请求合成、查看资源历史,并创建带有固定资源的个人仪表盘。公共服务器可为每位玩家提供各自的账户及其网络的访问权限。

支持专用服务器和单人世界。多人客户端无需安装此模组。 它不添加任何物品或方块。 可选的 Icon Generator 客户端模组(ae2webintegration-icon-generator-*.jar)可从你的整合包和资源包生成物品图标。

🌐 官方网站 · ▶️ 体验在线演示

📖 安装指南 · 🔧 API 文档

带有物品图标、固定资源和流量提示的终端

当前功能

终端

  • 浏览、排序和筛选多个 AE2 网络,并实时更新存储和所选 CPU
  • 通过自动或手动选择 CPU 提交合成请求,并取消正在运行的任务
  • 在服务器重启后查看已完成和已取消的合成任务
  • 通过交互式历史图表追踪资源库存、输入和输出
  • 使用响应式桌面和移动布局、浅色/深色/跟随系统外观,以及 Monocraft 或 Lato 字体
  • 选择名称、图标或两者兼有,可配置列数和每页数量,包括不进行分页
  • 在禁用公共模式时,通过 Discord 或 ntfy 接收合成通知

固定项与主页

从资源的上下文菜单或资源详情中固定资源。在终端中固定会将其保留在该网络终端的顶部,位于搜索和筛选之上。在主页固定会添加一个仪表盘卡片,带有可配置的图表和摘要,无论当前选择哪个网络都可见。

固定项属于你的 Web 账户。每位玩家可以保留自己的终端固定项和主页布局;主页可同时显示来自多个网络的资源。固定资源在不再存在于存储中时,仍保留对已记录历史的访问权限。

合成计划图片

计算计划后,在默认主题下选择计划左下角的导出(移动端为图片图标)。选择网格布局、磁贴内容、排序和背景,然后下载单个 PNG。导出包含完整计划,独立于当前搜索,且无需图标包即可工作。设置和图片比例会为下次导出保留;超大图片会使用较低分辨率以适应。

兼容性

本模组目前支持 Minecraft 1.21.1(NeoForge)、1.20.1(Forge)、1.12.2(Forge)和 1.7.10(Forge/GTNH)。不同版本的构建不可互换。

一些额外的兼容性说明:

要求

  • 针对受支持的 Minecraft 版本之一,安装兼容的 AE2
  • 一个已加载且具有有效 ME 控制器的 ME 网络
  • 内置 Web 服务器可用的 TCP 端口
  • 若要从本地网络外部访问面板,需配置防火墙/NAT 规则

默认情况下,面板可通过 http://your-server-ip-or-domain:2324/ 访问。端口可配置。

图库

合成、资源历史、移动端视图和通知

合成计划与 CPU 选择

带有 CPU 选择的已计算合成计划

实时 CPU 视图

合成 CPU 进度和资源状态

资源历史

带有库存、输入、输出和净流量的资源历史

已完成和已取消的合成

已保存的合成历史

Discord 通知

带有合成结果卡的 Discord 通知

移动端终端

手机上带有物品图标和分页的终端
早期视频展示

这些视频展示的是较早的界面。当前 UI 请参见上方的图库和演示。

使用方法

本模组在 HTTP 服务器上托管其 Web 面板和 API,该服务器随你的 Minecraft 服务器或单人世界启动。

  1. 从本项目的下载中,为你的 Minecraft 版本和模组加载器下载主模组 JAR。名称中包含 icon-generator 的单独文件是可选的客户端图标生成器。
  2. 将模组放入服务器的 mods 文件夹,或在单人游戏中放入你的 Minecraft 实例的 mods 文件夹。在多人游戏中,仅服务器需要此模组。
  3. 启动服务器或打开一次单人世界以生成配置。
  4. 打开 config/ae2webintegration/config.toml。根据需要配置端口、管理员密码、公共模式和其他设置。
  5. 对于单人游戏或所有人共享 Admin 账户的私人服务器,请禁用公共模式。如果玩家需要各自独立的账户及其网络的访问权限,请保持启用。
  6. 使用 /ae2webintegration reload 重新加载配置,或重启服务器或单人世界。
  7. 根据需要允许配置的端口通过防火墙和路由器,或通过反向代理路由访问。
  8. 访问 http://your-server-ip-or-domain:configured-port/,并使用 Admin 账户和配置中的密码登录。

在公共模式下,玩家可以从登录页面创建账户。选择密码后,页面会显示一条 /ae2webintegration auth <token> 命令。玩家必须在游戏中运行该命令以完成注册。

网络访问

网络必须具有有效的 ME 控制器,已加载并在出现在 Web 面板之前完成启动。无控制器的子网无法通过网站访问。

在所有受支持的版本上,玩家可以通过拥有连接到网络的 ME 控制器、无线接入点或受支持的终端来获得 Web 访问权限。放置你自己的无线接入点是一种简单的访问设置方式。

在 GTNH 1.7.10 和 AE2 UEL 1.12.2 上,正常工作的安全终端提供了另一种方式:添加玩家的生物识别卡并授予全部四项权限——建造、提取、注入和合成。未分配的生物识别卡不会授予 Web 访问权限。

Admin Web 账户无需逐玩家授权即可访问所有可用网络。请相应地保护其密码。在 Web 面板中选择一个网络以打开其终端。

可选物品图标

要在 Web 面板中显示物品图标,请从你的 Minecraft 客户端生成图标包:

  1. 从本项目的下载中,为你的 Minecraft 版本和模组加载器下载 Icon Generator 文件(ae2webintegration-icon-generator-*.jar)。将其放入客户端的 mods 文件夹。使用与服务器相同的整合包。
  2. 使用你希望用于图标的资源包启动游戏,然后进入世界。
  3. 在聊天中运行 /ae2webicons export,等待进度窗口完成。
  4. 在游戏目录内的 ae2webicons 文件夹中找到生成的 .ae2wi-icons 文件。
  5. 停止服务器,并将该文件复制到 config/ae2webintegration/。保留其 .ae2wi-icons 扩展名;文件名可以保持不变。
  6. 启动服务器。当图标包可用时,新的浏览器会自动显示图标和名称。使用 Web 设置 → 终端显示 将其更改为仅图标或仅名称。

图标使用你已加载的资源包的外观。你可以从进度窗口取消生成。要替换或移除服务器的图标包,请先停止服务器,然后重新启动。该文件夹中只保留一个 .ae2wi-icons 文件。如果存在多个,服务器会记录它们的名称并禁用图标,直到冲突解决并重新启动服务器。图标是可选的;没有图标包时,终端显示物品名称。

Web 主题

本模组目前包含一个内置主题。计划提供更多主题。

在 Web 设置 → 选择主题 中选择主题。要为所有人安装主题,请将其 ZIP 放入 config/ae2webintegration/themes/ 并重启服务器。将 config/ae2webintegration/config.toml 中的 general.default_theme 设置为 server:<theme id> 以使其成为服务器默认主题,或设置为 builtin:default 以使用内置 UI。用户可以遵循该默认值或保留自己的浏览器选择。

如果某个主题导致无法正常使用,请在其 # 片段之前使用 ?safe=1 打开页面,以使用内置 UI。

合成历史

在网络设置中启用记录合成历史以跟踪其合成任务。在那里启用包含机器请求的合成以同时跟踪该网络上机器启动的任务。机器选项适用于新任务。启用跟踪不会重建正在进行的任务的历史。

已完成和已取消的任务会随世界一起保存,并在服务器重启后仍可用。在网络设置中选择合成历史保留期限。默认是 7 天,每个网络最多 1,000 个任务。管理员可以在 crafting_history 中更改保留界限和任务数量限制。

资源历史

网络设置有独立的开关,分别用于输入/输出历史和定期存储数量。在那里选择每个网络的存储采样间隔、输入/输出间隔和历史保留期限,且需在服务器允许的范围内。仅记录输入/输出不会扫描库存;被接受的输入包括被虚空存储消耗的资源。在终端中选择一个资源,并在其详情中打开资源历史以查看测量结果。

输入/输出历史默认每 60 秒保存聚合总量;存储采样默认为五分钟。最近摘要显示两分钟的流量和一小时的库存变化。流量摘要使用五秒间隔;库存摘要使用网络配置的存储采样间隔。图表显示每个测量间隔的实际跨度,并在收集存在间隙时保留可用的部分计数。

流量还记录被接受的输入和输出操作次数。当测量间隔完整时,最近摘要显示大约每秒的速率。一次转移 64 个物品计为一次操作;这些计数描述的是网络传输,而不是单个机器配方。

历史存储在嵌入的 SQLite 数据库中,位于世界目录下的 ae2webintegration/grids.sqlite。无需安装数据库。如果数据库无法初始化,服务器启动会失败。默认最多保留 7 天和每个网络 250,000 条记录;达到任一限制时会移除最旧的记录。每个资源可能保留一条较旧的库存测量作为带日期的基线,且在相同的记录限制内。在 config.toml 中的 resource_history 下配置最小值、最大值和默认值以及记录上限,并通过 /ae2webintegration reload 或重启服务器应用它们。现有的网络选择若超出新界限,会调整到最近的界限。记录上限可以缩短所选保留期限,且不是字节限制。过期数据在历史查询中隐藏;物理清理在数据库初始化、写入和定期后台维护期间运行。缺失的测量显示为间隙,而不是零活动。

启用自动更新后,终端和所选 CPU 视图通过 SSE 接收实时变化。CPU 列表会定期刷新。实时查看不需要资源历史跟踪,也不会增加已保存存储测量值的频率。在连接中断或存储拓扑变化后,终端会自动加载新的快照。

通知服务集成

合成通知仅在禁用公共模式时可用。

合成完成通知可以通过 minimum_crafting_duration_seconds 和 minimum_crafting_amount 进行过滤。通知必须同时满足配置的两个最小值。两个值默认均为 0,这会保留所有合成完成通知的启用状态。为每个应发送合成通知的网络启用记录合成历史。

合成更新在识别到请求玩家时包含他们,对于通过 Web 终端下达的订单使用经过身份验证的账户。管理员和 localhost 访问没有玩家身份。

Discord

创建一个 Discord webhook,并将其 URL 设置为 AE2 Web Integration 配置中的 discord.webhook。discord.role_id 配置可选的提及角色。

合成通知包含一张深色图片卡片,显示结果、网络名称、CPU、持续时间和请求者。将 discord.crafting_style 设置为 IMAGE_CARD(默认)以显示完整卡片,SMALL_ICON 以显示带有物品缩略图的文本嵌入,或 SIMPLE 以仅显示文本。安装图标包以提供物品图片。当没有可用图标时,SMALL_ICON 仅发送文本;如果渲染失败,IMAGE_CARD 回退为文本。

ntfy

ntfy 将相同的合成更新作为手机或桌面通知发送。将 ntfy.host 设置为 ntfy.sh 或你自己的服务器,并将 ntfy.topic 设置为你在应用中订阅的主题。不带 http:// 或 https:// 的主机将通过 HTTPS 发送。

当主题为公开时,将 ntfy.user 和 ntfy.password 留空。私人主题需要两者。仅设置其中一个会关闭 ntfy。

notifications.full_domain 是可选的。设置后,打开通知会转到该地址。

服务器设置

管理员和受信任的 localhost 用户可以在服务器设置中编辑活动配置。保存并应用会写入 config.toml 并应用更改,无需重启 Web 服务器。监听端口、管理员密码、公共模式、无密码 localhost 访问、受信任代理和未认证请求限制在面板中为只读;请直接在配置文件中更改它们。手动编辑文件在重新加载配置或重启服务器后生效。在 config.toml 中设置 general.allow_server_settings_editing = false 并重新加载,以禁用通过 Web 读取和编辑服务器设置,包括对管理员和受信任的 localhost 用户。该选项卡随后会显示禁用通知而不是设置。访问默认启用;该开关只能在文件中更改。已保存的 Discord webhook 和 ntfy 密码永远不会显示。将其替换字段保持不变以保留它们,或明确替换或清除它们。

安全

公共模式

在公共模式下,每位玩家都可以创建自己的 Web 账户,并访问他们被允许使用的 AE2 网络。注册从网站开始,必须在游戏中使用 Web 面板显示的命令进行确认。玩家必须在线才能注册。

玩家密码以加盐的 PBKDF2-HMAC-SHA1 哈希存储。会话在无活动一小时后过期,并可通过使用延长至登录后最多十二小时。记住我在服务器重启后仍然有效,在无活动七天后过期,并可通过使用延长至登录后最多六十天。观看实时终端或 CPU 视为活动。更改密码会撤销现有会话。每个账户最多可保留二十个已记住的会话;另一次记住的登录会登出最旧的会话。

公共模式禁用

当公共模式禁用时,仅 Admin 账户可用。其密码在模组的配置文件中配置。会话机制与公共模式相同。

Localhost 访问

来自环回地址(127.0.0.1/localhost)的连接默认以管理员身份验证。这由 allow_no_password_on_localhost 控制。使用反向代理时,此规则适用于从代理头解析出的客户端地址。

反向代理设置

本模组内置支持解析反向代理后面的真实客户端 IP。解析后的地址会一致地用于 localhost 身份验证规则和基于 IP 的速率限制。

仅当直接 TCP 连接来自以下情况时,本模组才读取 X-Forwarded-For 或 X-Real-IP:

  • 与 Minecraft 服务器运行在同一台机器上的代理;或
  • trusted_proxies 中列出的地址或网络。

同一台机器上的代理会自动受信任,无需添加到配置中。对于运行在另一台机器上的代理,请将 trusted_proxies 设置为以逗号分隔的字面 IPv4/IPv6 地址或 CIDR 范围列表。例如,在 TOML 配置中:

[general]
trusted_proxies = '192.168.1.10, 10.20.0.0/24, 2001:db8::10'

不接受主机名;请使用字面地址或 CIDR 范围。

X-Forwarded-For 优先于 X-Real-IP。对于 client, proxy1, proxy2 这样的链,本模组从右到左遍历,跳过配置的受信任代理,并使用第一个不受信任的地址作为客户端。这可以防止客户端通过直接发送伪造的 X-Forwarded-For: 127.0.0.1 头来为自己授予 localhost 访问权限。

对于 HTTPS 终止,请保留公共 Host 头(包括任何非标准端口),并将 X-Forwarded-Proto 设置为公共协议 http 或 https。本模组仅从上述相同的受信任代理接受此协议头。当 Sec-Fetch-Site 缺失时,它用于验证浏览器登录和注册表单的来源。代理必须覆盖 X-Forwarded-Proto,而不是转发任意客户端值或追加列表。在多个代理跳的情况下,最后一个受信任代理必须提供经过验证的公共协议。

同一台机器上运行的代理的 Nginx 配置示例:

location / {
    proxy_pass http://127.0.0.1:2324;
    proxy_set_header Host $http_host;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}

通过另一个 Web 服务器托管

tools/php-proxy 目录包含一个 PHP 反向代理,它通过现有 Web 服务器提供模组的网站、资源和 API。

遥测

遥测在开发环境之外默认启用。本模组在服务器启动十分钟后发送一份小型 HTTPS 使用报告,之后大约每小时一次: 已安装模组 JAR 的加盐指纹、Minecraft 版本、公共模式和单人游戏设置, 以及一个随机会话 ID,该 ID 会在服务器重启时和每个新 UTC 日的首次报告时更改。 不会报告任何玩家身份、世界或网络内容。 有关数据处理和保留,请参阅隐私政策。

我们感谢你保持其启用,以帮助指导开发。

在服务器设置中禁用报告,或在 config/ae2webintegration/config.toml 中的 [telemetry] 下设置 enabled = false 然后重新加载配置,或使用 /ae2webintegration telemetry off。使用 on 重新启用,或使用 status 检查设置。单人游戏所有者无需作弊即可使用这些命令;在专用服务器上,它们需要权限等级 4。

许可证

项目代码和原始界面图标根据 LGPL-3.0-or-later 许可。 捆绑的第三方资源保留其各自的许可证:

组件 作者 / 来源 许可证
项目代码和原始界面图标 kuba6000 LGPL-3.0-or-later
图表 uPlot, Leon Sorokin MIT
界面图标 HackerNoon Pixel Icon Library MIT
Lato 字体 Łukasz Dziedzic (tyPoland) SIL Open Font License 1.1
Monocraft 字体 Idrees Hassan SIL Open Font License 1.1

第三方游戏资源

截图和交互式演示可能显示来自 Minecraft、Applied Energistics 2、GT New Horizons (GTNH) 和其他第三方模组的物品图标和纹理。

这些资源仍属于其各自权利持有者的财产,并受其原始许可证的约束。它们用于展示 AE2 Web Integration 的界面和图标支持,不在项目的 LGPL-3.0-or-later 许可证范围内。