NekoMaid 使用与配置指南

NekoMaid 使用与配置指南

NekoMaid A plugin can use Web to manage your MineCraft server. 项目地址: https://gitcode.com/gh_mirrors/ne/NekoMaid

1. 项目目录结构及介绍

NekoMaid 的项目目录结构如下：

NekoMaid/
├── .github/                    # GitHub 工作流和配置文件
├── gradle/                     # Gradle 构建脚本和包装器
├── icons/                      # 图标资源
├── languages/                  # 多语言支持文件
├── npm/                        # npm 配置文件
├── screenshots/                # 屏幕截图
├── scripts/                    # 脚本文件
├── src/                        # 源代码目录
│   └── main/                   # 主程序目录
├── vscode-material-icon-theme/ # Visual Studio Code 图标主题
├── web/                        # Web 相关文件
├── .eslintignore               # ESLint 忽略文件
├── .eslintrc.json              # ESLint 配置文件
├── .gitignore                  # Git 忽略文件
├── .gitmodules                 # Git 子模块配置
├── LICENSE                     # 许可证文件
├── README.md                   # 项目说明文件
├── build.gradle                # Gradle 构建脚本
├── gradlew                     # Gradle 包装器脚本 (Unix)
├── gradlew.bat                 # Gradle 包装器脚本 (Windows)
├── index.html                  # Web 页面入口文件
├── package-lock.json           # npm 锁定文件
├── package.json                # npm 配置文件
├── settings.gradle             # Gradle 设置文件
├── tsconfig.json               # TypeScript 配置文件
└── vite.config.ts              # Vite 配置文件

各目录和文件的作用：

• .github/：存放 GitHub Actions 工作流和相关配置文件。
• gradle/：包含项目的 Gradle 构建脚本和依赖。
• icons/：存放项目所需的图标资源。
• languages/：存放项目支持的多语言文件。
• npm/：包含 npm 相关的配置和脚本。
• screenshots/：存放项目的屏幕截图。
• scripts/：存放项目运行过程中需要的脚本文件。
• src/：项目的源代码目录。
• web/：存放 Web 界面的相关文件。
• .eslintignore、.eslintrc.json：ESLint 配置文件，用于代码风格检查。
• .gitignore、.gitmodules：Git 配置文件，用于忽略不需要提交的文件和配置子模块。
• LICENSE：项目的许可证文件，本项目采用 AGPL-3.0 许可。
• README.md：项目的说明文件，包含项目的介绍和基本使用方法。
• build.gradle、gradlew、gradlew.bat：Gradle 相关文件，用于构建项目。
• index.html：Web 界面的入口 HTML 文件。
• package-lock.json、package.json：npm 相关文件，用于管理和锁定项目的依赖。
• settings.gradle、tsconfig.json、vite.config.ts：项目的配置文件。

2. 项目的启动文件介绍

NekoMaid 项目的启动主要依赖于 Gradle 构建。在项目根目录下，可以通过以下命令来构建和启动项目：

./gradlew build

构建完成后，使用以下命令启动项目：

./gradlew run

在 src/main 目录中，通常会有一个主类文件，例如 NekoMaid.java，这个文件包含了项目的主入口点：

public class NekoMaid {
    public static void main(String[] args) {
        // 项目启动逻辑
    }
}

3. 项目的配置文件介绍

NekoMaid 的配置文件主要位于项目根目录下的 config.yml 文件。以下是配置文件的一些基本配置项：

token: ~
# 用于生成管理地址的令牌

Password: ~
# 服务器密码

hostname: 127.0.0.1
# 服务器连接地址

customAddress: 'https://example.com/{token}'
# 自定义管理地址

geolite2-eula: false
# 是否同意 MaxMind GeoIP2 的 EULA

baidu-map-license-key: ''
# 如果启用 GeoIP 功能，需要使用自己的百度地图许可证密钥

skin-url: ''
# 自定义玩家皮肤 URL

head-url: ''
# 自定义玩家头像 URL

debug: false
# 是否开启调试模式

logger: ~
# 日志配置

maxLevel: INFO
# 日志最大级别

minLevel: OFF
# 日志最小级别

这些配置项可以根据实际需求进行修改，以适应不同的服务器环境和功能需求。配置完成后，重启服务器使配置生效。

NekoMaid A plugin can use Web to manage your MineCraft server. 项目地址: https://gitcode.com/gh_mirrors/ne/NekoMaid