快速入门指南¶
这是一个非常简短的指南,为您创建第一个 PySpigot 脚本。如果您不懂 Python,没关系!有很多优质的在线教程可供学习。请参阅有用资源页面以获取一些不错的 Python 教程。
下载并加载 PySpigot¶
PySpigot 官方支持在 Spigot 和 Paper 上以及 Minecraft 1.16 版本及更新版本上运行。我无法保证 PySpigot 在这些条件之外能正常运行,但有些用户报告在其他服务器软件和/或旧 MC 版本上也取得了成功。
截至版本 0.6.0,PySpigot 采用 Java 17 构建。这意味着从版本 0.6.0 开始,PySpigot 需要 Java 17 或更高版本。
从GitHub或Spigot下载最新版本的 PySpigot。将下载的 Jar 文件放入您的插件文件夹并启动服务器。
创建您的第一个脚本¶
在本简短教程中,我们将创建一个非常简单的脚本,用于向在线玩家广播消息。
创建脚本文件¶
所有单个文件脚本都应放在 PySpigot 主插件文件夹中的 scripts 文件夹中。PySpigot 允许在脚本文件夹中创建子文件夹以进行组织,但是脚本名称必须在所有子文件夹和项目中都是唯一的(即脚本和项目不能共用相同的名称)。
在 scripts 文件夹中创建一个 Python 脚本文件,命名为您喜欢的任何名称。确保其以 .py 结尾。文件名将作为该脚本的名称,稍后将用于加载和卸载脚本。
提示
PySpigot 仅会加载并运行以 .py 结尾的脚本文件。您可以通过更改文件扩展名(例如,向文件末尾添加 .disabled)轻松禁用脚本而无需删除它。您还可以在 script options 中禁用脚本。
编写脚本¶
使用您选择的文本编辑器打开您刚创建的脚本文件,并编写一些代码:
1 2 3 | |
- 在这里,我们从 Bukkit/Spigot API 中导入
Bukkit类,以便稍后在我们的脚本中引用(使用)它。 - 在这里,我们使用
Bukkit类中的一个名为broadcastMessage的函数。此函数会将一条消息(字符串)广播到服务器聊天中所有玩家。
保存文件,并启动您的服务器。
运行脚本¶
如果一切操作正确,脚本应在服务器启动时自动加载。这是预期的操作;当插件加载时,PySpigot 会自动加载和运行 scripts 文件夹中的所有脚本,包括子文件夹中的任何脚本。
或者,如果服务器已在运行且 PySpigot 插件已加载并启用,您可以使用 /pyspigot load <脚本名称> 加载并运行脚本。请确保名称包含扩展名(.py)!如果脚本位于子文件夹中,您无需指定整个路径。只需指定脚本文件名即可。
如果一切操作正确,当脚本加载时,您应该在聊天中看到消息 “Hello world!”。
下一步¶
查看文档的其余部分,了解更高级的脚本编写技巧。 ```
如果你发现自己陷入困境,需要帮助的话,加入 PySpigot 的 Discord 服务器。