NeoEssentials

NeoEssentials

一款为Minecraft NeoForge服务器设计的全面服务端基础模组，灵感来源于Bukkit/Spigot的EssentialsX。

NeoEssentials

Minecraft NeoForge License Version Discord Ko-fi

NeoEssentials 是一款面向 Minecraft NeoForge 1.21.1 - 1.21.11 服务器的全面、配置驱动的 essentials 模组。它提供 50+ 命令、GUI 工具、高级管理和实时 Web 仪表板——全部由模块化 JSON 配置文件管理，并配有标准化文档。

🌟 概览

NeoEssentials 为 NeoForge 服务器带来了必备的服务器管理、玩家实用工具和高级管理功能。所有功能均有严格文档记录，并由配置文件驱动，以确保可靠性和透明度。

仅服务端：无需安装客户端，兼容原版客户端。 50+ 命令：覆盖所有主要服务器功能、实用工具和审核管理。 现代 UI：GUI 命令、颜色代码支持和 Web 仪表板。

✨ 核心系统与功能

  • 经济系统：玩家余额、转账、礼包和商店支持。
  • 聊天与消息：私信、邮件、隐身/社交监听、离开（AFK）系统。
  • 审核管理：封禁、踢出、禁言、监禁、隐身、冻结、模拟命令、玩家数据。
  • 传送系统：家、传送点、出生点、传送请求、返回系统。
  • 礼包管理：可配置的物品礼包，支持冷却时间和预览。
  • Web 仪表板：实时服务器监控、配置文件编辑、API 端点。
  • 权限系统：支持 LuckPerms、FTB Ranks 及内置权限。
  • 物品管理：物品生成、修复、附魔、清空背包、多功能工具。
  • 实用系统：昵称、MOTD、附近、延迟、深度、求助、规则、自杀等。
  • API 与占位符系统：PlaceholderAPI 集成、自定义占位符、REST API 端点。

📖 文档

从 主页 开始，获取完整的、配置驱动的文档中心。所有主要系统都有文档记录，并与代码库和配置文件保持标准化一致：

参见 API 系统 了解 API 与占位符系统的详细信息，包括：

  • 用于动态文本的 PlaceholderAPI 集成
  • 自定义与扩展占位符
  • 用于服务器状态、玩家信息、日志、配置、事件和统计的 Web 仪表板 REST API 端点
  • 适用于 API 功能的权限和配置选项

🚀 快速开始

安装

  1. 下载最新版本 Version
  2. 将 JAR 文件放入服务器的 mods 文件夹中
  3. 启动服务器以在 config/neoessentials/ 中生成配置文件
  4. 根据需要配置权限和功能
  5. 重启服务器以应用更改

基本配置文件

config/neoessentials/
├── config.json           # 主配置设置
├── permissions.json      # 权限系统设置
├── language/             # 语言文件目录
├── shops.json            # 商店系统配置
└── settings.json         # 附加模组设置

快速权限设置

对于 LuckPerms 用户：

/lp group admin permission set neoessentials.admin true
/lp group moderator permission set neoessentials.moderator true
/lp group default permission set neoessentials.player true

🎮 命令参考

请参阅 主页 和上述各系统文档，获取完整命令列表和配置选项。

🔧 配置示例

所有功能均由模块化 JSON 配置文件管理。请参阅 主页 和上述系统文档了解详情。

🔗 针对模组开发者的 API 集成

请参阅 API 系统 获取完整的 API 和 PlaceholderAPI 文档，包括：

  • 注册自定义占位符
  • 使用 REST API 端点获取服务器数据
  • 用于模组集成的经济 API

🔗 集成与兼容性

  • 支持 LuckPerms 和 FTB Ranks
  • 仅服务端（不需要客户端模组）
  • 支持原版客户端
  • 性能优化

🛠️ 开发

IDE 设置

本项目使用 IntelliJ IDEA Community Edition 和 Gradle。

设置说明：

  1. 克隆仓库
  2. 在 IntelliJ IDEA 中打开项目
  3. 作为 Gradle 项目导入
  4. 等待 Gradle 同步并下载依赖
  5. IDE 已配置为自动下载源码和 javadocs

运行模组：

  • 使用 NeoForge ModDev 提供的 Gradle 运行配置
  • runClient — 在客户端模式下测试
  • runServer — 在服务器模式下测试
  • runData — 生成数据资源

构建：

./gradlew build

输出 JAR：build/libs/neoessentials-VERSION+build.XXX.jar

项目结构

  • Java 21 — 目标 JDK 版本
  • Gradle — 带有自动递增构建号的构建系统
  • NeoForge ModDev 2.0.107 — 现代模组开发插件
  • Parchment Mappings — 提供更好的参数名称和 javadocs

🤝 支持与社区

  • Discord： 加入我们的 Discord 服务器 以获取支持和社区讨论
  • Bug 报告： 通过 GitHub 或 Discord 报告问题和错误
  • 功能请求： 建议新功能和改进
  • 文档： 请参阅 主页 和上述系统文档

📄 许可证

NeoEssentials 在 MIT 许可证下发布。详细信息请参阅 许可证 文件。

🌟 准备好增强你的服务器了吗？立即下载 NeoEssentials，为你的玩家提供他们所需的必备工具！

为 Minecraft 社区用心制作 ❤️