幻兽帕鲁服务器rest api使用
Project description
NoneBot Plugin PalWorld 插件🌟
✨ 一个用于管理幻兽帕鲁服务器的 NoneBot 插件 ✨
支持查看服务器状态、发送公告、管理玩家等功能。
安装📦
方式一:通过 pip 安装
pip install nonebot-plugin-palworld
方式二:通过 NB-CLI 安装
nb plugin install nonebot-plugin-palworld
方式三:通过 Git 安装
git clone https://github.com/huanxin996/nonebot_plugin_palworld.git
cd nonebot_plugin_palworld
pip install .
安装完成后,在 NoneBot 项目的 bot.py 中加载插件:
nonebot.load_plugin("nonebot_plugin_palworld")
然后配置插件所需的参数(参考下方配置项)。
📋 配置项
以下是插件的配置项列表,所有配置项均可在 NoneBot 的配置文件(.env 或 .env.prod)中设置:
| 配置项 | 类型 | 默认值 | 说明 |
|---|---|---|---|
palworld_host_port |
str |
127.0.0.1:8211 |
幻兽帕鲁服务器地址和端口 格式: host:port示例: 192.168.1.100:8211必填 |
pallworld_user |
str |
Admin |
幻兽帕鲁服务器管理员用户名 示例: ServerAdmin必填 |
palworld_token |
str 或 int |
your_token_here |
访问令牌,用于身份验证 示例: 12345abcde必填 |
palworld_images_send |
bool |
True |
是否启用图片消息发送功能 可选值: True(启用), False(禁用) |
🚀 如何使用?
📜 命令列表
以下是插件支持的命令及其功能:
服务器管理
-
pl管理 状态
查看服务器状态。 -
pl管理 公告 [内容]
发送服务器公告。
参数:内容(必需):公告内容。
-
pl管理 玩家列表
查看当前在线玩家列表。 -
pl管理 玩家信息 [名称]
查看指定玩家的信息。
参数:名称(必需):玩家名称。
玩家管理
-
pl管理 踢出 [玩家ID] [原因?]
踢出指定玩家,原因可选。
参数:玩家ID(必需):玩家 ID。原因(可选):踢出原因,默认为"你被踢了"。
-
pl管理 封禁 [玩家ID] [原因?]
封禁指定玩家,原因可选。
参数:玩家ID(必需):玩家 ID。原因(可选):封禁原因,默认为"你已被该服务器封禁"。
-
pl管理 解封 [玩家ID]
解封指定玩家。
参数:玩家ID(必需):玩家 ID。
服务器控制
-
pl管理 关服 [时间] [原因?]
发送关服命令,时间为秒,原因可选。
参数:时间(必需):关闭等待时间(秒)。原因(可选):关服原因,默认为"服务器即将关闭"。
-
pl管理 强制关服
立即强制关闭服务器。
🔗 相关链接
📝 更新日志
v0.0.1 (2025-01-06)
- 初始版本发布
- 支持基础服务器管理功能
- 支持玩家管理功能
v0.1.0 (2025-04-15)
- 使用alc支持多平台
- 优化交互体验
- 添加图片发送支持
🤝 贡献
欢迎提交 Pull Request 或 Issue!如有任何问题或建议,请随时联系我们。
📄 开源许可
本项目采用 MIT 许可证 - 详情请查看 LICENSE 文件。
✨ 感谢使用 NoneBot Plugin PalWorld 插件!✨
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nonebot_plugin_palworld-0.1.0.tar.gz.
File metadata
- Download URL: nonebot_plugin_palworld-0.1.0.tar.gz
- Upload date:
- Size: 11.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fc6646f81599846017be8c25ad7eb3b9d3ac3eed975896e68421e73396772ef0
|
|
| MD5 |
6fbb397f370b3db06d18c3c08056bde4
|
|
| BLAKE2b-256 |
6a5c6a4c3d6cd18a79c8c8f54e18a69c6e88ec8308f8573c54b1a8ab081c7828
|
File details
Details for the file nonebot_plugin_palworld-0.1.0-py3-none-any.whl.
File metadata
- Download URL: nonebot_plugin_palworld-0.1.0-py3-none-any.whl
- Upload date:
- Size: 11.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
754483a11e92a7114dfae4c52eeaaf0b997714fcd4911917b6f0b1aa177db6d6
|
|
| MD5 |
ff1a43645dcf04b715b0c917c9b081e8
|
|
| BLAKE2b-256 |
ea272058cb50ef1eea9eff2558376cfbe74dd06de3b47a7d7d4a55180599703b
|