README.md

pvg-rs

Explore, filter and download illustrations from your pixiv bookmark.

Features

• Sync with your pixiv bookmark incrementally
• Find or exclude bookmarked illustrations by tags, title or author
• Parallel and reliable download of bookmarked illustrations
• Access from local machine or network via a responsive Web UI
• Cross-platform (Windows, Linux, and Android via Termux are tested)

Screenshot

Getting Started

• Download and extract the latest Release for your platform
• Retrieve your pixiv refresh_token
  • See Retrieving Auth Token or use get-pixivpy-token
• Create a config.json file in the extracted directory
  • A minimal example:

    {
        "username": "<your pixiv username>",
        "refresh_token": "<your refresh token>"
    }

• Run pvg or pvg.exe to start the server
• Open the URL shown in the terminal (Ctrl-click) in your browser
  • Typically http://127.0.0.1:5678

Configuration

The following options can be specified in the config.json file:

• username: Your pixiv username (required)
• refresh_token: Your pixiv refresh token (required)
• port: The port to listen on (default: 5678)
• host: The host to listen on (default: "127.0.0.1")
  • Specify a LAN address or "0.0.0.0" to allow access from network
• proxy: The proxy to use for network requests
  • Example: "http://127.0.0.1:8080"
• safe_mode: Turn on to show only illustions with a safe sanity_level (default: false)
• home: The directory to store the index and downloaded files (default: .)
  • Illustrations are saved in <home>/pix

Build

$ cargo build --release

Credits

The usage of pixiv AAPI refers to the following projects:

• pixivpy
• pixivpy-async