https://github.com/he0119/nonebot-plugin-user
NoneBot 用户插件
https://github.com/he0119/nonebot-plugin-user
nonebot2
Last synced: over 1 year ago
JSON representation
NoneBot 用户插件
- Host: GitHub
- URL: https://github.com/he0119/nonebot-plugin-user
- Owner: he0119
- License: mit
- Created: 2023-09-19T13:27:09.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-06T22:43:05.000Z (over 1 year ago)
- Last Synced: 2025-03-16T07:51:08.531Z (over 1 year ago)
- Topics: nonebot2
- Language: Python
- Homepage:
- Size: 368 KB
- Stars: 12
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# NoneBot Plugin User
_✨ NoneBot 用户插件 ✨_
## 简介
## 使用方式
加载插件后发送 `/user`、`/inspect` 或 `/bind`。
### 查看用户信息
通过 user 命令可查看用户信息:
```text
平台名：qq
平台 ID：10000
用户名：uy/sun
创建日期：2023-11-02 04:52:42
```
### 查看会话信息
通过 inspect 命令可查看当前会话信息:
```text
平台名：qq
平台 ID：10000
自身 ID：20000
群组 ID：30000
```
### 绑定用户
通过 bind 命令可将不同用户的数据绑定:
```text
命令 bind 可用于在多个平台间绑定用户数据。绑定过程中，原始平台的用户数据将完全保留，而目标平台的用户数据将被原始平台的数据所覆盖。
请确认当前平台是你的目标平台，并在 5 分钟内使用你的账号在原始平台内向机器人发送以下文本：
/bind nonebot/123456
绑定完成后，你可以随时使用「bind -r」来解除绑定状态。
```
## 插件适配
先在插件代码最前面声明依赖
```python
from nonebot import require
require("nonebot_plugin_user")
```
获取用户信息
```python
from nonebot_plugin_user import User
@matcher.handle()
async def _(user: User):
await matcher.finish(user.id)
```
获取用户会话信息
```python
from nonebot_plugin_user import UserSession
@matcher.handle()
async def _(session: UserSession):
await matcher.finish(session.user_id)
```
## 配置项
配置方式：直接在 `NoneBot` 全局配置文件中添加以下配置项即可。
### user_token_prefix
- 类型: `str`
- 默认: `nonebot/`
- 说明: 生成令牌的前缀
## 计划
- [ ] 支持权限
## 鸣谢
- [Koishi](https://github.com/koishijs/koishi): 本项目直接参考
- [nonebot-plugin-session](https://github.com/noneplugin/nonebot-plugin-session): 获取用户信息