PySpigot 指令¶
PySpigot 提供了多个可用的指令,主要用于加载、卸载和重新加载脚本。这里都有详细的文档。
Tip
通常情况下,当一个指令需要输入脚本或项目的名称时,PySpigot 会根据名称参数中是否包含.py文件扩展名来确定您是在引用一个脚本还是项目:
- 当您引用一个单个文件脚本时,请使用脚本文件的名称,包括文件扩展名(例如,
test_script.py)。此外,只使用文件名。如果脚本位于子文件夹中,不要包括子文件夹的名称。PySpigot 会根据您提供的名称在scripts文件夹中自动查找匹配的脚本文件。- 例如,如果您有一个位于
scripts/test/test.py的脚本,您应该仅使用文件名引用它(test.py)。要加载它,您需要运行指令/pyspigot load test.py
- 例如,如果您有一个位于
- 当您引用一个项目时,请使用项目文件夹的名称(例如,
test_project)。不要传入项目的主模块。
基础指令¶
PySpigot 的基础指令是 /pyspigot。运行此指令将显示可用指令的列表(只要输入指令的用户具备pyspigot.command.listcmds权限)。
- 语法:
/pyspigot <参数> - 别名:
ps - 权限:
pyspigot.command.listcmds
接下来的所有指令都是基础指令的子指令。
帮助指令¶
显示几个有用的链接,包括文档(这个网站)、Spigot 上的 PySpigot 插件页面、官方 Discord,以及在 GitHub 上报告问题/错误的链接。
- 语法:
/pyspigot help - 别名:
gethelp - 权限:
pyspigot.command.help
信息指令¶
显示有关脚本或项目的详细信息,包括正常运行时间、已注册的监听器、命令、任务以及更多信息。若要获取有关脚本的信息,请传递脚本的名称(包括.py扩展名)。若要获取有关项目的信息,请传递项目的名称(项目文件夹的名称)。如果名称中不包含.py,PySpigot将假定该名称指的是一个项目。
- 语法:
/pyspigot info <脚本名称/项目名称> - 别名:
scriptinfo - 权限:
pyspigot.command.info
ListScripts 命令¶
列出所有脚本和项目,包括已加载和未加载的。已加载的脚本和项目显示为绿色;未加载的脚本和项目显示为红色。使用[页数]切换到另一页,若有多页可用。
- 语法:
/pyspigot listscripts [页数] - 别名:
list、scriptslist、ls - 权限:
pyspigot.command.listscripts
Load 命令¶
加载并运行脚本或项目。若要加载脚本,请传递脚本的名称(包括.py扩展名)。若要加载项目,请传递项目的名称(项目文件夹的名称)。如果名称中不包含.py,PySpigot将假定该名称指的是一个项目。
- 语法:
/pyspigot load <脚本名称/项目名称> - 别名:
start - 权限:
pyspigot.command.load
LoadLibrary 命令¶
加载您希望在脚本中使用的Java库。有关更多信息,请参阅External Libraries。
- 语法:
/pyspigot loadlibrary <文件名> - 别名:
loadlib - 权限:
pyspigot.command.loadlibrary
ReloadAll 命令¶
执行PySpigot的完全重新加载,包括config.yml、script_options.yml、库管理器以及所有脚本/项目。
- 语法:
/pyspigot reloadall - 别名:
reset,restart,reboot,resetall - 权限:
pyspigot.command.reloadall
重新加载命令¶
重新加载脚本或项目。如果在运行中对脚本/项目进行了更改并希望重新加载,这将非常有用。如果重新加载脚本,请传递脚本的名称(包括.py)。如果重新加载项目,请传递项目的名称(项目文件夹的名称)。如果名称中未包含.py,PySpigot 将假定名称指的是一个项目。
- 语法:
/pyspigot reload <脚本名称/项目名称> - 别名: 无
- 权限:
pyspigot.command.reload
ReloadConfig 命令¶
重新加载 PySpigot 的 config.yml 和 script_options.yml。
- 语法:
/pyspigot reloadconfig - 别名:
configreload - 权限:
pyspigot.command.reloadconfig
警告
/ps reloadconfig 命令不会重新加载脚本或项目!请使用 /pyspigot reload <脚本名称/项目名称> 来重新加载脚本/项目,或者使用 /ps reloadall 来重新加载所有脚本和项目。
卸载命令¶
停止并卸载脚本。如果卸载脚本,请传递脚本的名称(包括.py)。如果卸载项目,请传递项目的名称(项目文件夹的名称)。如果名称中未包含.py,PySpigot 将假定名称指的是一个项目。
- 语法:
/pyspigot unload <脚本名称/项目名称> - 别名:
stop - 权限:
pyspigot.command.unload