OlivOS-Team / OlivOS

OlivOS / Witness Union,一个强大的跨平台交互栈与机器人框架
https://doc.olivos.wiki
GNU Affero General Public License v3.0
194 stars 26 forks source link

引入用户配置项 #47

Closed HsiangNianian closed 1 year ago

HsiangNianian commented 1 year ago

配置项

适应配置需要,考虑在插件编写时使用from OlivOS.JyunkoUserConf import *加入用户配置项机制。第一次使用将会在./plugin/data/文件夹下生成UserConf.dat配置文件。

依赖

import pickle
import os.path

API

  1. setUserConf(user_id:'int|str',keyConf:str,val:any) 写入用户配置
参数 类型 描述 缺省
user_id int,str 待传入的用户ID 不可缺省
keyConf str 配置键 不可缺省
val any 配置值 不可缺省
示例 setUserConf(plugin_event.data.user_id,"jrrp",0) 设置指令触发者的jrrp配置值为0
  1. getUserConf(user_id:'int|str',keyConf:str,perhapsVal=None) 获取用户配置
参数 类型 描述 缺省
user_id int,str 待传入的用户ID 不可缺省
keyConf str 配置键 不可缺省
perhapsVal any 可选的备用参数 None
示例 getUserConf(plugin_event.data.user_id,"jrrp",0) 获取指令触发者的jrrp配置值
  1. setGroupConf(group_id:'int|str',keyConf:str,val:any) 写入群组配置
参数 类型 描述 缺省
group_id int,str 待传入的群组ID 不可缺省
keyConf str 配置键 不可缺省
val any 配置值 不可缺省
示例 setGroupConf(plugin_event.data.group_id,"许可",False) 设置指令触发群聊的许可配置值为False
  1. getGroupConf(group_id:'int|str',keyConf:str,perhapsVal=None) 获取群组配置
参数 类型 描述 缺省
group_id int,str 待传入的群组ID 不可缺省
keyConf str 配置键 不可缺省
perhapsVal any 可选的备用参数 None
示例 getGroupConf(plugin_event.data.group_id,"许可",False) 获取指令触发群聊的许可配置值