MapCatalog

<!-- 中文 -->

# MapCatalog —— Not-a-Good-Mod-for-Survival 的服务器端组件

MapCatalog 是一个只装在服务器上的轻量 Fabric 模组，专门为 Not-a-Good-Mod-for-Survival 的 「地图目录 (Map Catalog)」功能提供服务器一侧的支持。

装了它之后，服务器就能把存档里所有地图的信息告诉客户端，玩家在自己的地图上就能看到它们。

## 地图画制作者的快速查表

做地图画（像素画）最费时间的部分，是把地图编号和它对应的实际坐标对上号。 有了地图目录之后：

• 直接看到每张地图的编号、中心坐标与覆盖范围，不用再逐张拿在手里打开确认。
• 世界地图上画出每张地图的覆盖边框，一眼看出这块地归哪张地图、和画框墙对不对得上。

## 装上之后玩家能看到什么

搭配 Not-a-Good-Mod-for-Survival（并配合 Xaero's World Map）使用时：

• 一整份地图目录：不用再亲手打开每一张地图，服务器存档里存在的地图会直接列成清单，

包含所在维度、中心位置、缩放等级与覆盖范围。

• 世界地图上的覆盖边界：每张地图覆盖的方块范围会以边框画在地图上，不同缩放等级不同颜色，

还能显示地图编号，一眼看出"这一片被哪张地图记下来了"。

• 地图上的旗帜标记：别人插在地图上的旗帜会带颜色、名字和坐标显示出来，方便定位基地和据点。
• 跨维度可见：下界、末地、自定义维度里的地图同样能被发现，不必先跑过去。
• 列表会自动更新：新做的地图、改动过的旗帜，之后会自己出现在目录里，不用重连。

## 我需要装它吗

• 单人游戏 / 自己的存档：不需要。Not-a-Good-Mod-for-Survival 在单人游戏里开箱即用。
• 联机服务器：需要，而且是由服务器管理员安装在服务端。你在客户端做不了任何设置。

如果你在服务器上想要地图目录功能，请把本页链接发给服主。

• 模组作者：可以基于这套同步协议实现你自己的客户端地图模组。

## 服务器管理员：为什么要给服务器装

• 不改变任何玩法。 不添加机制、不修改原版行为、不动存档内容，

它只把"存在哪些地图"这件事告诉客户端。

• 几乎零开销。 服务器不会把地图图像数据发给玩家，只发送极小的目录信息，

几百张地图的存档也不会占带宽。

• 对没装配套模组的玩家完全无感。 原版客户端、只装了小地图的客户端都不会收到任何多余内容。
• 可管理。 是否启用、谁能使用、是否只同步当前维度，都由服务端配置掌握在你手里。

## 安装与兼容性

• 服务端安装，客户端不需要安装本模组。
• 依赖：Fabric、Fabric API、Java 21+。
• 与 Not-a-Good-Mod-for-Survival 同作者的 Carpet JFT Addition 已内置本模组，

装了它就不必再单独安装，二者二选一。

• 开源许可：MIT。

---

<!-- English -->

# MapCatalog — the server-side companion to Not-a-Good-Mod-for-Survival

MapCatalog is a lightweight, server-side only Fabric mod that powers the Map Catalog feature of Not-a-Good-Mod-for-Survival. It lets a server tell clients about every map stored in the world, so those maps show up right on your own map.

## A lookup table for map-art makers

The slowest part of making map art is matching a map number to the coordinates it actually covers. With the map catalogue available:

• See each map's number, centre position and coverage directly, instead of holding one up and

opening it over and over.

• Coverage outlines are drawn on the world map, so you can check at a glance which map owns a

patch of land and whether it lines up with your painting wall.

## What players actually see

Used together with Not-a-Good-Mod-for-Survival (displayed inside Xaero's World Map):

• A complete map list. No more opening maps one by one — every map saved on the server is

listed with its dimension, centre position, zoom level and coverage.

• Coverage borders on your world map. Each map's covered area is drawn as an outline, coloured

per zoom level, optionally with map numbers, so you can see at a glance which map covers which land.

• Banner markers from other players' maps. Flags appear with colour, name and coordinates —

great for finding bases and outposts.

• Every dimension. Nether, End and custom-dimension maps are discoverable without travelling there.
• It stays fresh. Maps crafted later and banners edited later show up on their own.

## Do you need it?

• Singleplayer / your own worlds: no. Not-a-Good-Mod-for-Survival already works out of the box.
• Multiplayer servers: yes — and it is installed by the server admin on the server side.

There is nothing you can switch on from the client, so send this page to your server owner.

• Mod authors: you can build your own client-side map mod on top of this sync protocol.

## For server admins: why add it

• No gameplay changes. No new mechanics, no vanilla behaviour altered, no world edits —

it only reports which maps exist.

• Negligible overhead. Map image data is never sent to players; only tiny catalogue information,

even on worlds holding hundreds of maps.

• Invisible to players without the companion mod. Vanilla clients receive nothing extra.
• Admin-controlled. Whether it is on, who may use it, and whether to limit it to the player's

current dimension all stay in your hands.

## Installation & compatibility

• Install on the server; players do not install this mod on their client.
• Requires: Fabric Loader, Fabric API, Java 21+.
• Carpet JFT Addition by the same author already bundles MapCatalog — use it or install this

standalone file, not both.

• License: MIT.