diff --git a/README.md b/README.md index 57bdbe1..026ebf4 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@

Snapshot development builds (not manually validated)

-

Minecraft Transit Railway routes, rails and stations on your map.

+

Minecraft Transit Railway routes, live trains and station arrivals on your map.

-

English · 简体中文 · Website & docs · Download v1.5.3

+

English · 简体中文 · Website & docs · Try v1.5.3 pre-release

Available on Modrinth @@ -15,26 +15,37 @@

-MTR Map Overlay adds Minecraft Transit Railway routes, physical rails and map-only landmarks to Xaero's World Map and JourneyMap. **v1.5.3 supports Minecraft 1.20.1 and 1.20.4 on Forge or Fabric, and 1.21.1 on NeoForge or Fabric.** It reads [Minecraft Transit Railway (MTR)](https://github.com/Minecraft-Transit-Railway/Minecraft-Transit-Railway) data directly and does not depend on MTR Surveyor's map. +MTR Map Overlay adds Minecraft Transit Railway routes, physical rails, live trains, native station arrivals and map-only landmarks to Xaero's World Map and JourneyMap. **v1.5.3 supports Minecraft 1.20.1 and 1.20.4 on Forge or Fabric, and 1.21.1 on NeoForge or Fabric.** It reads [Minecraft Transit Railway (MTR)](https://github.com/Minecraft-Transit-Railway/Minecraft-Transit-Railway) data directly and does not depend on MTR Surveyor's map. ## Features | Map | Overlay | | --- | --- | -| Xaero's World Map | Physical rail geometry, route-coloured ribbons, and compact station, platform and depot icons. Hover to inspect routes and landmarks. | -| JourneyMap | Physical rails, shared-route colour bands, and station, platform and depot icons on the fullscreen map, with separate TRACKS and ROUTES controls. | +| Xaero's World Map | Physical rails, route ribbons, live trains, station/platform/depot icons, and pinned station cards with native arrivals. | +| JourneyMap | Fullscreen rails, shared-route bands, live trains and native station boards; separate TRACKS and ROUTES controls, with JourneyMap 5/6 adapters. | These are **map-only icons**, not ordinary Xaero waypoints: they do not fill the waypoint list, compass, minimap or in-world HUD. Multiple routes on one physical rail occupy adjacent colour bands rather than overwriting one another. Both map integrations draw physical rails first, coloured routes on top, and station/platform icons last. In JourneyMap, the entire layer follows the map's live drag and zoom transform; track width follows the same zoom rules as Xaero, with a minimum width for the combined shared-route bundle. When the mod is installed on the server as well as the client, it can request a **whole-network snapshot** for each dimension. Without the server component it still works, but can show only the nearby data MTR has sent to the client. Xaero and JourneyMap are optional integrations; install either or both. -## Roadmap +## What's new in 1.5.3 -Development progress, in priority order. Unfinished items may change in scope and timing. +- **Pinned stations and native arrivals:** click a station, then **Expand** to see upcoming services by destination, line and platform. Predictions come directly from MTR/TSC's PIDS interface; missing predictions are shown explicitly. +- **British and European PIDS:** use the default black/amber board or switch to European/airport styling with `/mtrmap config pidsStyle british|european`. The choice is saved. +- **Navigation extensions:** a public Java 17 API exposes native network catalogs, station-board subscriptions and independent map views. Registered third-party providers enable **Navigate**; they supply route planning and journey progress. Highlight upcoming sections and separately dim completed or unused track, including high-speed white blocks and rail backing. +- **Smoother interaction:** station cards retain their classic information, stay collapsed until expanded and keep clicks/scrolling inside the panel. Shared arrivals, bounded queues and background decoding reduce repeated work. -- [x] **TSC line types (1.5.2)** — Light rail uses 70% width; rail and high speed share standard width. High speed retains alternating line-colour/white blocks inside a continuous coloured outline. Xaero and JourneyMap share the renderer geometry. Dense bundles and low zoom simplify the blocks. Whole-network sync requires matching client and server builds (static v8 / trains v1). Rendering checks are recorded in [route-joins-zoom.md](docs/validation/route-joins-zoom.md). -- [x] **Whole-network live trains (1.5.2)** — All trains in the viewed dimension are streamed from TSC, including trains outside every player's loaded area. Two reference points per carriage drive abstract 2D symbols and display interpolation; the client runs no train simulation. Next-stop distance and ETA are postponed. -- [ ] **Later: visual polish** — Refine line styles, train and station icons, labels and zoom behaviour to improve readability and visual consistency. +**Release status (2026-10-31):** GitHub currently marks [v1.5.3](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.3) as a **pre-release**. [v1.5.2](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.2) is the latest stable release. All six 1.5.3 builds include the features above; native arrivals and whole-map trains require matching client/server versions. + +### Station boards and the navigation API + +Click a station to pin the classic station/platform/route card, then **Expand** to request native arrivals. **Collapse**, closing the map or disconnecting releases the subscription. Rows show destination, line, platform and a right-aligned countdown; a missing prediction is a dash, not zero minutes. Theme changes apply immediately and persist across restarts. + +**Navigate requires a compatible third-party provider.** One provider opens directly; multiple providers show a chooser; without one the action is disabled. Overlay does not bundle a planner. Independent view sessions can highlight exact native path sections without modifying the shared network data. The [public API guide](docs/api/overlay-api-v1.md) covers `MtrMapApi`, Java 17 `compileOnly` usage and lifecycle rules. The separate API artifact is built from source; it is not listed among the release's six mod JARs. + +### Route styles and whole-map trains + +Light rail uses 70% of standard width. Rail and high speed share standard width; high speed uses alternating route-colour/white blocks with a continuous coloured outline. Adaptive native curves, shared-route joins and zoom-responsive widths keep both map integrations aligned. These features were added in 1.5.2 and remain in 1.5.3. ### Whole-network train cars (1.5.2) @@ -56,16 +67,16 @@ Static rail/route geometry is cached separately from car poses, with viewport pr Every dependency must match your Minecraft version and loader. Xaero's Minimap is optional and is only used to remove old `[MTR]` waypoints created by earlier releases. -1. Download **one JAR** matching your exact Minecraft version and loader from the latest release, [v1.5.3](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.3), and place it in the client's `mods` directory. The release has six JARs: two `MC1.21.1` NeoForge/Fabric builds and four `MC1.20.1` / `MC1.20.4` Forge/Fabric builds. All filenames also identify the tested MTR version. +1. Download **one JAR** matching your exact Minecraft version and loader from the [v1.5.3 pre-release](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.3), and place it in the client's `mods` directory. The release has six JARs: two `MC1.21.1` NeoForge/Fabric builds and four `MC1.20.1` / `MC1.20.4` Forge/Fabric builds. All filenames also identify the tested MTR version. 2. Install MTR and your chosen map mod for that same loader. Fabric additionally needs Fabric API. 3. Optionally install the matching MTR Map Overlay JAR and MTR on the server to enable the whole-network view. Client and server must use the `mtrmap` mod ID; older `mtrsurveyor` builds are not compatible with this release. 4. Open Xaero's World Map or JourneyMap's fullscreen map. Both maps have matching `ROUTES` and `TRACKS` icons (green left bar = on, red = off); JourneyMap puts them in its add-on button panel. The `/mtrmap config routeLines` and `trackLines` switches apply to both maps. Hover over a line or icon for details. -Whole-map trains require this version on both client and server; client-only installs use nearby MTR data. All six builds passed Xaero/JourneyMap development-runtime checks; see [the platform validation record](docs/validation/platform-matrix-1.5.2.md) for test coverage and remaining limits. +Whole-map trains require matching 1.5.3 builds on both client and server; client-only installs use nearby MTR data. All six builds passed Xaero/JourneyMap development-runtime checks; see [1.5.3 PIDS validation](docs/validation/pids-and-dimmed-1.5.3.md) for the recorded development-runtime checks and remaining limits. Real navigation-provider end-to-end integration, production modpack launch, cross-machine play and large-network performance are not covered. ## Commands and configuration -**1.5.3:** click a station to pin its classic information card, then **Expand** for native MTR/TSC arrivals. British PIDS is the default; `/mtrmap config pidsStyle british|european` switches and saves the theme. The [public API](docs/api/overlay-api-v1.md) provides station boards, owned views, per-section dimming and a provider-based Navigate entry. Install matching client/server versions for native snapshots. +See the station-board section above for mouse controls and the [API guide](docs/api/overlay-api-v1.md) for developer integration. **Known limit:** Forge 1.20.4 singleplayer quick-play disconnected during Xaero server-data initialization. Separate-server PIDS tests passed; singleplayer in that combination remains unverified. See [1.5.3 validation](docs/validation/pids-and-dimmed-1.5.3.md) and [release notes](docs/releases/v1.5.3.md). @@ -84,7 +95,7 @@ Commands are registered on the **client**, so they are available even when the s | `/mtrmap config routeLines ` | Show or hide route ribbons on both maps. | | `/mtrmap config trackLines ` | Show or hide physical rails on both maps. | | `/mtrmap config trainCars ` | Show or hide the train layer on both maps. | -| `/mtrmap config pidsStyle british\|european` | station PIDS style; British is the default. Query with no argument. | +| `/mtrmap config pidsStyle british\|european` | Switch and save the PIDS theme (default British); omit the style to query it. | NeoForge stores settings in `config/mtrmap.toml` and copies an existing `mtrsurveyor.toml` on first launch when the new file is absent. Fabric uses `config/mtrmap.properties` with its own defaults. The two formats are not automatically interchangeable. Important options include `networkSync.enabled` (default `true`), `networkSync.refreshIntervalSeconds` (default `300`), and the station/platform/depot visibility switches. diff --git a/README.zh-CN.md b/README.zh-CN.md index fb0f3c1..4c35dab 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -5,9 +5,9 @@

Snapshot 开发构建（未经实机验收）

-

在地图上查看 Minecraft Transit Railway 的路线、轨道和车站。

+

在地图上查看 Minecraft Transit Railway 的路线、实时列车和站点到站预测。

-

English · 简体中文 · 官网与文档 · 下载 v1.5.3

+

English · 简体中文 · 官网与文档 · 试用 v1.5.3 预发布

Modrinth 下载 @@ -15,26 +15,37 @@

-MTR Map Overlay 将 Minecraft Transit Railway 的路线、真实轨道与地图专属地标显示在 Xaero's World Map 和 JourneyMap 中。**v1.5.3 支持 Minecraft 1.20.1、1.20.4 的 Forge/Fabric，以及 1.21.1 的 NeoForge/Fabric。**它直接读取 [Minecraft Transit Railway（MTR）](https://github.com/Minecraft-Transit-Railway/Minecraft-Transit-Railway) 数据，不依赖 MTR Surveyor 的地图。 +MTR Map Overlay 将 Minecraft Transit Railway 的路线、真实轨道、实时列车、原生到站预测与地图专属地标显示在 Xaero's World Map 和 JourneyMap 中。**v1.5.3 支持 Minecraft 1.20.1、1.20.4 的 Forge/Fabric，以及 1.21.1 的 NeoForge/Fabric。**它直接读取 [Minecraft Transit Railway（MTR）](https://github.com/Minecraft-Transit-Railway/Minecraft-Transit-Railway) 数据，不依赖 MTR Surveyor 的地图。 ## 功能 | 地图 | 显示内容 | | --- | --- | -| Xaero's World Map | 真实轨道几何、路线色带，以及小型车站、站台、车辆段图标；悬停查看详情。 | -| JourneyMap | 仅在全屏地图显示真实轨道、共线路线色带，以及车站、站台和车辆段图标；提供独立的 TRACKS 与 ROUTES 开关。 | +| Xaero's World Map | 真实轨道、路线色带、实时列车、站点／站台／车辆段图标，以及可固定并显示原生预测的站点框。 | +| JourneyMap | 全屏轨道、共线色带、实时列车和原生到站板；提供独立 TRACKS／ROUTES 控件，适配 JourneyMap 5／6。 | 这些是**地图内图标**，不是普通 Xaero 路标，不会挤满路标列表、指南针、小地图或游戏内 HUD。同一条物理轨道有多条路线时，颜色并排显示，不再互相覆盖。两种地图都先绘制轨道，再叠加路线，最后绘制站点与站台图标。JourneyMap 整层跟随地图实时拖动和缩放；轨道宽度与 Xaero 使用相同缩放规则，共线整束保留最小宽度。 客户端和服务端都安装本 mod 时，可按维度获取**全网快照**。如果服务端没有安装，本 mod 仍可工作，但只能显示 MTR 已同步到客户端的附近数据。Xaero 与 JourneyMap 都是可选集成，可以只装其中一个，也可以同时安装。 -## 开发路线图 +## 1.5.3 新功能 -以下按优先级记录开发进度，未完成目标的具体范围与时间可能调整。 +- **固定站点与原生预测**：点击车站后用 **Expand** 按目的地、线路和站台查看后续班次。预测直接使用 MTR/TSC 的 PIDS 接口，缺失数据明确提示。 +- **英式与欧式 PIDS**：默认黑底琥珀字，可用 `/mtrmap config pidsStyle british|european` 切换并保存欧式／机场风格。 +- **导航扩展**：公共 Java 17 API 提供原生路网目录、站点到站板订阅和独立地图视图。注册第三方服务后启用 **Navigate**，规划与行程进度由第三方提供；可高亮待乘区段，分别淡化已走和未用轨道，包含高铁白块及底衬。 +- **交互优化**：保留原站点信息，默认折叠，面板点击／滚动不误触地图；共享预测采集、队列限额和后台解码减少重复工作。 -- [x] **TSC 线路类型（1.5.2）** — 轻铁为标准宽度的 70%，普通铁路与高铁等宽；高铁保留彩白交替块和连续线路色描边。Xaero 与 JourneyMap 共用绘制几何；密集共线和低缩放下简化块状纹理。全网同步需客户端、服务端匹配版本（静态 v8／列车 v1）。绘制验证见 [route-joins-zoom.md](docs/validation/route-joins-zoom.md)。 -- [x] **全网实时列车（1.5.2）** — 从 TSC 同步查看维度的所有列车，包含远离所有玩家与加载区域的车辆。每节两个参考点驱动抽象 2D 车厢及显示插值，客户端不维护行车模拟。下一站距离与 ETA 暂停。 -- [ ] **后续：显示效果优化** — 优化线路样式、列车与站点图标、文字标注和缩放表现，提升地图的可读性与视觉一致性。 +**发布状态（2026-10-31）：**GitHub 当前将 [v1.5.3](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.3) 标记为**预发布**，[v1.5.2](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.2) 为最新稳定版。六个 1.5.3 构建均提供上述功能；原生预测和全图列车需要匹配的客户端与服务端版本。 + +### 站点到站板与导航 API + +点击车站固定原站点／站台／线路信息框，通过 **Expand** 请求原生预测；**Collapse**、关闭地图或断线会释放订阅。表格显示目的地、线路、站台和右对齐倒计时，无预测为横杠，不表示零分钟。样式即时生效并在重启后保留。 + +**Navigate 需要兼容的第三方导航服务。**一个服务直接打开，多个服务显示选择器，无服务时不可用。Overlay 不内置规划器。独立视图会话可按精确原生路径区段高亮，不修改共用路网数据。[公共 API 指南](docs/api/overlay-api-v1.md) 包含 `MtrMapApi`、Java 17 `compileOnly` 用法和生命周期规则；独立 API 产物从源码构建，不属于六个模组 JAR 附件。 + +### 线路样式与全图列车 + +轻铁为标准宽度的 70%；普通铁路与高铁等宽，高铁使用连续线路色描边内的彩白交替块。原生自适应曲线、共线接头和随地图缩放的线宽在两地图中保持一致。这些功能由 1.5.2 引入，并在 1.5.3 中保留。 ### 全网车厢（1.5.2） @@ -56,16 +67,12 @@ MTR Map Overlay 将 Minecraft Transit Railway 的路线、真实轨道与地图 所有依赖都必须匹配 Minecraft 版本及加载器。Xaero's Minimap 为可选依赖，只用于清理旧版本创建的 `[MTR]` 路标。 -1. 从最新发布版 [v1.5.3](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.3) 下载与 Minecraft 版本及加载器完全匹配的 **一个 JAR**，放入客户端 `mods` 目录。发布包含六个 JAR：两个 `MC1.21.1` NeoForge/Fabric 构建，以及四个 `MC1.20.1` / `MC1.20.4` Forge/Fabric 构建，所有文件名均标明对应的 MTR 测试版本。 +1. 从 [v1.5.3 预发布版](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.3) 下载与 Minecraft 版本及加载器完全匹配的 **一个 JAR**，放入客户端 `mods` 目录。发布包含六个 JAR：两个 `MC1.21.1` NeoForge/Fabric 构建，以及四个 `MC1.20.1` / `MC1.20.4` Forge/Fabric 构建，所有文件名均标明对应的 MTR 测试版本。 2. 安装同一加载器的 MTR 和所需地图 mod；Fabric 还必须安装 Fabric API。 3. 如需全网地图，可选地在服务器安装对应加载器版本的 MTR Map Overlay 和 MTR。客户端与服务端都必须使用新的 `mtrmap` mod ID；旧的 `mtrsurveyor` 版本与本版不兼容。 4. 打开 Xaero's World Map 或 JourneyMap 全屏地图。两端使用配套的 `ROUTES`、`TRACKS` 图标：左侧亮条绿色表示开、红色表示关；JourneyMap 的按钮位于附加按钮栏。`/mtrmap config routeLines` 和 `trackLines` 也对两种地图生效。悬停在线路或图标上可查看详情。 -全图列车需要客户端和服务端都更新本版；仅客户端安装时使用附近回退。六个平台已通过 Xaero/JourneyMap 开发环境实机回归，测试覆盖与限制见[六平台验证记录](docs/validation/platform-matrix-1.5.2.md)。 - -## 1.5.3 站点到站板与扩展接口 - -点击站点固定旧式信息框，默认折叠，点击 **Expand** 查看 MTR/TSC 原生到站预测。默认英式 PIDS，`/mtrmap config pidsStyle british|european` 可切换并保存。统一[公共 API](docs/api/overlay-api-v1.md)提供站点预测、独立视图、已走/未用区段 dimmed 和导航 provider 入口；原生快照需客户端和服务端安装匹配版本。 +全图列车需要客户端和服务端都更新本版；仅客户端安装时使用附近回退。六个平台已通过 Xaero/JourneyMap 开发环境实机回归，测试覆盖与限制见[1.5.3 验证记录](docs/validation/pids-and-dimmed-1.5.3.md)。 **已知限制：Forge 1.20.4 单人 quick-play 测试时在 Xaero 服务端地图数据初始化阶段断线。**该目标连接独立服务器后的双地图 PIDS 测试通过，不能据此声称单人启动已通过。详见[1.5.3 验证记录](docs/validation/pids-and-dimmed-1.5.3.md)与[发布说明](docs/releases/v1.5.3.md)。 diff --git a/docs/agents/MESSAGES.md b/docs/agents/MESSAGES.md index 1810c62..d3c8c75 100644 --- a/docs/agents/MESSAGES.md +++ b/docs/agents/MESSAGES.md @@ -1,5 +1,12 @@ # MESSAGES.md — Agent 交流墙（只追加，不改不删） +## [2026-10-31 21:45] Codex — 官网、README与平台简介同步1.5.3 + +- 更新中英文README的站点固定/原生预测、英式/欧式PIDS、第三方Navigate与区段dimmed说明，保留1.5.2实时列车及六目标依赖矩阵。未修改模组功能、版本、tag或已发布附件。 +- GitHub实时API将v1.5.3标为预发布，latest为v1.5.2；新用户文案按当前状态标注，历史发布操作记录保留。 +- 新增`docs/distribution/1.5.3/`中英文Modrinth Markdown、CurseForge HTML和短简介，均为待发布文案；未直接修改两个平台项目页。 +- 独立官网目录`../mtrsurveyor-site`已同步首页、全部相关文档/导航、SEO和1.5.2/1.5.3 changelog，新增实时列车、站点PIDS、导航API三类双语指南，修复中文文档首页语言。构建34页、32公开路由、1440/390px双语言及Markdown/HTML渲染检查通过，控制台无错误，Ko-fi禁JS仍可见。官网未部署。 + ## [2026-10-26 14:18] Codex-Release — 1.5.3公开说明已按用户样例调整 - 2026-10-26 14:18，Codex-Release：按用户提供的1.5.2内容与形式精简1.5.3公开release note，保留中英文新增/优化、MC/MTR说明及末尾双分支diff，并按用户明确要求移除Forge1.20.4限制段。已更新GitHub正文并回读比对；十附件ID/名称/大小/SHA256/时间戳及正式版标记保持。只改说明，未更改tag、版本、二进制或已封存Candidate。 diff --git a/docs/agents/STATE.md b/docs/agents/STATE.md index 32ff52e..5d5c52c 100644 --- a/docs/agents/STATE.md +++ b/docs/agents/STATE.md @@ -7,9 +7,10 @@ ## 当前版本 -- **v1.5.3 正式版**：原生站点预测、英式/欧式PIDS与统一导航视图/dimmed API，保留全图列车和纯2D绘制。六平台附件已发布为Latest；Forge49单人启动失败和验证边界见下。 +- **v1.5.3**：原生站点预测、英式/欧式PIDS与统一导航视图/dimmed API，保留全图列车和纯2D绘制。2026-10-31核对GitHub API，当前为预发布（`prerelease=true`），`releases/latest`为v1.5.2；此前正式发布/Latest描述保留为历史记录。Forge49单人启动失败和验证边界见下。 - 项目标识：MTR Map Overlay；mod ID `mtrmap`；Java 包 `io.github.teamcreating.mtrmap`；客户端命令 `/mtrmap` -- 最后更新：2026-10-26 14:18，操作者：Codex-Release +- 最后更新：2026-10-31 21:45，操作者：Codex +- 中英文README及`docs/distribution/1.5.3/`分发平台文案已同步1.5.3功能与实时发布状态；官网位于独立目录`../mtrsurveyor-site`，首页、六个新指南页面、现有文档、SEO与changelog已更新，构建及1440/390px检查通过。官网尚未部署，平台简介仅准备未发布；本轮未修改功能代码、版本、tag或附件。 - 2026-10-26 13:32，Codex：补齐Fabric1.21.1和四旧目标的computer-use实机回归，六平台双地图均完成站点折叠/展开、原生ETA和英式/欧式样式检查；各loader滚轮和悬停检查通过。Forge1.20.4单人quick-play遇到Xaero serverData为空而断线，独立本地服务器连接后的双地图通过，单人问题保留待查。未改生产代码，功能源码仍main c1e0314 / compat e041b0a；未发布。详见[验证](../validation/pids-and-dimmed-1.5.3.md)。真实导航provider端到端和大网性能仍未测。 - 版本管理：用户指定1.5.3并授权实施；主线开发版本现为1.5.3，正式版已发布1.5.3，兼容实施分支四目标亦为1.5.3。禁止自行递增其他版本。 - main 保留 NeoForge/Fabric MC 1.21.1；`compat/mtr-4.0-mc-1.20` 另提供 MC 1.20.1/1.20.4 Forge/Fabric + MTR 4.0.5 构建。v1.5.2 发布包含六个 JAR，按精确 Minecraft 版本及加载器选择。 diff --git a/docs/agents/TASKS.md b/docs/agents/TASKS.md index 58e16d6..98aa407 100644 --- a/docs/agents/TASKS.md +++ b/docs/agents/TASKS.md @@ -8,6 +8,7 @@ + ### [待领，发布前QA] 1.5.3真实导航provider与扩展交互验证 - Codex，2026-10-26 13:32：六平台双地图基础PIDS回归已补齐；仍需真实provider选择/点击和区段进度联动，以及逐目标长文本/GUI缩放/列车关闭后的暂停组合。大网性能单列，不能用基础回归替代。 @@ -31,6 +32,8 @@ ## 完成 +- [完成] 1.5.3官网、README与分发平台简介同步 — Codex，2026-10-31 21:45，见本条所在提交。中英文README突出站点原生预测、双PIDS与导航provider边界；`docs/distribution/1.5.3/`包含两语言Markdown、HTML、短简介。GitHub实时状态为1.5.3预发布／1.5.2稳定，与历史发布记录区分。独立官网目录新增三类双语指南，构建34页，32公开路由及1440/390px浏览器检查通过；未部署官网、未编辑Modrinth/CurseForge项目页，未改模组源码或版本。 + - [完成] 1.5.3公开发布说明按用户样例精简 — Codex-Release，2026-10-26 14:18，见本条所在提交。GitHub正文与中英文新增/优化、末尾diff已更新；按要求移除Forge49限制段。回读核对十附件身份/哈希/时间戳及正式标记保持。 - [完成] v1.5.3正式发布 — Codex-Release，2026-10-26 14:07，见本条所在提交。Candidate/Publish通过，六MC/MTR/loader命名JAR及四验证附件重新下载核对SHA256，Latest/双tag/正文diff检查通过；Forge49单人限制已公开，1.5.2未动。 diff --git a/docs/distribution/1.5.3/README.md b/docs/distribution/1.5.3/README.md new file mode 100644 index 0000000..3332d20 --- /dev/null +++ b/docs/distribution/1.5.3/README.md @@ -0,0 +1,13 @@ +# Distribution copy for MTR Map Overlay 1.5.3 + +Prepared from the 1.5.3 release notes, public API guide and recorded six-platform checks, 2026-10-31. + +| Destination | English | 简体中文 | +| --- | --- | --- | +| Modrinth Markdown editor | [modrinth.md](modrinth.md) | [modrinth.zh-CN.md](modrinth.zh-CN.md) | +| CurseForge HTML/source editor | [curseforge.html](curseforge.html) | [curseforge.zh-CN.html](curseforge.zh-CN.html) | +| Short summary field | [summaries.md](summaries.md) | [summaries.md](summaries.md) | + +The HTML files are description fragments, not full web pages. Select the appropriate editor/source mode before pasting. All links are absolute for external platform use. Content is prepared locally; neither platform has been edited. + +Release status checked via GitHub: **1.5.3 pre-release / 1.5.2 latest stable**. The platform descriptions keep this distinction. Whole-map trains and native arrivals require matching server support; Navigate needs a registered third-party provider. The descriptions do not promise built-in planning, train-hover ETA, universal game-version coverage or measured large-network performance. diff --git a/docs/distribution/1.5.3/curseforge.html b/docs/distribution/1.5.3/curseforge.html new file mode 100644 index 0000000..a601bab --- /dev/null +++ b/docs/distribution/1.5.3/curseforge.html @@ -0,0 +1,56 @@ +

MTR Map Overlay

+ +

Your Minecraft Transit Railway network, inside Xaero's World Map and JourneyMap: coloured routes, real rails, moving trains and native station arrivals.

+ +

Explore v1.5.3 pre-release, or use v1.5.2 stable.

+ +

See your railway network

+ +
    +
  • Physical rail geometry and route-coloured ribbons follow the MTR network. Shared tracks show parallel colours; light rail is slimmer and high speed uses colour/white blocks.
    • +
  • Whole-map live trains show moving carriages throughout the viewed dimension, even far from players. Zoom out for compact markers, or hover for available route, destination and consist details.
    • +
  • Compact station, platform and depot icons stay inside the fullscreen map. They do not fill the ordinary Xaero waypoint list, compass, minimap or in-world HUD.
    • +
  • Independent TRACKS and ROUTES controls let you explore each layer in either map.
    • +
+ +

New in 1.5.3: station arrivals and PIDS

+ +

Click a station to pin its classic information card. Choose Expand for native MTR/TSC arrivals by destination, line and platform. The board starts collapsed; missing predictions are shown explicitly.

+ +

Choose British black/amber PIDS or European/airport styling. /mtrmap config pidsStyle british|european changes and saves the theme. Collapsing the board or closing the map releases its arrival subscription.

+ +

Ready for navigation extensions

+ +

A public API lets other mods read native network data, subscribe to station boards and control independent map views. Registered providers enable Navigate on station cards. A navigation mod supplies planning and progress; Overlay can highlight upcoming sections while separately dimming completed and unused tracks.

+ +

No navigation provider is bundled. Developer API guide.

+ +

Compatibility

+ + + + + + + + +
MinecraftLoaderJavaMTRMap versions
1.21.1NeoForge 21.1.x / Fabric + Fabric API214.1.0-beta.2Xaero's World Map 1.45.0+ / JourneyMap 6.0.8+
1.20.1Forge 47.x / Fabric + Fabric API17+4.0.5 (>=4.0.5, <4.1)Xaero's World Map 1.45.0+ / JourneyMap 6.0.6+
1.20.4Forge 49.x / Fabric + Fabric API17+4.0.5 (>=4.0.5, <4.1)Xaero's World Map 1.45.0+ / JourneyMap 5.10.0
+ +

Choose the exact Minecraft and loader combination; the six JAR filenames include the tested MTR version. Fabric needs the matching Fabric API. Install either supported map or both, using the same game version and loader. These are three specific Minecraft versions, not every version between 1.20.1 and 1.21.1.

+ +

Client and server setup

+ +
    +
  • Install one matching Overlay JAR, MTR and a supported fullscreen map on the client.
    • +
  • For the full rail network, whole-map live trains and native station arrivals, install matching Overlay and MTR on the server too. The server does not need a map mod.
    • +
  • Client-only installations use nearby data already sent by MTR. Native station arrivals require matching 1.5.3 server support.
    • +
  • Use /mtrmap config trainCars false to hide the live train layer. Train-hover next-stop distance and ETA are not included; station arrivals are a separate feature.
    • +
+ +

Links and support

+ +

Website and documentation · Source and issues · Release notes

+ +

Support development on Ko-fi or Afdian.

+ +

MIT licensed. Original attribution is retained in the project license. Developed independently for Minecraft Transit Railway.

diff --git a/docs/distribution/1.5.3/curseforge.zh-CN.html b/docs/distribution/1.5.3/curseforge.zh-CN.html new file mode 100644 index 0000000..2ac1827 --- /dev/null +++ b/docs/distribution/1.5.3/curseforge.zh-CN.html @@ -0,0 +1,56 @@ +

MTR Map Overlay

+ +

在 Xaero 世界地图与 JourneyMap 中查看你的 Minecraft Transit Railway 路网：彩色路线、真实轨道、运行列车和原生站点到站预测。

+ +

体验 v1.5.3 预发布版，或选择 v1.5.2 稳定版。

+ +

看清整个铁路网络

+ +
    +
  • 真实轨道几何与线路色带跟随 MTR 路网；共线轨道并排显示颜色，轻铁更纤细，高铁采用彩白交替块。
    • +
  • 全图实时列车显示当前查看维度中远离玩家的运行车辆。缩远显示紧凑图标，悬停可读取已有线路、终点与编组信息。
    • +
  • 车站、站台和车辆段图标仅显示在全屏地图内，不挤占普通 Xaero 路标列表、指南针、小地图或游戏内 HUD。
    • +
  • 两种地图均提供独立的 TRACKS／ROUTES 控件，按需查看图层。
    • +
+ +

1.5.3 新增：站点预测与 PIDS

+ +

点击车站固定原信息框，选择 Expand，按目的地、线路与站台查看 MTR/TSC 原生预测。默认折叠，预测缺失时明确提示。

+ +

可选英式黑底琥珀字或欧式／机场风格。/mtrmap config pidsStyle british|european 即时切换并保存；折叠到站板或关闭地图后释放预测订阅。

+ +

支持导航扩展

+ +

公共 API 允许第三方模组读取原生路网、订阅到站板和控制独立地图视图。注册服务后启用站点 Navigate 入口。导航模组负责规划和行程进度，Overlay 可高亮待乘区段，分别淡化已走及未用轨道。

+ +

当前不捆绑导航服务。开发者 API 指南。

+ +

兼容平台

+ + + + + + + + +
MinecraftLoaderJavaMTRMap versions
1.21.1NeoForge 21.1.x / Fabric + Fabric API214.1.0-beta.2Xaero's World Map 1.45.0+ / JourneyMap 6.0.8+
1.20.1Forge 47.x / Fabric + Fabric API17+4.0.5 (>=4.0.5, <4.1)Xaero's World Map 1.45.0+ / JourneyMap 6.0.6+
1.20.4Forge 49.x / Fabric + Fabric API17+4.0.5 (>=4.0.5, <4.1)Xaero's World Map 1.45.0+ / JourneyMap 5.10.0
+ +

请按精确 Minecraft 版本和加载器选择附件，六个 JAR 文件名包含已测试 MTR 版本。Fabric 还需对应 Fabric API。两种地图可选其一或同时安装，必须匹配游戏版本及加载器。支持的是上述三个具体版本，不代表 1.20.1 到 1.21.1 间每个版本都可用。

+ +

客户端与服务端安装

+ +
    +
  • 客户端安装一个匹配的 Overlay JAR、MTR，以及支持的全屏地图模组。
    • +
  • 如需完整路网、全图实时列车及原生站点预测，服务端也要安装匹配的 Overlay 与 MTR；服务器不需要地图模组。
    • +
  • 纯客户端使用 MTR 已下发的附近数据；原生站点预测需要匹配的 1.5.3 服务端支持。
    • +
  • /mtrmap config trainCars false 隐藏实时列车。列车悬停暂不含下一站距离或 ETA，站点到站板是独立功能。
    • +
+ +

链接与支持

+ +

官网与文档 · 源码与问题反馈 · 发布说明

+ +

欢迎通过 Ko-fi 或爱发电支持开发。

+ +

本项目采用 MIT 许可证，保留原作者版权声明，为 Minecraft Transit Railway 独立开发。

diff --git a/docs/distribution/1.5.3/modrinth.md b/docs/distribution/1.5.3/modrinth.md new file mode 100644 index 0000000..ba5f67f --- /dev/null +++ b/docs/distribution/1.5.3/modrinth.md @@ -0,0 +1,49 @@ +# MTR Map Overlay + +Your Minecraft Transit Railway network, inside Xaero's World Map and JourneyMap: coloured routes, real rails, moving trains and native station arrivals. + +Explore [v1.5.3 pre-release](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.3), or use [v1.5.2 stable](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.2). + +## See your railway network + +- Physical rail geometry and route-coloured ribbons follow the MTR network. Shared tracks show parallel colours; light rail is slimmer and high speed uses colour/white blocks. +- Whole-map live trains show moving carriages throughout the viewed dimension, even far from players. Zoom out for compact markers, or hover for available route, destination and consist details. +- Compact station, platform and depot icons stay inside the fullscreen map. They do not fill the ordinary Xaero waypoint list, compass, minimap or in-world HUD. +- Independent TRACKS and ROUTES controls let you explore each layer in either map. + +## New in 1.5.3: station arrivals and PIDS + +Click a station to pin its classic information card. Choose **Expand** for native MTR/TSC arrivals by destination, line and platform. The board starts collapsed; missing predictions are shown explicitly. + +Choose British black/amber PIDS or European/airport styling. `/mtrmap config pidsStyle british|european` changes and saves the theme. Collapsing the board or closing the map releases its arrival subscription. + +## Ready for navigation extensions + +A public API lets other mods read native network data, subscribe to station boards and control independent map views. Registered providers enable **Navigate** on station cards. A navigation mod supplies planning and progress; Overlay can highlight upcoming sections while separately dimming completed and unused tracks. + +No navigation provider is bundled. [Developer API guide](https://github.com/teamCreating/MTR-Map-Overlay/blob/main/docs/api/overlay-api-v1.md). + +## Compatibility + +| Minecraft | Loader | Java | MTR | Map versions | +| --- | --- | --- | --- | --- | +| 1.21.1 | NeoForge 21.1.x / Fabric + Fabric API | 21 | 4.1.0-beta.2 | Xaero's World Map 1.45.0+ / JourneyMap 6.0.8+ | +| 1.20.1 | Forge 47.x / Fabric + Fabric API | 17+ | 4.0.5 (>=4.0.5, <4.1) | Xaero's World Map 1.45.0+ / JourneyMap 6.0.6+ | +| 1.20.4 | Forge 49.x / Fabric + Fabric API | 17+ | 4.0.5 (>=4.0.5, <4.1) | Xaero's World Map 1.45.0+ / JourneyMap 5.10.0 | + +Choose the exact Minecraft and loader combination; the six JAR filenames include the tested MTR version. Fabric needs the matching Fabric API. Install either supported map or both, using the same game version and loader. These are three specific Minecraft versions, not every version between 1.20.1 and 1.21.1. + +## Client and server setup + +- Install one matching Overlay JAR, MTR and a supported fullscreen map on the client. +- For the full rail network, whole-map live trains and native station arrivals, install matching Overlay and MTR on the server too. The server does not need a map mod. +- Client-only installations use nearby data already sent by MTR. Native station arrivals require matching 1.5.3 server support. +- Use `/mtrmap config trainCars false` to hide the live train layer. Train-hover next-stop distance and ETA are not included; station arrivals are a separate feature. + +## Links and support + +[Website and documentation](https://mtrmapoverlay.benli06.site/en/) · [Source and issues](https://github.com/teamCreating/MTR-Map-Overlay) · [Release notes](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.3) + +Support development on [Ko-fi](https://ko-fi.com/Z8C424REOO) or [Afdian](https://afdian.com/a/benli06). + +MIT licensed. Original attribution is retained in the project license. Developed independently for Minecraft Transit Railway. diff --git a/docs/distribution/1.5.3/modrinth.zh-CN.md b/docs/distribution/1.5.3/modrinth.zh-CN.md new file mode 100644 index 0000000..b7f243d --- /dev/null +++ b/docs/distribution/1.5.3/modrinth.zh-CN.md @@ -0,0 +1,49 @@ +# MTR Map Overlay + +在 Xaero 世界地图与 JourneyMap 中查看你的 Minecraft Transit Railway 路网：彩色路线、真实轨道、运行列车和原生站点到站预测。 + +体验 [v1.5.3 预发布版](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.3)，或选择 [v1.5.2 稳定版](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.2)。 + +## 看清整个铁路网络 + +- 真实轨道几何与线路色带跟随 MTR 路网；共线轨道并排显示颜色，轻铁更纤细，高铁采用彩白交替块。 +- 全图实时列车显示当前查看维度中远离玩家的运行车辆。缩远显示紧凑图标，悬停可读取已有线路、终点与编组信息。 +- 车站、站台和车辆段图标仅显示在全屏地图内，不挤占普通 Xaero 路标列表、指南针、小地图或游戏内 HUD。 +- 两种地图均提供独立的 TRACKS／ROUTES 控件，按需查看图层。 + +## 1.5.3 新增：站点预测与 PIDS + +点击车站固定原信息框，选择 **Expand**，按目的地、线路与站台查看 MTR/TSC 原生预测。默认折叠，预测缺失时明确提示。 + +可选英式黑底琥珀字或欧式／机场风格。`/mtrmap config pidsStyle british|european` 即时切换并保存；折叠到站板或关闭地图后释放预测订阅。 + +## 支持导航扩展 + +公共 API 允许第三方模组读取原生路网、订阅到站板和控制独立地图视图。注册服务后启用站点 **Navigate** 入口。导航模组负责规划和行程进度，Overlay 可高亮待乘区段，分别淡化已走及未用轨道。 + +当前不捆绑导航服务。[开发者 API 指南](https://github.com/teamCreating/MTR-Map-Overlay/blob/main/docs/api/overlay-api-v1.md)。 + +## 兼容平台 + +| Minecraft | Loader | Java | MTR | Map versions | +| --- | --- | --- | --- | --- | +| 1.21.1 | NeoForge 21.1.x / Fabric + Fabric API | 21 | 4.1.0-beta.2 | Xaero's World Map 1.45.0+ / JourneyMap 6.0.8+ | +| 1.20.1 | Forge 47.x / Fabric + Fabric API | 17+ | 4.0.5 (>=4.0.5, <4.1) | Xaero's World Map 1.45.0+ / JourneyMap 6.0.6+ | +| 1.20.4 | Forge 49.x / Fabric + Fabric API | 17+ | 4.0.5 (>=4.0.5, <4.1) | Xaero's World Map 1.45.0+ / JourneyMap 5.10.0 | + +请按精确 Minecraft 版本和加载器选择附件，六个 JAR 文件名包含已测试 MTR 版本。Fabric 还需对应 Fabric API。两种地图可选其一或同时安装，必须匹配游戏版本及加载器。支持的是上述三个具体版本，不代表 1.20.1 到 1.21.1 间每个版本都可用。 + +## 客户端与服务端安装 + +- 客户端安装一个匹配的 Overlay JAR、MTR，以及支持的全屏地图模组。 +- 如需完整路网、全图实时列车及原生站点预测，服务端也要安装匹配的 Overlay 与 MTR；服务器不需要地图模组。 +- 纯客户端使用 MTR 已下发的附近数据；原生站点预测需要匹配的 1.5.3 服务端支持。 +- `/mtrmap config trainCars false` 隐藏实时列车。列车悬停暂不含下一站距离或 ETA，站点到站板是独立功能。 + +## 链接与支持 + +[官网与文档](https://mtrmapoverlay.benli06.site/zh/) · [源码与问题反馈](https://github.com/teamCreating/MTR-Map-Overlay) · [发布说明](https://github.com/teamCreating/MTR-Map-Overlay/releases/tag/v1.5.3) + +欢迎通过 [Ko-fi](https://ko-fi.com/Z8C424REOO) 或[爱发电](https://afdian.com/a/benli06)支持开发。 + +本项目采用 MIT 许可证，保留原作者版权声明，为 Minecraft Transit Railway 独立开发。 diff --git a/docs/distribution/1.5.3/summaries.md b/docs/distribution/1.5.3/summaries.md new file mode 100644 index 0000000..564e02a --- /dev/null +++ b/docs/distribution/1.5.3/summaries.md @@ -0,0 +1,13 @@ +# Short summaries + +## English — Modrinth / CurseForge + +MTR routes, rails, live trains and native station arrivals on Xaero's World Map and JourneyMap, with British/European PIDS and a navigation API. + +## 简体中文 + +在 Xaero 世界地图与 JourneyMap 中显示 MTR 路线、轨道、全图实时列车和原生站点预测，提供英式／欧式 PIDS 与导航扩展 API。 + +## Version status + +Checked 2026-10-31: GitHub marks 1.5.3 as a pre-release; 1.5.2 is the latest stable release. These files describe 1.5.3 and must not be assigned to 1.5.2 uploads. No Modrinth or CurseForge description has been published by this task.