BiliOutils Documentation

website·Indexed 31 days ago

https://bo.thefish.icu/

Documentation for a Bilibili automation tool featuring configuration guides for JSON5, account management, and deployment instructions for GitHub Actions, Aliyun FC, Tencent SCF, Huawei AGC, and Baidu CFC. Includes detailed schemas for coins, manga, gifts, and intimacy tasks, as well as guides for obtaining cookies and managing environment variables.

Tokens
18K
Snippets
92
Records
133
Agent score
49%

What's inside BiliOutils

  1. Contact the author and report issues

    To get support or report bugs for the project, users are encouraged to submit a GitHub issue. The author will provide a response as soon as possible.
  2. Quick start configuration for bo.thefish.icu

    To enable most features of the product, you only need to configure the cookie. For an optimized user experience, it is recommended to configure additional information beyond the cookie.
  3. Schedule BiliOutils on Windows using Task Scheduler

    To run BiliOutils automatically on Windows, use the system Task Scheduler (taskschd.msc).

    1. Open Task Scheduler via Win + R and enter taskschd.msc.
    2. Create a new task.
    3. In the 'Action' tab, set the program/script to bilioutils.
    4. In the 'Add arguments' field, specify the config path and other flags (e.g., -c E:\github\bilitools\config.json5).
    5. Ensure the command can run successfully in a standard CMD or PowerShell window before scheduling.
  4. Set up Bilibili Manga automation in WPS

    To set up the Bilibili Manga automation tool, follow these steps:

    1. Register/Login: Create an account at https://www.kdocs.cn/.
    2. Save Template: Access the '漫画签到-模板' (Manga Check-in Template) at https://kdocs.cn/l/cuQrjaKqKg87 and save it to your account.
    3. Obtain Cookie: Capture your Bilibili session cookie. The cookie string should contain fields such as SESSDATA, bili_jct, and DedeUserID.
    4. Configure: Enter your cookies into the saved template spreadsheet.
      • Check-in scripts: Can be configured on any row and support multiple accounts.
      • Redemption scripts: Must be configured on the second row only (does not support multiple accounts).
    5. Save: Ensure the spreadsheet is saved after entering configuration details.
  5. Install and deploy bilioutils on Alibaba Cloud FC

    Install the bilioutils package in the FC environment. If you encounter engine compatibility errors (e.g., Node version mismatch between the build and runtime environment), use the ignore-engines configuration.

    After installing dependencies, update the index.js file to export the FC handler.

    # Optional: Set registry to default for the latest modules
    npm config set registry https://registry.npmjs.org/
    
    # If engine compatibility errors occur
    npm config set ignore-engines true
    
    # Install the library
    npm install bilioutils
    // index.js
    exports.handler = require('bilioutils').fc_handler();
  6. Update Bilibili Cookies for BiliOutils

    To update cookies, install the @catlair/blogin dependency and run the login command. Use a mobile phone to scan the resulting QR code. If the mid exists in the configuration file, it will update automatically; otherwise, copy the printed cookie from the console or log file into your configuration.
    yarn add @catlair/blogin
    npx bilioutils -l
  7. Extract Bilibili cookies on mobile using Alook browser

    To retrieve cookies from Bilibili on a mobile device, use the Alook browser (available in app stores or at alookweb.com).

    Steps to extract cookies:

    1. Open Alook browser and navigate to Bilibili.
    2. Log in to your account.
    3. Open the browser menu and navigate to the 'Toolbox' (工具箱).
    4. Select 'Developer Tools' (开发者工具).
    5. Choose the 'Cookies' tab.
    6. Copy the cookie values from the list.
  8. Join the project QQ group

    Users can join the project's community via the QQ group. The group password is 'catlair' followed by an exclamation mark (!).
  9. Configure Bilibili Cookies to avoid risk control

    To avoid risk control and ensure stability, use a complete Cookie string rather than just the basic identifiers. While DedeUserID, bili_jct, and SESSDATA are the minimum requirements, including buvid3, buvid4, and other fingerprint tokens is strongly recommended to prevent anomalies.

    To prevent cookies from expiring due to automatic refreshes in your main browser session:

    1. Open a Private/Incognito window.
    2. Log in to Bilibili.
    3. Extract the cookie.
    4. Close the private window immediately without logging out; logging out will invalidate the cookie.
    _uuid=...; buvid3=...; fingerprint=...; buvid_fp=...; SESSDATA=...; bili_jct=...; DedeUserID=...; DedeUserID__ckMd5=...; sid=...; fingerprint3=...; fingerprint_s=...; buvid_fp_plain=...; CURRENT_FNVAL=...; blackside_state=...; rpdid=...; _dfcaptcha=...; LIVE_BUVID=...; bsource=...; PVID=...
  10. Set up Alibaba Cloud Function Compute (FC) for bilioutils

    To deploy bilioutils on Alibaba Cloud FC, create a service and a function with the following basic configurations to minimize costs:

    • Runtime: Node.js (version 14 or higher).
    • vCPU: 0.1 core.
    • Memory: 128M.

    Note: Without a resource package, costs are approximately 1 CNY per month if Alibaba Cloud Log Service is disabled and only basic tasks (excluding high-consumption tasks like 'Tianxuan' or 'Live Heartbeat') are running.

  11. Deploy and run via npm or Docker

    The application supports multiple deployment methods with specific parameters:

    • npm: Supports task, item, and config (to specify a custom config path) parameters, especially when used with the Qinglong panel.
    • Docker: Supports passing parameters directly to the container.
    • Cloud Functions: Supports a task parameter for additional configuration info on Tencent Cloud and Alibaba Cloud functions.