Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kingwingfly/bilibili-downloader-rs

A bilibili downloader built by Tauri and the language you-know-who. This repo is yanked, https://github.com/kingwingfly/downloader is the new version.
https://github.com/kingwingfly/bilibili-downloader-rs

Last synced: about 1 month ago
JSON representation

A bilibili downloader built by Tauri and the language you-know-who. This repo is yanked, https://github.com/kingwingfly/downloader is the new version.

Host: GitHub
URL: https://github.com/kingwingfly/bilibili-downloader-rs
Owner: kingwingfly
Archived: true
Created: 2023-04-23T11:04:51.000Z (almost 2 years ago)
Default Branch: release
Last Pushed: 2023-08-27T14:13:40.000Z (over 1 year ago)
Last Synced: 2024-09-24T16:10:20.170Z (5 months ago)
Language: Rust
Homepage:
Size: 3.62 MB
Stars: 43
Watchers: 1
Forks: 6
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome-rust-list - kingwingfly/bilibili-downloader-rs - downloader-rs?style=social"/> : Bilibili Downloader. A bilibili video downloader app built by Tauri, Vue and Rust! (GUI)
awesome-rust-list - kingwingfly/bilibili-downloader-rs - downloader-rs?style=social"/> : Bilibili Downloader. A bilibili video downloader app built by Tauri, Vue and Rust! (GUI)

README

        [![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]






  

    

  

  
Bilibili Downloader


  


    A bilibili video downloader app built by Tauri, Vue and Rust!

    


    Explore the docs »

    


    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  



  Table of Contents

  


    

      About The Project

      

        Built With

      

    

    

      Getting Started

      

        Prerequisites

        Compile

      

    

    Usage

    Roadmap

    Contributing


    
Contact

    Acknowledgments

  


## About The Project

[![Product Name Screen Shot][product-screenshot]](https://github.com/kingwingfly/bilibili-downloader-rs/)

[![Product Architecture][architecture]](https://github.com/kingwingfly/bilibili-downloader-rs/)

This is a Downloader for bilibili built by Tauri and Rust.

 

## Important

### ffmpeg

You need `ffmpeg` to  merge the video and audio downloaded. Official download is [here](https://ffmpeg.org/download.html).

![ffmpeg_setting](./static/ffmpeg_setting.png).

So, for MacOS, you need use brew to install ffmpeg, or just download one and put it into `/usr/local/bin`. Then you need use `which ffmpeg` to get the detailed path of it, and paste it in the app's setting, or you can't invoke the `ffmpeg` in released tauri app. (The chat-GPT says Unix can not get `path` in release version)

Moreover, due to the apple developer is expensive, so I can not provide an arch version. But the x64 version in release page can still be used, just remember opening it by right clicking the app icon and select open for the first time. And you should also permit your Mac allowing unknown source app in the system setting. 

For Windows, downloading the `ffmpeg` and adding it to path are enough. Recommend this [portable version](https://github.com/gniuk/cross-compile-ffmpeg-for-windows). Official version is also Ok certainly.

You could also specify a path to `ffmpeg` as you like in settings.

### An important new feature: Key Chain

For protecting your account security, from v0.0.4 on, I'll use the system key manager to protect your bilibili cookie. This is implemented by a rust crate called `keyring`.

For example, it will use `key chain` (AKA `钥匙串访问.app` in Chinese macOS system) to manage the bilibili downloader's config including cookie. That will be much safer if you don't allow other apps to visit it.

![warning](./static/warning.png)

Don't be worried as you can see the system having told you bili downloader only ask for one key with a name called `bili downloader` which will be created by the app itself later. Getting `Always allow` option chosen will be greatly convinient for you.

What's less important, you should ensure your system has `Environment variable` named `USERNAME`. However, almost all system has it. If not, the app will just panic. Check it by `echo $USERNAME` in Linux or Unix like system or `Get-ChildItem Env: | findstr USERNAME` in powershell of Windows as you like for it's usually unnecessary.

If you don't like the app and decide to uninstall it, just deleting the key named `bilibili downloader` in `key chain` in macOS is OK. Other system I'm sorry I don't known.

And if the cookie is too long, it will also panic. All you need is just the `ESSADATA` line of the cookie. ([where to find cookie](#Usage))

![delete key](./static/delete%20key.png)

By the way, many apps like vscode or adobe save the key info through the same way.

Last, I don't know how Windows protect the cookie. That's strange the system didn't ask permission when I test the app on Windows. 

## Advantages

Here are advantages:

* Simultaneous downloads: This downloader can potentially download multiple videos at once, making it a faster and more efficient tool for users.

* Reduced storage space: A smaller-sized image downloader can potentially take up less space on the user's device, which is especially beneficial for devices with limited storage capacity.

(back to top)


### Built With

* [![Rust][RustLogo]][Rust-url]

* [![Tauri][TauriLogo]][Tauri-url]

* [![Tokio][TokioLogo]][Tokio-url]

* [![Vue][Vue.js]][Vue-url]

(back to top)


## Getting Started

You can compile by yourself, or just got release [here](https://github.com/kingwingfly/bilibili-downloader-rs/releases).

### Prerequisites

You need rust, tauri-cli, npm first. 

* npm

  ```sh

  npm install npm@latest -g

  ```

* tauri

  ```sh

  cargo install create-tauri-app

  ```

And maybe you need this [Tauri Quick Start](https://tauri.app/v1/guides/getting-started/setup) for further infomation. 

### Compile

1. Clone the repo

   ```sh

   git clone https://github.com/kingwingfly/bilibili-downloader-rs.git

   cd bilibili-downloader-rs

   ```

2. Install NPM packages

   ```sh

   npm install

   ```

3. start compile

   ```sh

   cargo tauri build

   ```

(back to top)


## Usage

Maybe you can get cookie through your browser.

![cookie_get](./static/get_cookie.png)

![cookie_setting](./static/cookie_setting.png)

(back to top)


## Roadmap

- [x] Keep config

- [x] Fix bug: fast switch before the real download beginning will lead range downloads out of sync

- [x] The real pause of resp.chunk()

- [ ] Lazily check restart

- [ ] Performance optimize

- [x] Encrypt cookie

- [ ] Limit the download speed in default

- [ ] Remind user to like, coin and collection

- [x] File name check

- [x] Use JoinSet replace jhs

See the [open issues](https://github.com/kingwingfly/bilibili-downloader-rs/issues) for a full list of proposed features (and known issues).

(back to top)


## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

(back to top)


## Contact

Louis - [@email]([email protected]) - [email protected]

Project Link: [https://github.com/kingwingfly/bilibili-downloader-rs](https://github.com/kingwingfly/bilibili-downloader-rs)

(back to top)


## Acknowledgments

Some document may help in developing tauri app and crawler.

* [Tauri Example](https://github.com/tauri-apps/tauri/tree/dev/examples)

* [Tokio Quick Tutorial](https://tokio.rs/tokio/tutorial)

* [Rust Reqwest](https://crates.io/crates/reqwest)

* [Vue Document](https://router.vuejs.org/zh/guide/)

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/kingwingfly/bilibili-downloader-rs.svg?style=for-the-badge

[contributors-url]: https://github.com/kingwingfly/bilibili-downloader-rs/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/kingwingfly/bilibili-downloader-rs.svg?style=for-the-badge

[forks-url]: https://github.com/kingwingfly/bilibili-downloader-rs/network/members

[stars-shield]: https://img.shields.io/github/stars/kingwingfly/bilibili-downloader-rs.svg?style=for-the-badge

[stars-url]: https://github.com/kingwingfly/bilibili-downloader-rs/stargazers

[issues-shield]: https://img.shields.io/github/issues/kingwingfly/bilibili-downloader-rs.svg?style=for-the-badge

[issues-url]: https://github.com/kingwingfly/bilibili-downloader-rs/issues

[license-shield]: https://img.shields.io/github/license/kingwingfly/bilibili-downloader-rs.svg?style=for-the-badge

[license-url]: https://github.com/kingwingfly/bilibili-downloader-rs/blob/master/LICENSE.txt

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://linkedin.com/in/othneildrew

[product-screenshot]: static/screenshot.png

[architecture]: static/architecture.png

[RustLogo]: https://www.rust-lang.org/static/images/rust-logo-blk.svg

[Rust-url]: https://github.com/rust-lang/rust

[TauriLogo]: https://github.com/tauri-apps/tauri/blob/dev/.github/splash.png?raw=true

[Tauri-url]:https://github.com/tauri-apps/tauri

[TokioLogo]: https://img.shields.io/badge/Rust-Tokio-orange

[Tokio-url]: https://tokio.rs

[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D

[Vue-url]: https://vuejs.org/

****