Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
MadeOfMagicAndWires committed May 18, 2017
1 parent 26a6e97 commit f6878f1
Showing 1 changed file with 29 additions and 21 deletions.
50 changes: 29 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,36 @@
qBittorrent BakaBT searchplugin
===============================
qBittorrent Search plugins
==========================

[bakabt.me](https://bakabt.me) is a site that specialises in high-quality,well-seeded and complete anime-related materials.
This plugin allows you to search BakaBT from within the qBittorrent integrated search.
[bakabt.me](https://bakabt.me) is a site that specialises in high-quality,
well-seeded and complete anime-related materials.

[linuxtracker](http://linuxtracker.org) is a tracker for linux torrents,
including distro .iso files and software tarballs.

Installation
------------

### Linuxtracker
Simply download the [plugin file](engines/linuxtracker.py) or copy the
following [link](https://github.com/MadeOfMagicAndWires/qBit-plugins/raw/master/engines/linuxtracker.py).

After you've done this you can add this plugin to qBittorrent by going:

<kbd>Search tab</kbd> 🡪 <kbd>Search Plugins</kbd> 🡪 <kbd>Install a new one</kbd>
<kbd>Local File</kbd> then select the plugin file
**or**
<kbd>Web Link</kbd> then insert the link you copied.

Or by manually copying the `bakabt.py` to the following location:
* Linux: `~/.local/share/data/qBittorrent/nova/engines/linuxtracker.py`
* Mac: ``~/Library/Application Support/qBittorrent/nova/engines/linuxtracker.py`
* Windows: `C:\Documents and Settings\username\Local Settings\Application Data\qBittorrent\nova\engines\linuxtracker.py`

### BakaBT
Because BakaBT requires your login info, this plugin requires a bit more work than most.

1. Firstly you'll need an [account](https://bakabt.me/#.php)
1. Firstly you'll need an ~~[account](https://bakabt.me/#.php)~~
(Admission currently closed)
2. Then you need to put your login information directly into the [plugin file](engines/bakabt.py):

You can do this by editing these specific lines (lineno. 52:53).
Expand All @@ -32,26 +54,12 @@ So if your username is `foobar` and your `password` is bazqux these lines should
password = "bazqux"
...
```

After you've done this you can add this plugin to qBittorrent by going:
<kbd>Search tab</kbd> 🡪 <kbd>Search Plugins</kbd> 🡪 <kbd>Install a new one</kbd> 🡪 Selecting the `bakabt.py` file.

Or by manually copying the `bakabt.py` to the following location:
* Linux: `~/.local/share/data/qBittorrent/nova/engines/bakabt.py`
* Mac: ``~/Library/Application Support/qBittorrent/nova/engines/bakabt.py`
* Windows: `C:\Documents and Settings\username\Local Settings\Application Data\qBittorrent\nova\engines\bakabt.py`
After this is done you can follow the same steps as with the other plugins.

F.A.Q
-----

1. **BakaBT is a public tracker. Why does this plugin need my login information?**

Although the tracker is public, and anyone can download torrent files without an account,
the [search functions](https://bakabt.me/browse.php) are only available to users.

2. **This plugin doesn't require my torrent pass, does this plugin provide personalized torrents?**
1. **This plugin doesn't require my torrent pass, does this plugin provide personalized torrents?**

Because the plugin logs you in for every search, this means that the torrent files you open using it are your
personal ones. It's effectively no different than if you'd visit the site and download the torrent manually.

![](https://bakabt.me/resources/img/bg_1920.png)

0 comments on commit f6878f1

Please # to comment.