PySpigot

插件

· 作者 magicmq

一个用于运行 Bukkit 或其分支(如 Spigot、Paper 等)的 Minecraft 服务器的 Python 脚本引擎(插件)。

0 本站下载 0 关注 更新于 1 年前

最新 0.9.1 · 1.21.8 · BungeeCord

一键开服(送7天)

描述

PySpigot 是用于 Minecraft 服务器的 Python 脚本引擎。它允许你创建脚本,这些脚本充当“迷你插件”:它们可以注册事件监听器、命令、计划任务等等!

PySpigot 很像 Skript,但功能更强大。PySpigot 使用了 Jython,这是一个完全在 Java 上运行的 Python 实现。这意味着 PySpigot 脚本可以完整访问整个 Bukkit/Spigot API,以及任何其他已加载插件的 API。通常来说,PySpigot 脚本可以做任何 Python 能做的事,也可以做任何插件能做的事。

目前支持 Bukkit 服务器实现,包括 Spigot、Paper 和 Purpur,适用于 Minecraft 1.16 及更高版本。目前有一个非官方的初步版本 PySpigot for BungeeCord 可供开放测试。在此下载。

关于插件和编写脚本的完整文档,请访问官方文档。



加入 Discord 获取支持并了解更新动态!

特性

  • 在服务器启动或通过命令时加载脚本
  • 通过命令停止、重新加载和卸载服务器脚本
  • 支持单文件脚本和多文件项目
  • 注册事件监听器
  • 注册命令
  • 计划任务(同步和异步)
  • 处理配置文件
  • 注册 ProtocolLib 数据包监听器和发送数据包
  • 注册 PlaceholderAPI 占位符扩展
  • 针对每个脚本全面记录错误和异常到文件
  • 在运行时加载你想要使用的 Java 库
  • 使用 Python 语法编写脚本
  • 脚本可以完整访问 Bukkit/Spigot API 以及其他插件的 API,因此一切皆有可能。
  • 支持与 SQL、Mongo 和 Redis 服务器协作
  • 还有更多!

命令

  • /pyspigot reload: 列出一些有用的链接(文档、Discord 等)
  • /pyspigot info [scriptname/projectname]: 显示有关脚本或项目的详细信息,包括运行时间、注册的监听器、命令等
  • /pyspigot listscripts: 列出已加载和未加载的脚本和项目
  • /pyspigot load [scriptname/projectname]: 加载指定名称的脚本或项目
  • /pyspigot loadlibrary [libraryname]: 加载指定名称的 Java 库
  • /pyspigot reloadall: 重新加载整个插件,包括脚本、项目、库和配置
  • /pyspigot reload [scriptname/projectname]: 重新加载已加载的脚本或项目
  • /pyspigot reloadconfig: 重新加载 PySpigot 的 config.yml
  • /pyspigot unload [scriptname/projectname]: 卸载脚本或项目

配置

# 如果设为 false,将禁用 bStats 对 PySpigot 的指标信息收集。你也可以在 /plugins/bStats/config.yml 下的 bStats 配置中全局禁用 bStats。
metrics-enabled: true
# 服务器加载完成后,加载脚本的延迟(以刻为单位)。
script-load-delay: 20
# libs 文件夹中库的重定位规则列表。格式为 <pattern>|<relocated pattern>
library-relocations: []
# 脚本日志文件中时间戳的日期/时间格式,采用 Java 的 SimpleDateFormat 模式:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/format/DateTimeFormatter.html
log-timestamp-format: 'MMM dd yyyy HH:mm:ss'
# 如果设为 true,每次脚本加载、运行和卸载时,都会向控制台打印日志消息。
script-action-logging: true
# 如果设为 true,会将所有 redis 事件记录到控制台和脚本的日志记录器中。如果设为 false,仅记录重连事件(重连尝试和失败)。
verbose-redis-logging: true
# 如果设为 true,当脚本所依赖的插件被卸载时,脚本也将自动卸载。这对于确保需要依赖插件才能成功完成的脚本关闭任务(在插件卸载之前)特别有用。
script-unload-on-plugin-disable: true
# 与 Jython 相关的选项。更改此部分中的选项需要重启服务器。
jython-options:
  # 如果设为 true,Jython 运行时将在插件加载/服务器启动期间初始化。如果设为 false,则直到第一个脚本加载前不会初始化 Jython 运行时。
  init-on-startup: true
  # 将传递给 Jython 的系统属性列表。完整列表请参阅 https://javadoc.io/doc/org.python/jython-standalone/latest/org/python/core/RegistryKey.html
  properties:
    - 'python.cachedir.skip=true'
  # 初始化时传递给 Jython 的参数列表。相当于 Python 中的 sys.argv。
  args:
    - ''
# 脚本选项的默认值。如果 script_options.yml 中未定义脚本的一个或多个选项,PySpigot 将回退使用这些值。
script-option-defaults:
  # 对于项目而言,这是项目的主脚本文件。
  main: 'main.py'
  # 脚本是否启用
  enabled: true
  # 脚本的整数加载优先级
  load-priority: 1
  # 脚本所依赖的插件列表
  plugin-depend: []
  # 是否应将脚本日志消息记录到其各自的日志文件中
  file-logging-enabled: true
  # 记录到控制台和脚本日志文件的最小日志级别
  min-logging-level: 'INFO'
  # 权限的默认权限等级
  permission-default: 'op'
# 脚本的高级调试选项
debug-options:
  # 如果设为 true,会将所有与脚本相关的异常的堆栈跟踪打印到服务器控制台
  print-stack-traces: false
  # 如果设为 true,当 spigotmc.org 上有更新的 PySpigot 版本可供下载时,插件会在控制台显示消息,并向拥有 pyspigot.admin 权限的玩家在加入时显示消息。
  show-update-messages: true
  # Jython 内部组件的日志级别。为了调试目的,将其设置为 FINE 或 ALL 可能很有用。注意:服务器的根日志记录器也需要配置为接受调试消息,以便显示 Jython 的调试消息。
  jython-logging-level: 'INFO'
  # 如果设为 true,PySpigot 将在脚本卸载时修补 threading 模块(如果脚本正在使用它),以防止服务器挂起。更多信息请参阅 https://github.com/magicmq/pyspigot/issues/18#issue-3012022678
  patch-threading: true

一些有用的链接

  • 完整文档:
  • 源代码:
  • 对于开发者,请在此处查看 PySpigot 的 Javadocs:

指标数据

PySpigot 通过 bStats 收集匿名的服务器统计数据,这是一个用于 Minecraft 服务器的开源统计收集服务。你可以在 PySpigot config.yml 或 /plugins/bStats/config.yml 中选择退出此功能。


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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源