Vector000 / bilive_client

基于Node.JS的bilibili直播挂机系统
MIT License
150 stars 30 forks source link

bilive_client

Node.js Commitizen friendly GitHub repo size MIT

使用方法

  1. 安装Node.js,建议使用LTS版本
  2. 安装Git
  3. 在命令行中定位到想要安装的目录
  4. git clone https://github.com/Vector000/bilive_client.git
  5. cd bilive_client 进入程序主目录
  6. npm inpm install 安装依赖包
  7. npm i -g pm2(自动更新所需,可忽略)
  8. npm run build 第一次启动需进行手动编译
  9. npm start(直接启动) 或 pm2 start(通过PM2后台启动)

手动更新(从旧版本更新)

  1. 定位到bilive_client目录下
  2. git pull 拉取更新
  3. npm inpm install 检查更新依赖包
  4. npm run build 手动进行编译
  5. npm startpm2 start

更新之后可能会出现不兼容的情况(或者bug),可删去options/options.json后重新进行账号设置

可使用网页设置:点此进行设置\ 推荐使用docs/index.html进行本地设置,也可使用HTTP POST进行设置

PM2

可使用PM2在后台启动挂机进程,无需终端常驻,并可通过pm2 restart bilive_client来进行重启 之所以用PM2做更新,是觉得PM2比较好用,而且重启方便,还能导出日志 后面可能会引入一个类似于子进程触发更新的机制,顺便看看做release的话有没有什么好的更新方法

设置相关

服务器挂机用户可通过防火墙设置来开启远程设置,但由此产生的信息泄露及其他风险请自行承担

HttpApi 相关

请求地址 => http(s)://ip:你设置的端口(options.server.port)/api

请求方式 => POST

请求参数 => Header 包含 authorization 值为 options.server.protocol

具体接口和参数与 ws 操作一致,返回内容一致,具体传入和传出参数请参照 webapi.ts

目前有

{
    "getLog": "获取日志",
    "getConfig": "获取配置",
    "setConfig": "设置配置",
    "getAdvConfig": "获取高级设置",
    "setAdvConfig": "设置高级设置",
    "setNewNetkey": "修改密钥",
    "getInfo": "获取参数描述",
    "getAllUID": "获取uid",
    "getUserData": "获取用户配置",
    "setUserData": "设置用户配置",
    "delUserData": "删除用户",
    "newUserData": "新增用户",
    "getAllUtilID": "获取util ID",
    "getUtilData": "获取utilData",
    "utilMSG": "接收util数据,触发对应util"
}

服务端相关

使用releases

不存在的,不存在的,永远也不会发release的 最近有个想法,可能会做release

Features

TO-DO