Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dromzeh/qbit-rpc
A Discord Rich Presence for qBittorrent.
https://github.com/dromzeh/qbit-rpc
discord discord-rpc qbittorent qbittorrent-api qbittorrent-webui rich-presence rpc typescript
Last synced: about 1 month ago
JSON representation
A Discord Rich Presence for qBittorrent.
- Host: GitHub
- URL: https://github.com/dromzeh/qbit-rpc
- Owner: dromzeh
- License: mit
- Created: 2023-01-31T17:44:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T12:11:46.000Z (10 months ago)
- Last Synced: 2024-12-17T04:05:28.707Z (about 2 months ago)
- Topics: discord, discord-rpc, qbittorent, qbittorrent-api, qbittorrent-webui, rich-presence, rpc, typescript
- Language: TypeScript
- Homepage:
- Size: 42 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# qbit-rpc
A simple Discord Rich Presence for qBittorrent, tested on Windows & Linux.
## Installation
[pnpm](https://pnpm.js.org/) and [Node.js](https://nodejs.org/) are required to run this program.
Installing pnpm (globally) using npm:
```bash
npm i -g pnpm
```
## Usage
1. Make sure you have **enabled the Web UI** in qBittorrent. **qBittorrent MUST be open before starting the Rich Presence.**
2. You not need to modify anything but `config/config.json`, this is to include the `ip`, `port`, `username` and `password` of your qBittorrent WebUI instance.
3. The `filterInactiveUL` / `filterInactiveDL` value is what controls if 'inactive' torrents are shown or not. (`default: false`)
4. `pnpm start` to start the client ( + `pnpm i` to install dependencies if you haven't already)
5. If you are using defaults, the RPC will automatically connect to the qBittorrent WebUI on `127.0.0.1:8080` and will update your status every 10 seconds.
* ~~If the repository is cloned, the program will check for updates on startup.~~
## Issues
This program is barely updated but is in a working state - if the program is broken or you have any issues, please open an issue and contact me on Discord: `@dromzeh`.
## Contributing
Pull requests are welcome and appreciated for any changes or improvements - please open an issue for discussion before making any changes.
## License
Licensed under [MIT](https://mit.dromzeh.dev) © 2024 [dromzeh](https://dromzeh.dev)