跳转至

必填、选填速查表⚓︎

✍ 必填⚓︎

必填变量的配置填写指南

类型变量名称填写描述
Telegram Botbot_namebot的username,比如我的机器人@keaiji1_bot,就填keaiji1_bot
bot_token bot的API token ,你在 @Botfather 创建bot时的api_key
owner_api 你的api https://my.telegram.org/auth 获取
owner_hash 你的api https://my.telegram.org/auth 获取
owner 拥有者的tgid
group 授权群组id,如-1001869392674,未授权的群组拉bot会自动退出。不在群组的成员会提示先加入群组
main_group 群组的username, 形如 @su_yxfy 中的 su_yxfy
或私密群组的邀请链接,如 https://t.me/+7ZL9MbJd8h44Zjc1+7ZL9MbJd8h44Zjc1,没有的话就随便填个 Google.com
chanel填写方式同 main_group
bot_photo 形如 https://telegra.ph/file/3b6cd2a89b652e72e0d3b.png bot发送消息时的配图,可更换图片url,重要
admins 默认[ ] 为空,可以将想要赋予权限的tg用户id填进
Emby emby_api emby的api_key,【Emby Service 管理】-> 【高级】->【API密钥】创建一个
emby_url 形如 http://255.255.255.36:8096(纯ip) or https://emby.susuyyds.xyz(有反代) 最后不带斜杠,为发起请求emby的地址
emby_line 【服务器板块】展示给普通用户的emby地址和信息,仅支持telegram的MarkdownV2写法
Database
(Mysql)
db_host 本机localhost or 数据库的ip 255.255.255.36 端口默认3306
db_user 数据库用户名,默认 susu
db_pwd 数据库密码,默认 1234
db_name 数据库名,默认 embyboss
db_port 数据库端口,默认 3306
  • 如已经填完上述,可以直接前往 启动 bot
  • 接下来是 【选填项目】 会自动生成,不填亦可,如果填写,请认真阅读!!!

选填⚓︎

选填变量的配置填写指南

类型变量名称填写描述
Proxy
代理设置
海外机请跳过
scheme"socks4", "socks5", "http" 推荐 "socks5"
hostname代理的主机地址
port端口
username
password
温馨提示:如果以上你都不会用,请使用海外机器
如果您的代理不需要授权, 可以省略 username password 空着不填
user_buy
充电按钮(已不支持)
stat~~是否开启充电按钮,即设置一个跳转网页的按钮~~true or false
button 按钮样式
["🔋 点击充电","https://google.com","url"]依序分别 "按钮显示文本","跳转网址",固定不可变字段"url"
货币 money 功能货币的名称,默认花币. 私以为取名两个字会简单好听点
open
注册,兑换开关
stat注册状态,默认 false true or false
open_us自由注册时创建的账号有效期,默认 30
all_user注册人数限制,可在bot启动后进入admin设置,默认 1000
timing定时注册计时参数,bot启动后开启定时注册有效,勿动,默认 0
tem当前已注册用户计数,勿动,默认 0
allow_code能否使用注册码续期,默认 true true or false
checkin是否开启签到,默认 true true or false
checkin_lv可签到用户等级,默认 d。说明:a 为白名单,b 为正常用户,c 为被封禁用户,d 为无号用户
checkin_reward签到奖励区间,默认形如 [1,10](最小值, 最大值)
exchange是否开启花币月度自动续期,默认 true
exchange_cost续期的价格 每30天,默认 100
whitelist是否开启兑换白名单,默认 true true or false
whitelist_cost兑换白名单价格,默认 9999
invite是否开启注册码兑换功能,默认 false true or false
invite_lv可兑换邀请码的用户等级,默认 d。说明:a 为白名单,b 为正常用户,c 为被封禁用户,d 为无号用户
invite_cost邀请码价格 每30天,默认 1000
srank_costS级权益相关消耗价格,默认 5
leave_ban是否开启退群封禁,默认 true true or false
uplays是否开启用户播放结算奖励,默认 true true or false
Emby Media
媒体库控制
emby_block["媒体库名称"] 由用户能控制显示隐藏的媒体库,bot中也可设置
extra_emby_libs["媒体库名称"] 默认隐藏,不想对新用户显示的媒体库,用户无法控制显隐,管理通过命令/kk可指定开启
探针
效果图
tz_ad 探针地址 https://xx.xx.xyzhttp://25.25.25.25:8008 最后不带斜杠,没有请留空
tz_api探针后台生成的 api
tz_id 需要展示的 机器的 id,tz开头的三项是和探针在一起的项目,没有哪吒或者komari探针就忽略。
tz_versiontz_version 可选值: v0 (Nezha V0 Token认证), v1 (Nezha V1 用户名密码认证), komari (Komari API Key认证)
tz_username若探针站点需要登录访问,填写登录用户名;不需要则留空
tz_password若探针站点需要登录访问,填写登录密码;不需要则留空
ranks logo 日榜/周榜推送榜单图片中的LOGO文字,同时也是注册、续期码的前缀,请尽量保持中间没有空格,影响体验。默认SAKURA
backdrop 是否使用backdrop(即横版图)作为推送榜单的封面图 ,默认false
schedall
各种定时任务管理
dayrank默认true,定时发送媒体播放次数日榜,每日 18:30
weekrank默认true,定时发送媒体播放次数周榜,每周日 23:59
dayplayrank默认false定时发送用户观看时长日榜,每日 23:00
weekplayrank默认false定时发送用户观看时长周榜,每周日23:30
check_ex
到期保号
默认,true检测用户到期时间与当前utc时间大小,过期封禁,5天后未续期删号,每日 01:30
low_activity
活跃保号
默认,false检测用户最后一次活跃时间,间隔当前超过21天封禁,每日 08:30
partition_check是否开启分区到期检查,默认 true,每 10 分钟检查一次
backup_db默认 false,自动定时备份数据库,每日 02:30
backup_db
数据库备份详细设置
db_is_docker默认 true,数据库是否为docker模式启动,or false
db_docker_name默认 mysql,若docker模式启动的数据库,此数据库容器的名字
db_backup_dir默认 ./db_backup,数据库备份文件保存目录
db_backup_maxcount默认 7数据库备份文件保留的个数
AntiChanel
反皮套白名单
w_anti_channel_ids本机器人默认开启反频道(杀皮套人)功能,除匿名群管皮套,如需要允许其发言请将其id或username加入列表,当然,支持命令操作,请查阅命令大全
运行策略kk_gift_dayskk相关赠送天数,默认 30
fuxx_pitao是否启用反皮套强化逻辑,默认 true
activity_check_days活跃检测天数阈值,默认 21
freeze_days冻结处理天数阈值,默认 5
白名单专属线路emby_whitelist_line 【服务器板块】展示给白名单用户的emby地址和信息,仅支持telegram的MarkdownV2写法
客户端过滤blocked_clients 通过 webhook 来拦截的客户端名字,示例:[".*curl.*",".*wget.*",".*python.*",".*bot.*", ".*spider.*",".*crawler.*", ".*scraper.*",".*downloader.*",".*aria2.*",".*youtube-dl.*",".*yt-dlp.*",".*ffmpeg.*",".*vlc.*"]
client_filter_terminate_session拦截到客户端后是否自动终止客户端的播放,默认 true
client_filter_block_user拦截到客户端后是否封禁用户,默认 false
分区资源partition_libs分区媒体库配置,默认 {},用于按分区管理媒体库规则,示例:{"4K": ["4K 剧集", "4K 电影"]}
red_envelope
红包功能
status默认 true,是否开启红包功能
allow_private默认 true,是否允许私聊使用红包功能
AutoUpdate
自动更新Bot代码
status默认true,是否开启自动更新程序,每日 12:30
git_repo
拉取的代码仓库名称
默认berry8838/Sakura_embyboss,如有魔改请填写自己的仓库,以免代码覆盖
commit_sha
所获取的latest commit sha
默认null,无需动,自动更新时会保存进此处以便下次比对
up_description更新说明文本,默认 null,自动更新时可用于展示变更描述
api
内置接口服务
status默认true,是否启用内置 HTTP 接口服务
http_url默认0.0.0.0,接口监听地址
http_port默认8838,接口监听端口
allow_originsCORS 允许来源列表,默认["*"],可按需收紧
MoviePilotService
点播功能
status默认false,是否开启求片程序
url默认null 或空字符串,形如:http://xxx.xxx.xxx.xxx:3001 的moviepilot地址(旧版字段名可能为 host
username默认null,登录的用户名
password默认null,登录的密码
access_token默认null,验证身份以后的token,会自动更新,勿动
price默认1,按体积计算,每1G 收取的花币
download_log_chatid下载日志推送目标 chat id,默认 null
lv点播所需等级,默认 b。说明:a 为白名单用户, b 为普通用户