mirror of
https://github.com/Genshin-bots/gsuid_core.git
synced 2025-05-12 06:55:49 +08:00
68 lines
2.3 KiB
Markdown
68 lines
2.3 KiB
Markdown
# ⚙️[GenshinUID](https://github.com/KimigaiiWuyi/GenshinUID) Core 0.1.0
|
||
|
||
[](https://github.com/psf/black)
|
||
[](https://pycqa.github.io/isort/)
|
||
[](https://flake8.pycqa.org/)
|
||
[](https://results.pre-commit.ci/latest/github/Genshin-bots/gsuid-core/master)
|
||
|
||
[KimigaiiWuyi/GenshinUID](https://github.com/KimigaiiWuyi/GenshinUID) 的核心部分，平台无关，支持 HTTP/WS 形式调用，便于移植到其他平台以及框架。
|
||
|
||
目前仍在开发中。
|
||
|
||
## 安装Core
|
||
|
||
1. git clone gsuid-core本体
|
||
|
||
```shell
|
||
git clone https://ghproxy.com/https://github.com/Genshin-bots/gsuid-core.git --depth=1 --single-branch
|
||
```
|
||
|
||
2. 安装所需依赖
|
||
|
||
```shell
|
||
poetry install
|
||
```
|
||
|
||
3. 启动gsuid-core
|
||
|
||
```shell
|
||
poetry run python core.py
|
||
```
|
||
|
||
4. 链接其他适配端
|
||
|
||
+ 默认core将运行在`localhost:8765`端口上，如有需要可至`config.json`修改。
|
||
+ 在支持的Bot上（例如NoneBot2、HoshinoBot），安装相应适配插件，启动Bot（如果有修改端口，则需要在启动Bot前修改适配插件相应端口），即可自动连接Core端。
|
||
|
||
## 编写插件
|
||
|
||
|
||
```python
|
||
import asyncio
|
||
|
||
from gsuid_core.sv import SL, SV
|
||
from gsuid_core.bot import Bot
|
||
from gsuid_core.models import Event
|
||
|
||
|
||
@SV('开关').on_prefix(('关闭', '开启')) # 定义一组服务`开关`，服务内有两个前缀触发器
|
||
async def get_switch_msg(bot: Bot, ev: Event):
|
||
name = ev.text # 获取消息除了命令之外的文字
|
||
command = ev.command # 获取消息中的命令部分
|
||
im = await process(name) # 自己的业务逻辑
|
||
await bot.logger.info('正在进行[关闭/开启开关]') # 发送loger
|
||
await bot.send(im) # 发送消息
|
||
|
||
sv=SV(
|
||
name='复杂的服务', # 定义一组服务`开关`,
|
||
pm=2, # 权限 0为master，1为superuser，2为群的群主&管理员，3为普通
|
||
priority=5, # 整组服务的优先级
|
||
enabled=True, # 是否启用
|
||
black_list=[] # 黑名单
|
||
)
|
||
|
||
@sv.on_prefix('测试')
|
||
async def get_msg(bot: Bot, ev: Event):
|
||
...
|
||
```
|