Dynmap® 技术文档

1. 安装指南

1.1 环境要求

• JDK 版本: Dynmap 3.x+ 需要 JDK 21 进行构建。对于不同版本的 Minecraft，所需的 JDK 版本如下：
  • Minecraft 1.16 及更早版本：JDK 8
  • Minecraft 1.17.x：JDK 16
  • Minecraft 1.18 至 1.20.4：JDK 17
  • Minecraft 1.20.5+：JDK 21

1.2 构建步骤

1. 打开终端或命令提示符。
2. 导航到项目根目录。
3. 运行以下命令以构建项目：
   • 在 Linux/Mac 上：

     ./gradlew setup build
     

   • 在 Windows 上：

     gradlew.bat setup build
     

4. 构建完成后，生成的 JAR 文件将位于 target/ 目录中。

1.3 特定版本的构建

• 对于 Forge 1.12.2 版本，需要使用 JDK 8 进行构建。请按照以下步骤操作：
  1. 设置 JAVA_HOME 环境变量为 JDK 8 的安装路径。
  2. 导航到 oldgradle 目录。
  3. 运行以下命令：
     • 在 Linux/Mac 上：

       ./gradlew setup build
       

     • 在 Windows 上：

       gradlew.bat setup build
       

2. 项目的使用说明

2.1 支持的平台

Dynmap 支持以下 Minecraft 服务器类型和版本：

• Spigot/PaperMC: ≤1.20.6
• Forge: 1.12.2 - 1.20.x
• Fabric: 1.15.2 - 1.20.x

2.2 数据存储

Dynmap 支持多种数据存储后端：

• Flat files: 默认存储方式。
• MySQL: 需要 MySQL 驱动。
• SQLite: 需要 SQLite 驱动。
• PostgreSQL: 驱动已包含在 Dynmap JAR 中。
• MariaDB: 兼容 MySQL，设置 storage-type 为 mysql。
• AWS S3: 支持将 S3 桶用作存储和网站托管。

2.3 贡献代码

• 贡献代码时，请遵循以下规则：
  • PR 应尽可能小，避免多个功能合并到一个 PR 中。
  • 不要进行格式化或样式更改。
  • 不要修改核心代码，除非你准备在所有支持的平台上进行构建和测试。
  • 不要引入平台特定的依赖或命令行行为。
  • 代码必须兼容 Apache Public License v2。

3. 项目API使用文档

3.1 API 概述

Dynmap 提供了丰富的 API，允许其他插件或模组与其进行交互。API 主要分为以下几类：

• DynmapCoreAPI: 核心 API，提供基础功能。
• Dynmap-API: 用于与其他插件或模组进行交互的 API。

3.2 API 使用示例

以下是一个简单的 API 使用示例，展示如何通过 API 获取地图数据：

import org.dynmap.DynmapAPI;
import org.dynmap.DynmapCore;

public class ExamplePlugin {
    private DynmapAPI dynmapAPI;

    public void onEnable() {
        dynmapAPI = (DynmapAPI) getServer().getPluginManager().getPlugin("dynmap");
        if (dynmapAPI != null) {
            // 获取地图数据
            dynmapAPI.getMap("world");
        }
    }
}

4. 项目安装方式

4.1 安装步骤

1. 下载适用于你服务器类型的 Dynmap JAR 文件。
2. 将 JAR 文件放入服务器的 plugins 或 mods 目录中。
3. 启动服务器，Dynmap 将自动加载。

4.2 配置文件

• Dynmap 的配置文件位于 plugins/dynmap/ 或 mods/dynmap/ 目录中。
• 主要配置文件为 configuration.txt，可以根据需要进行修改。

4.3 启动与测试

• 启动服务器后，访问 http://<服务器IP>:8123 即可查看 Dynmap 生成的动态地图。

通过以上步骤，你可以成功安装并使用 Dynmap 插件，享受动态地图带来的便利。