NetworkJS-Reloaded

模组

· 作者 INITIALFOX

NeoForge 1.21.1 的 KubeJS 插件:在 server_scripts 中实现 HTTP 请求、Discord 机器人和 PostgreSQL。支持全服或按世界脚本。单人游戏默认关闭网络——使用 /networkjs enable 启用。

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

最新 1.2.0 · 1.21.1 · NeoForge

一键开服(送7天)

NetworkJS Reloaded 是 NeoForge 1.21.1 上 KubeJS 的一个服务端插件。它允许你的 KubeJS 服务端脚本发起 HTTP 请求、连接 Discord 机器人,并对 PostgreSQL 执行 SQL 查询。你可以像编写其他 KubeJS 脚本一样,在 kubejs/server_scripts 下用 JavaScript 编写逻辑。

本项目是 SSnowly 的 NetworkJS 的一个分支,扩展了对 PostgreSQL 的支持(包括连接池、异步查询和预处理语句)。

功能

  • HTTP:同步和异步请求 (fetch, fetchAsync)
  • PostgreSQL:从脚本中读写数据 (postgresQuery, postgresExecute, Postgres)
  • Discord:发送消息并监听聊天 (DiscordBot)
  • 服务端辅助工具:广播彩色消息和读取玩家列表 (Server)
  • 安全性:在单人游戏/集成服务器模式下,网络访问默认关闭,直到操作员运行 /networkjs enable

要求

  • Minecraft 1.21.1
  • NeoForge 21.1.200 或更高版本(仅限 21.1.x)
  • KubeJS 2101.7.1 或更高版本
  • Java 21
  • 仅限服务端(客户端不需要)

安装

  1. 将 NeoForge 1.21.1、KubeJS 和此模组放入 mods 文件夹。
  2. 重启专用服务器(或你的单人游戏世界)。
  3. 在专用服务器上,功能会自动启用。
  4. 在单人游戏中:运行 /networkjs enable,然后运行 /kubejs reload server。

KubeJS 文件放置位置

脚本可以放在服务器根目录(所有世界共享)或某个世界文件夹内(仅该世界可用)。

全局生效(推荐用于专用服务器):

  • 脚本:kubejs/server_scripts/
  • PostgreSQL 配置:kubejs/config/networkjs/postgres.json(仅在服务器根目录下,不能放在世界文件夹内)

仅限特定世界:

  • 脚本:world/kubejs/server_scripts/(或你的世界存档路径)

PostgreSQL 配置

NetworkJS 仅在服务器根目录读取一个 JSON 文件:

kubejs/config/networkjs/postgres.json

不要将此文件放在世界文件夹内(如 world/.../kubejs/)。脚本仍然可以从任何世界的 server_scripts 中使用数据库,但配置文件始终从实例/专用服务器根目录加载(与 mods/ 所在文件夹相同)。

设置步骤

  1. 如需,创建文件夹:kubejs/config/networkjs/
  2. 从仓库复制示例:
    examples/kubejs/config/networkjs/postgres.json.example → kubejs/config/networkjs/postgres.json
  3. 编辑该文件(见下方字段说明)。设置 "enabled": true。
  4. 重启服务器 或 运行 /networkjs postgres reload(需要操作员权限)。
  5. 检查状态:/networkjs postgres status —— 应显示主机、端口和数据库名称。
  6. 在脚本就位后,运行 /kubejs reload server。

在单人游戏中,数据库查询生效前需先运行 /networkjs enable。

postgres.json 示例

{
  "enabled": true,
  "host": "localhost",
  "port": 5432,
  "database": "minecraft",
  "username": "postgres",
  "password": "your_secret_here",
  "maxPoolSize": 5,
  "connectionTimeoutMs": 10000
}

配置字段

字段 类型 默认值 描述
enabled boolean false true — 在加载/重载时连接。false — PostgreSQL 绑定保持关闭状态。
host string localhost PostgreSQL 服务器主机名或 IP 地址。
port number 5432 PostgreSQL 端口。
database string minecraft 数据库名称。
username string postgres 数据库用户。
password string "" 数据库密码。请保持此文件私密,不要将其提交到 git。
maxPoolSize number 5 HikariCP 连接池大小(最大并发连接数)。
connectionTimeoutMs number 10000 从连接池等待连接的超时时间(毫秒)。

模组会自动构建 JDBC URL:
jdbc:postgresql://<host>:<port>/<database>

远程数据库示例

{
  "enabled": true,
  "host": "db.example.com",
  "port": 5432,
  "database": "my_server",
  "username": "mc_user",
  "password": "strong_password",
  "maxPoolSize": 10,
  "connectionTimeoutMs": 15000
}

确保 PostgreSQL 接受来自你的 Minecraft 服务器 IP 的连接(检查 pg_hba.conf / 防火墙设置)。

如果连接失败

  • 文件路径必须为 <server root>/kubejs/config/networkjs/postgres.json
  • "enabled" 必须为 true
  • 密码或数据库名称错误 — 检查服务器 latest.log 中的 [NetworkJS] 或 PostgreSQL 错误日志
  • /networkjs status — 显示注册表状态以及 postgres 已连接/未连接
  • /networkjs postgres reload — 重新读取配置,无需完全重启
  • 专用服务器:注册表默认开启;单人游戏需要运行 /networkjs enable

安全性

  • 切勿在公共 issue 追踪器或 Modrinth 评论中粘贴真实密码。
  • 在脚本中使用 SQL 占位符 ? — 不要根据玩家聊天输入构建 SQL 语句。
  • 仅授予数据库用户其脚本所需的最小权限(特定表的 SELECT/INSERT/UPDATE)。

示例

添加脚本后,运行 /kubejs reload server。在单人游戏中,请先运行 /networkjs enable。

异步回调在主线程之外运行 — 在执行聊天、传送或世界更改之前,请使用 event.server.scheduleInTicks(0, ...)。

HTTP — 同步 GET

PlayerEvents.loggedIn(function (event) {
  var name = String(event.player.username)
  var response = fetch('https://httpbin.org/get')
  if (response.isOk()) {
    event.server.scheduleInTicks(0, function () {
      Server.sendRawMessageToPlayer(name, '&aHTTP &8' + response.getStatus())
    })
  }
})

HTTP — 异步 GET

ServerEvents.loaded(function (event) {
  fetchAsync('https://httpbin.org/get').thenAccept(function (response) {
    console.info('状态: ' + response.getStatus() + ' — body 长度: ' + response.text().length)
  })
})

HTTP — 使用 JSON 的 POST

ServerEvents.loaded(function (event) {
  fetchAsync('https://httpbin.org/post', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      online: true,
      players: Server.getPlayerCount(),
      names: Server.getPlayerNames()
    })
  }).thenAccept(function (response) {
    console.info('Posted status: ' + response.getStatus())
  })
})

HTTP — 迷你示例(加入时聊天,多行)

PlayerEvents.loggedIn(function (event) {
  var name = String(event.player.username)
  var r = fetch('https://api.github.com/repos/initialfox/NetworkJS-Reloaded')
  if (!r.isOk()) return
  var repo = JSON.parse(r.text())
  var lines = [
    '&6✦ &aGitHub',
    '&f  ' + repo.full_name,
    '&7  ' + repo.language + ' &8│ &b' + repo.license.spdx_id + ' &8│ &e' + repo.default_branch
  ]
  if (repo.fork && repo.parent) lines.push('&7  fork &f' + repo.parent.full_name)
  event.server.scheduleInTicks(0, function () {
    for (var i = 0; i < lines.length; i++) Server.sendRawMessageToPlayer(name, lines[i])
  })
})

PostgreSQL — JOIN 时 SELECT

PlayerEvents.loggedIn(function (event) {
  var name = String(event.player.username)
  postgresQuery('SELECT username, role FROM users WHERE username = ? LIMIT 1', [name])
    .thenAccept(function (result) {
      event.server.scheduleInTicks(0, function () {
        if (!result.isOk()) {
          Server.sendRawMessageToPlayer(name, '&cDB error: ' + result.getError())
          return
        }
        if (result.getRowCount() === 0) {
          Server.sendRawMessageToPlayer(name, '&eNo row in database for this player')
          return
        }
        var row = result.getRows().get(0)
        Server.sendRawMessageToPlayer(name, '&aRole: &e' + row.get('role'))
      })
    })
})

PostgreSQL — INSERT 会话记录

PlayerEvents.loggedIn(function (event) {
  var uuid = String(event.player.uuid)
  var name = String(event.player.username)
  postgresExecute(
    'INSERT INTO player_sessions (uuid, username, joined_at) VALUES (?, ?, NOW())',
    [uuid, name]
  ).thenAccept(function (result) {
    if (result.isOk()) {
      console.info('Session insert, rows affected: ' + result.getUpdateCount())
    }
  })
})

PostgreSQL — 类 API (Postgres)

PlayerEvents.loggedOut(function (event) {
  var uuid = String(event.player.uuid)
  Postgres.executeAsync(
    'UPDATE player_sessions SET left_at = NOW() WHERE uuid = ? AND left_at IS NULL',
    [uuid]
  )
})

PostgreSQL — 检查连接

ServerEvents.loaded(function (event) {
  if (Postgres.isConnected()) {
    console.info('[NetworkJS] PostgreSQL pool is ready')
  } else {
    console.warn('[NetworkJS] PostgreSQL not connected — check kubejs/config/networkjs/postgres.json')
  }
})

Discord — 发送消息

var bot = new DiscordBot({
  token: 'YOUR_BOT_TOKEN',
  guild: 'GUILD_ID',
  channels: { chat: 'CHANNEL_ID', log: 'ANOTHER_CHANNEL_ID' }
})

ServerEvents.loaded(function (event) {
  bot.sendMessage('log', 'Server started!')
})

Discord — Embed

bot.sendEmbed('chat', {
  title: 'Server online',
  description: 'Players: ' + Server.getPlayerCount(),
  color: 0x00ff00
})

Discord — Minecraft 聊天转发至 Discord

PlayerEvents.chat(function (event) {
  var player = String(event.player.username)
  var msg = String(event.message)
  bot.sendMessage('chat', '**' + player + '**: ' + msg)
})

Discord — Discord 转发至 Minecraft

bot.onMessage(function (msg) {
  if (msg.isFromConfiguredChannel() && !msg.isBot()) {
    Server.sendRawMessage('&9[Discord] &f' + msg.getAuthor() + ': ' + msg.getContent())
  }
})

Server — 广播与玩家列表

ServerEvents.loaded(function (event) {
  Server.sendRawMessage('&a[NetworkJS] &7Server loaded. Online: &f' + Server.getPlayerCount())
  var names = Server.getPlayerNames()
  console.info('Players: ' + names)
})

Server — 向单个玩家发送消息

PlayerEvents.loggedIn(function (event) {
  Server.sendRawMessageToPlayer(event.player.username, '&aWelcome! &7NetworkJS is active.')
})

Commands (operator, level 2)

  • /networkjs enable — 启用网络绑定(单人游戏)
  • /networkjs disable — 禁用网络访问
  • /networkjs reload — 重新加载绑定
  • /networkjs status — 注册表与数据库状态
  • /networkjs postgres reload — 重新加载数据库配置
  • /networkjs postgres status — 数据库连接信息

Links

  • Source and more examples:
  • Original NetworkJS:

License: MIT

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源