SquareTowny

插件

· 作者 ftyeaz

SquareTowny 是一个 Spigot 插件,作为 Towny 的附加组件运行。此仓库是 Squaremap 导向的定制版 Fork,基于 TownyAdvanced/MapTowny

0 本站下载 0 关注 更新于 1 个月前

需要前置:squaremap、Towny

最新 1.1 · 26.3 · Paper / Purpur

一键开服(送7天)

厌倦了 squaremap 上所有 Towny 领地都是同一种颜色、根本分不清谁是谁? 试试 SquareTowny —— 每个城镇都有专属颜色,同一国家的城镇同色,领土范围一眼就能看清。

Tired of every Towny claim looking the same on squaremap? Try SquareTowny — each town gets its own color, towns in the same nation share one, and territory becomes clear at a glance.

SquareTowny

English · 简体中文

SquareTowny 是一个 Spigot 插件,作为 Towny 的附加组件运行。它将每个城镇的领地渲染到网页地图上,让玩家可以直接在地图上查看每个城镇(及国家)的领土范围。

本仓库是 TownyAdvanced/MapTowny(最初由 Silverwolfg11 开发,采用 MIT 许可证)的一个 面向 squaremap 定制的分支,主要变更如下:

  • 自动区分颜色 (新功能):每个城镇都会使用其专属颜色进行渲染,同一国家的城镇共享相同颜色。
  • 移除 maptowny-pl3xmap-v2 和 maptowny-pl3xmap-v3 模块,因为它们的构建依赖不再发布在 Modrinth 的 Maven 仓库中,无法解析。
  • 目前支持的网页地图有:squaremap、dynmap、BlueMap 和 Pl3xMap v1(squaremap 为主要目标)。

功能特性

  • 每个城镇获得一个 视觉上独特的颜色(自动生成)。属于同一个 国家的城镇共享一种颜色,因此国界线一目了然。
  • 在 Towny 中手动设置的颜色(/town set mapcolor、/nation set mapcolor)始终优先于自动生成的颜色。
  • 可配置的标记选项:填充/描边颜色、透明度、描边宽度、图标等。
  • 完全异步处理;服务器线程永远不会被阻塞。
  • 支持多种网页地图:squaremap、dynmap、BlueMap(有限支持)、Pl3xMap v1。
  • 经过单元测试的多边形轮廓(contour)和负空间(孔洞查找)算法。

支持的网页地图

地图 版本 支持情况
squaremap 当前版本 完整支持(主要目标)
dynmap 当前版本 完整支持
BlueMap v3.3+ 有限支持
Pl3xMap v1 v1 (对于 1.18+ 请使用此 fork) 完整支持

依赖项

  • Towny 0.97.1 或更高版本 (必需)
  • 上述网页地图插件之一 (必需)

安装

  1. 将插件 jar 包 (maptowny-plugin/target/SquareTowny-1.0.jar) 放入服务器的 plugins 文件夹中。
  2. 重启服务器。将会生成一个 SquareTowny/config.yml 文件。
  3. 将 enabled-worlds 选项设置为你希望显示城镇领地的世界名称。

使用与配置

该插件开箱即用。最常见的调整是 enabled-worlds。

命令

命令 描述 权限
/maptowny reload 重新加载配置文件并重新渲染所有城镇 maptowny.reload
/maptowny render <town> 渲染单个城镇 maptowny.render
/maptowny unrender <城镇或UUID> 从地图中移除一个城镇 maptowny.unrender

所有命令都需要 maptowny.use 权限(默认:op)。maptowny.admin 权限授予上述所有权限。

配置选项 (config.yml)

选项 默认值 描述
enabled-worlds ["world"] 显示城镇领地范围的维度
update-period 5 所有城镇重新渲染的间隔时间(分钟)
layer.* — 图层名称、可见性控制、优先级、z-index
fill-style.fill-color "#3388ff" 默认填充颜色
fill-style.fill-opacity 0.2 填充透明度
fill-style.use-nation-color-fill true 使用国家的颜色来填充领地范围
fill-style.stroke-color "#3388ff" 默认描边颜色

| fill-style.use-town-color-fill | false | 使用城镇自身的颜色(优先于国家颜色) | | fill-style.use-auto-colors | true | 自动配色(此分支):为每个城镇/国家分配不同的颜色 | | icon-info.* | — | 城镇 / 首都 / 前哨站的图标图片及尺寸 |

自动颜色如何工作

  • 一个没有国家的城镇会获得一种基于其 UUID(在重启后保持稳定)生成的独特颜色。
  • 所有属于同一国家的城镇共享相同的颜色,该颜色基于国家的 UUID 生成。
  • 如果在 Towny 中为城镇或其国家手动设置了颜色,则优先使用手动设置的颜色。
  • 颜色会在下一次周期性重新渲染时自动更新(或通过执行 /maptowny reload 命令立即更新)。

插件 API

SquareTowny 提供了一个小型 API(maptowny-api 模块),供其他插件进行集成。详情请参阅原项目的 wiki。

构建

这是一个标准的 Maven 多模块项目,使用了 maven-toolchains-plugin。各模块针对不同 JDK 版本进行编译:

模块 JDK 目标版本
maptowny-api, maptowny-plugin, maptowny-dynmap 8
maptowny-bluemap 11
maptowny-squaremap, maptowny-pl3xmap-v1 16

两种构建方式:

  1. 标准工具链 — 配置 ~/.m2/toolchains.xml 以包含 JDK 8、11 和 16(参见工具链指南),然后运行 mvn clean package。
  2. 单一现代 JDK(已包含) — 本仓库提供了一个 toolchains-local.xml 文件,将每个所需版本映射到一个 JDK(21 或更高版本)。编辑 jdkHome 路径以指向你的 JDK,然后运行:
   mvn -t toolchains-local.xml clean package

完成的插件 jar 文件位于 maptowny-plugin/target/SquareTowny-1.0.jar。

许可证

MIT。此分支保留了上游项目的原始 MIT 许可证和版权声明。欢迎提交拉取请求(Pull Requests)。


简体中文

厌倦了 Squaremap 上所有 Towny 领地都是同一种颜色、根本分不清谁是谁? 试试 SquareTowny —— 每个城镇都有专属颜色,同一国家的城镇同色,领土范围一眼就能看清。

项目简介

SquareTowny 是一个基于 Spigot 的插件,作为 Towny 的扩展,把每个城镇的领地范围渲染到网页地图上,玩家可以直接在地图上看到各个城镇(以及国家)的领土。

本仓库是 TownyAdvanced/MapTowny(原作者 Silverwolfg11,MIT 协议)的面向 squaremap 的定制分支,主要改动如下:

  • 自动配色(新增功能):每个城镇在地图上显示不同的颜色,同一国家的城镇颜色相同。
  • 移除了 maptowny-pl3xmap-v2 和 maptowny-pl3xmap-v3 模块——这两个模块的构建依赖已从 Modrinth 的 Maven 仓库下架,无法再解析。
  • 目前支持的地图插件为:squaremap、dynmap、BlueMap 和 Pl3xMap v1(squaremap 为主要目标)。

功能特性

  • 每个城镇自动生成独一无二的颜色;同一国家内的城镇共用同一种颜色,国家边界一目了然。
  • Towny 中手动设置的颜色(/town set mapcolor、/nation set mapcolor)始终优先于自动颜色。
  • 可配置的标记样式:填充/描边颜色、透明度、描边粗细、图标等。
  • 全异步处理,不阻塞主线程。
  • 同时支持多种网页地图:squaremap、dynmap、BlueMap(支持有限)、Pl3xMap v1。
  • 附带单元测试的多边形轮廓算法与负空间("找洞")算法。

支持的地图插件

地图 版本 支持程度
squaremap 最新 完整(主要目标)
dynmap 最新 完整
BlueMap v3.3+ 有限
Pl3xMap v1 v1(1.18+ 请用这个分支) 完整

依赖

  • Towny 0.97.1 及以上(必需)
  • 上表中的一个网页地图插件(必需)

安装

  1. 把插件 jar(maptowny-plugin/target/SquareTowny-1.0.jar)放入服务器的 plugins 目录。
  2. 重启服务器,会自动生成 SquareTowny/config.yml。
  3. 把 enabled-worlds 改成你想显示领地范围的世界名。

使用与配置

开箱即用,最常需要调整的是 enabled-worlds。

命令

命令 说明 权限
/maptowny reload 重载配置并重新渲染所有城镇 maptowny.reload
/maptowny render <城镇名> 渲染指定城镇 maptowny.render
/maptowny unrender <城镇名或UUID> 从地图上移除指定城镇 maptowny.unrender

所有命令都需要 maptowny.use(默认 op);maptowny.admin 包含以上所有权限。

配置项(config.yml)

配置项 默认值 说明
enabled-worlds ["world"] 显示领地范围的世界
update-period 5 全量重渲染周期(分钟)
layer.* — 图层名称、显示开关、优先级、z-index
fill-style.fill-color "#3388ff" 默认填充色
fill-style.fill-opacity 0.2 填充不透明度
fill-style.use-nation-color-fill true 用国家颜色填充领地
fill-style.stroke-color "#3388ff" 默认描边色
fill-style.use-town-color-fill false 用城镇自己的颜色(优先于国家色)
fill-style.use-auto-colors true 自动配色(本分支新增):让每个城镇/国家颜色各不相同
icon-info.* — 城镇/首都/前哨站图标及尺寸

自动配色说明

  • 没有国家的城镇:按城镇 UUID 生成独一无二的颜色(重启后保持稳定)。
  • 同一国家内的城镇:共用同一种颜色(按国家 UUID 生成)。
  • 城镇或国家在 Towny 中手动设置过颜色时,使用手动颜色。
  • 颜色会在下一次周期重渲染时自动更新(或执行 /maptowny reload)。

插件 API

SquareTowny 提供小型 API(maptowny-api 模块)供其他插件集成,详见原项目的 Wiki。

构建

这是一个标准 Maven 多模块项目,使用 maven-toolchains-plugin 针对不同 JDK 版本编译各模块:

模块 JDK 目标
maptowny-api、maptowny-plugin、maptowny-dynmap 8
maptowny-bluemap 11
maptowny-squaremap、maptowny-pl3xmap-v1 16

两种构建方式:

  1. 标准 toolchains:在 ~/.m2/toolchains.xml 中配置 JDK 8、11、16(参考 toolchains 指南),然后执行 mvn clean package。

  2. 单一现代 JDK(仓库自带配置):本仓库附带了 toolchains-local.xml,把所有需要的版本映射到同一个 JDK(21 或更新)。把其中 jdkHome 改成你本机的 JDK 路径后执行:

    mvn -t toolchains-local.xml clean package
    

构建产物为 maptowny-plugin/target/SquareTowny-1.0.jar。

许可证

MIT。本分支保留上游项目的 MIT 许可证与版权声明,欢迎提交 Pull Request。

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源