Skip to content

Latest commit

 

History

History
117 lines (99 loc) · 3.49 KB

CONFIG.md

File metadata and controls

117 lines (99 loc) · 3.49 KB
Raw

🔬 [实验性功能|EXPERIMENTAL] 本地配置文件

由于使用URL参数仍有诸多限制(比如长度限制,数据结构单一,特殊字符串需转义),所以本地部署版本提供了更为灵活的配置文件。

首先,在 运行BILICHAT的目录(PWD) 新建一个 config.json文件

如果你使用npm发布包,你可以将此文件放在任何目录,只要你在当前所在目录执行bilichat命令就可以

如果你希望为特定用户提供特定的配置参数,将文件名改为 config.<用户ID>.json即可。如config.4331384.json

一个典型的配置文件格式应当是这样的

{
    "displayMode": 3,
    "loadAvatar": true,
    "levelFilter": 0,
    "wordFilter": [],
    "showGift": true,
    "hideGiftDanmaku": false,
    "groupSimilar": true,
    "customEmotions": [
        {
            "command": "理解理解",
            "source": "rikairikai.jpg"
        }
    ],
    "giftLevel": [
        {
            "value": 50,
            "color": "3F3F3F"
        }
    ],
    ...更多配置项
}

下面将解释各配置项的作用

loadAvatar : boolean

是否从api服务器拉取头像,默认true
设置为false时将全部显示B站默认头像

levelFilter : number

设置最低发言等级(UL等级),默认0(不屏蔽)
用户等级低于该值将不会显示

wordFilter : string[]

屏蔽关键字,当用户发言包含这些关键字时会被屏蔽。

正确格式是 ['关键字1','关键字2','...']

showGift : boolean

是否显示礼物赠送信息,默认true

hideGiftDanmaku : boolean

是否屏蔽礼物弹幕(如抽奖弹幕,节奏风暴),默认true 这不是礼物赠送信息

groupSimilar : boolean

堆叠相似弹幕,并显示相似弹幕数量,默认true

groupSimilarWindow : number

检测相似弹幕的窗口大小,默认5(检测最近5条)

maxDanmakuNum : number

渲染弹幕的最大数量,默认100
此项会影响渲染性能

displayMode : enum

显示控制微码,默认3

0   什么都不显示
1   只显示弹幕
2   只显示礼物
3   都显示

showGift优先于displayMode

blackList : number[]

UID黑名单。

minGiftValue : number

最低会显示的礼物价值,默认20

customGiftLevel : Array<{ value:number , color:object }>

设置礼物弹幕的不同等级及其颜色,默认值见源代码

[
    {
      "value": 0, "color": {
        "color_header": "rgba(0,0,0,1)", //
        "color_primary": "rgba(0,229,255,1)", //上半部分背景色
        "color_secondary": "rgba(0,184,212,1)", //下半部分(留言)背景颜色
        "color_message": "rgba(0,0,0,1)", //留言文字颜色
        "color_author_name": "rgba(0,0,0,0.701961)" //用户名颜色
      }
    }
]

value表示该等级的最低价值(RMB),color为对应颜色值(允许rgba hsl hex等由css直接提供支持的参数)

silverGiftRatio : number

银瓜子价值换算为金瓜子的比例,默认0,即任何数量银瓜子*0=0金瓜子,等于不显示任何银瓜子礼物。
设置为1即为金瓜子银瓜子等效。
可以设置一个恰当的小数,如0.1即10银瓜子=1金瓜子

customEmotions: Array<{ command:string , source:string }>

设置礼物弹幕的不同等级及其颜色,默认值为空数组 触发机制为全文匹配
例:

[
    {
        "command": "理解理解",
        "source": "https://image.domain/.../rikairikai.jpg"
    },
    ...更多配置项
 ]

当弹幕内容等于某个command时,会自动替换为source的图片。