快速开始

5 分钟内完成基本配置

概述

本指南将帮助你快速部署 NDPR 并连接到你的 Minecraft 服务器。

快速流程

Text
1. 安装 NDPR → 2. 创建 Token → 3. 配置服务端 → 4. 开始使用

第一步:创建 Token

使用管理员密钥生成 API Token:

Bash
# 计算密钥的 SHA256 哈希 KEY_HASH=$(echo -n "your_admin_key" | sha256sum | cut -d' ' -f1) # 创建 Token curl -X POST http://localhost:5030/token/get \ -H "Content-Type: application/json" \ -d "{ \"uuid\": \"your-server-001\", \"mail\": \"admin@yourserver.com\", \"key\": \"$KEY_HASH\" }"

响应:

JSON
{ "token": "aBcD1234EfGh5678IjKlMnOpQrSt" }

<div class="custom-block warning">

<div class="custom-block-title">保存 Token</div>

创建后请妥善保存 Token,它将用于所有 API 调用。

</div>

第二步:授予上传权限

新创建的 Token 默认没有上传权限,需要手动授权:

Bash
curl -X POST http://localhost:5030/token/permission/add \ -H "Content-Type: application/json" \ -d "{ \"token\": \"aBcD1234EfGh5678IjKlMnOpQrSt\", \"key\": \"$KEY_HASH\" }"

第三步:添加封禁

离线模式(玩家名封禁)

Bash
curl -X POST http://localhost:5030/bans/add \ -H "Content-Type: application/json" \ -d "{ \"token\": \"aBcD1234EfGh5678IjKlMnOpQrSt\", \"player_id\": \"griefer123\", \"ip\": \"192.168.1.100\", \"online\": false }"

在线模式(UUID 封禁)

Bash
curl -X POST http://localhost:5030/bans/add \ -H "Content-Type: application/json" \ -d "{ \"token\": \"aBcD1234EfGh5678IjKlMnOpQrSt\", \"player_id\": \"griefer123\", \"ip\": \"192.168.1.100\", \"ipv6\": \"2001:db8::1\", \"online\": true, \"mcuuid\": \"550e8400-e29b-41d4-a716-446655440000\" }"

第四步:验证封禁

查询封禁列表:

Bash
curl "http://localhost:5020/bans"

完整示例

Python
import hashlib import requests # 配置 API_URL = "http://localhost:5030" ADMIN_KEY = "your_admin_key" SERVER_TOKEN = "your_server_token" # 计算密钥哈希 key_hash = hashlib.sha256(ADMIN_KEY.encode()).hexdigest() # 封禁玩家 def ban_player(player_id, ip, reason="违规操作"): response = requests.post( f"{API_URL}/bans/add", json={ "token": SERVER_TOKEN, "player_id": player_id, "ip": ip, "online": False } ) return response.json() # 测试封禁 result = ban_player("griefer123", "192.168.1.100") print(result)

下一步

  • 玩家封禁 - 了解更多封禁选项
  • IP 封禁 - IP 封禁详解
  • 服务端配置 - MCDR 插件配置