PluginCreate - Novik/ruTorrent GitHub Wiki

Create Plugin

Description

This plugin allows for the creation of new .torrent files from a file or directory full of files.

Usage

To use this plugin, click the "Create Torrent..." icon:

This should open the "Create New Torrent" window as shown below:

Next, add a file source (note: the _getdir plugin will make this a much easier process)

Next, fill in the tracker information (note: for public trackers, you may wish to enter more than one tracker here)

Optional: Select a "Piece size"

Optional: Fill in the checkboxed

  • Start seeding this will add the torrent to the download list immediately upon creation
  • Private Torrent select this if you are uploading to a private tracker

Click "Create..." This will open the "Console" window, here you can see the progress, any status information and errors that occur:

When everything is finished and you see "Done." in the status window, you have the option to download the .torrent file directly from ruTorrent by clicking the "Save" button.

Configuration

This plugin has a few config options. Prior to 3.0, create plugin in it's default state couldn't handle large torrents. If you are on a 64 bit os, this is no longer the case. You can still use several external programs to create torrents with this plugin. Currently the plugin supports:

The default config file looks like this:

<?php
// configuration parameters

$useExternal = false;		// Valid choices:
				// false - use internal realization (may be too slow for large files)
				// "transmissioncli" - use program transmissioncli (see http://www.transmissionbt.com/)
				// "transmissioncreate" - use program transmissioncreate (see http://www.transmissionbt.com/)
				// "createtorrent" - use program createtorrent (see http://www.createtorrent.com)
				// "mktorrent" - use program createtorrent (see http://mktorrent.sourceforge.net)
				// "buildtorrent" - use program buildtorrent (see http://claudiusmaximus.goto10.org/cm/torrent.html)
$pathToCreatetorrent = '';	// Something like /bin/createtorrent, or /bin/transmissioncli. If empty, program will be found in PATH.

$recentTrackersMaxCount = 15;

This should be pretty easy to understand, but some people still get this wrong. If you are using an external program, pick the correct option, and change useExternal accordingly, so for example, for mktorrent, you'd change this:

$useExternal = false;

to this:

$useExternal = 'mktorrent';

and, of course, add the proper PATH in the location provided, so keeping with our previous example, lets say mktorrent is located at /usr/local/bin/mktorrent, you'd change this:

$pathToCreatetorrent = '';

to this:

$pathToCreatetorrent = '/usr/local/bin/mktorrent';