| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| inside_bitcomet [2010/12/23 14:11] – [Torrent File Format] -added eMule and LT-Seeding info-keys greywizard | inside_bitcomet [2022/06/20 15:11] (current) – [BC Link Format (obsoleted as of v.1.17)] wxhere |
|---|
| * **"path"**: a list containing one or more string elements that, together, represent the path and filename. Each element in the list corresponds to either a directory name or (in the case of the final element) the filename. For example, a the file "dir1/dir2/file.ext" would consist of three string elements: "dir1", "dir2", and "file.ext". This is encoded as a bencoded list of strings such as l4:dir14:dir28:file.exte Important Notice: BitComet also includes empty directory when creating torrent, that is the file name here may be zero-length string. | * **"path"**: a list containing one or more string elements that, together, represent the path and filename. Each element in the list corresponds to either a directory name or (in the case of the final element) the filename. For example, a the file "dir1/dir2/file.ext" would consist of three string elements: "dir1", "dir2", and "file.ext". This is encoded as a bencoded list of strings such as l4:dir14:dir28:file.exte Important Notice: BitComet also includes empty directory when creating torrent, that is the file name here may be zero-length string. |
| |
| //Info keys common to **both** single-file and multi-file modes:// | //Info// <html><span id="privateflag", style=font-style:italic>keys</span></html> //common to **both** single-file and multi-file modes:// |
| |
| * **"ed2k"**: (optional) 128 bit eMule hash for each file of the torrent; | * **"ed2k"**: (optional) 128 bit eMule hash for each file of the torrent; |
| * **"piece length"**: number of bytes in each piece (integer); | * **"piece length"**: number of bytes in each piece (integer); |
| * **"pieces"**: string consisting of the chaining together of all 20-byte SHA1 hash values, one per piece (byte string); | * **"pieces"**: string consisting of the chaining together of all 20-byte SHA1 hash values, one per piece (byte string); |
| * **"private"**: (optional) if the torrent is a Private Torrent (SecureTorrent), it must only announce itself to the private tracker or to a single tracker at any time, if there are several trackers in the announce-list (integer, 0 or 1);(([[http://bittorrent.org/beps/bep_0027.html|Private Torrents]])); | * **"private"**: (optional) if the torrent is a Private Torrent (SecureTorrent), BitComet must only announce itself to the private tracker or to a single tracker at any time, if there are several trackers in the announce-list (integer, 0 or 1)(([[http://bittorrent.org/beps/bep_0027.html|Private Torrents]])); |
| * **"publisher"**: (optional) the name of the torrent creator, if do not allow to be changed (string); | * **"publisher"**: (optional) the name of the torrent creator, if do not allow to be changed (string); |
| * **"publisher-url"**: (optional) the URL of the torrent creator if do not allow to be changed (string); | * **"publisher-url"**: (optional) the URL of the torrent creator if do not allow to be changed (string); |
| **8) "publisher"**: (optional) the name of the torrent creator (string);\\ | **8) "publisher"**: (optional) the name of the torrent creator (string);\\ |
| **9) "publisher-url"**: (optional) the url of the torrent creator (string);\\ | **9) "publisher-url"**: (optional) the url of the torrent creator (string);\\ |
| **10) "comment"**: (optional) free-form textual comments by the author (string); | **10) "comment"**: (optional) free-form textual comments by the author (string);\\ |
| | **11) "url-list"**: (optional) a list containing one or more URLs of the mirror server(s) used as webseeding download sources.(([[http://www.getright.com/seedtorrent.html|GetRight webseeding specifications]]))(([[http://bittorrent.org/beps/bep_0019.html|HTTP/FTP webseeding - GetRight style]])). |
| |
| <html><span style=color:red;font-weight:bold>Important Notice:</span></html> | <html><span style=color:red;font-weight:bold>Important Notice:</span></html> |
| ==== BC Link Format (obsoleted as of v.1.17) ==== | ==== BC Link Format (obsoleted as of v.1.17) ==== |
| |
| A BC Link contains information for creating a BT task, HTTP task or FTP task. | A //BC Link// contains information for creating a BT task, HTTP task or FTP task. |
| The basic plain format is as following: | The basic plain format is as following: |
| |
| In additional, more parameters can be added: | In additional, more parameters can be added: |
| |
| bc://bt2/${TaskName}/${FileSize}/${InfoHash}/?torrent=${torrent_url} | bc://bt2/${TaskName}/${FileSize}/${InfoHash}/?torrent=${torrent_url}&infohash_v2=${InfoHashv2} |
| bc://http2/${TaskName}/?url=${url}&usr=${username}&psd=${password}&refer=${url_referer}&cookie=${url_cookie} | bc://http2/${TaskName}/?url=${url}&usr=${username}&psd=${password}&refer=${url_referer}&cookie=${url_cookie}&user_agent=${user_agent}&mirror=${mirror_url}&custom_headers_for_mirrors=true |
| bc://ftp2/${TaskName}/?url=${url}&usr=${username}&psd=${password} | bc://ftp2/${TaskName}/?url=${url}&usr=${username}&psd=${password} |
| | |
| Finally, with the advantage of hiding details from end-user, the BASE64 encoded format is recommended to distribute for public: | Finally, with the advantage of hiding details from end-user, the BASE64 encoded format is recommended to distribute for public: |
| |
| |
| <html><span style=color:Teal>Note:</span></html> To support various languages besides English, all parameters should be UTF8 + URL_Escape encoded before Base64 encoding. | <html><span style=color:Teal>Note:</span></html> To support various languages besides English, all parameters should be UTF8 + URL_Escape encoded before Base64 encoding. |
| | |
| | <html><span style=color:Teal>Note:</span></html> If multiple HTTP mirrors available for a HTTP task, multiple "mirror" parameters can be added. |
| | |
| | <html><span style=color:Teal>Note:</span></html> If "custom_headers_for_mirrors" parameter is true, the "referer", "cookie" and "user_agent" will also be sent to mirror addresses. |
| | |
| | <html><span style=color:Teal>Note:</span></html> Starting with BitComet v.1.17 //BC Links// have been replaced by //Magnet Links// (see below). |
| |
| ---- | ---- |
| |
| A [[peers_seeds_torrent_tracker_dht_peer_exchange_pex_magnet_links#magnet_links|Magnet URI]] contains information for locating a P2P resource. BitComet can use it to start a BT download. | A [[peers_seeds_torrent_tracker_dht_peer_exchange_pex_magnet_links#magnet_links|Magnet URI]] contains information for locating a P2P resource. BitComet can use it to start a BT download. |
| The format is as following: | The basic v1 format is as following: |
| |
| magnet:?xt=urn:btih:<info-hash>&dn=<name>&tr=<tracker-url>&xl=<task-size> | magnet:?xt=urn:btih:<info-hash-v1> |
| | |
| | The basic v2 format with a 32 bytes info hash of SHA256: |
| | |
| | magnet:?xt=urn:btmh:1220<info-hash-v2> |
| | |
| | The hybrid format with info hash v1 and v2: |
| | |
| | magnet:?xt=urn:btih:<info-hash-v1>&xt=urn:btmh:1220<info-hash-v2> |
| | |
| | In additional, more parameters can be added: |
| | |
| | magnet:?xt=urn:btih:<info-hash-v1>&dn=<name>&xl=<task-size>&tr=<tracker-url>&ws=<escaped_web_seed_url>&xs=<escaped_torrent_file_url> |
| |
| ---- | ---- |
| === Mandatory parameter === | === Mandatory parameter === |
| |
| **xt**=urn:btih:<info-hash> is a mandatory parameter for BitTorrent magnetic links. | **xt**=urn:btih:<info-hash-v1> is a mandatory parameter for BitTorrent v1 magnetic links. |
| | |
| | **<info-hash-v1>** is the torrent info-hash-v1 hex encoded, for a total of 40 characters. The 32 character [[http://www.ietf.org/rfc/rfc3548.txt|base32]] encoded info-hash-v1 is also accepted. |
| | |
| | **xt**=urn:btmh:1220<info-hash-v2> is a mandatory parameter for BitTorrent v2 magnetic links. |
| |
| **<info-hash>** is the torrent info-hash hex encoded, for a total of 40 characters. The 32 character [[http://www.ietf.org/rfc/rfc3548.txt|base32]] encoded info-hash is also accepted. | **<info-hash-v2>** is the torrent info-hash-v2 hex encoded, for a total of 64 characters. |
| |
| ---- | ---- |
| |
| **dn** is the user-friendly display name (which may be displayed while waiting for metadata); it should be UTF8 + URL_Escape encoded for non-English characters.\\ | **dn** is the user-friendly display name (which may be displayed while waiting for metadata); it should be UTF8 + URL_Escape encoded for non-English characters.\\ |
| **tr** is a tracker URL, if there is one; for multiple trackers multiple "tr" parameters may be added.\\ | |
| **xl** is the task size.\\ | **xl** is the task size.\\ |
| | **tr** is a tracker URL, if there is one; for multiple trackers multiple "tr" parameters may be added.\\ |
| | **ws** is the escaped web seed URL.\\ |
| | **xs** is the escaped HTTP URL of torrent file.\\ |
| | |
| For a technical introduction to Magnet URIs please refer to [[wp>Magnet URI scheme]]. | For a technical introduction to Magnet URIs please refer to [[wp>Magnet URI scheme]]. |
| |
| |
| Make the torrent file with the "//Private torrent//" (or "//Only accept peers from tracker//" in older versions) option enabled (no DHT or Peer Exchange allowed for that torrent and also no Torrent Exchange/Share, LT-Seeding or eDonkey connectivity enabled in BitComet). | Make the torrent file with the "//Private torrent//" (or "//Only accept peers from tracker//" in older versions) option enabled (no DHT or Peer Exchange allowed for that torrent and also no Torrent Exchange/Share, LT-Seeding or eDonkey connectivity enabled in BitComet). |
| Read [[Making Torrents with BitComet]] for more information on how to enable this option upon making a torrent. This option will add a "//private//" tag in the torrent file, and has the same meaning as [[http://wiki.vuze.com/w/SecureTorrents|SecureTorrent in Azureus]]. | Read [[Making Torrents with BitComet]] for more information on how to enable this option upon making a torrent. This option will add a "//[[inside_bitcomet#privateflag|private]]//" tag in the torrent file, and has the same meaning as [[http://wiki.vuze.com/w/SecureTorrents|SecureTorrent in Azureus]]. |
| |
| * **For a tracker admin:** | * **For a tracker admin:** |
| - When a task finished downloading, a Hash Checking will be performed to prepare for eMule plugin uploading, if the torrent is not private and the eMule plugin is not disabled, but it was not supported by the torrent maker. | - When a task finished downloading, a Hash Checking will be performed to prepare for eMule plugin uploading, if the torrent is not private and the eMule plugin is not disabled, but it was not supported by the torrent maker. |
| - When a task finished downloading, a Hash Checking will be performed if the "//bittorrent.hash_check_on_finished//" option on the //Advanced Options// page is set to TRUE. | - When a task finished downloading, a Hash Checking will be performed if the "//bittorrent.hash_check_on_finished//" option on the //Advanced Options// page is set to TRUE. |
| | |
| | ---- |
| | |
| | ==== AJAX interface for Remote Download ==== |
| | |
| | see details in [[AJAX interface for Remote Download|this page]] |
| |
| ---- | ---- |
| -[[bitcomet_command_line|Previous Page]]\\ | -[[bitcomet_command_line|Previous Page]]\\ |
| -[[start|Main Index]] | -[[start|Main Index]] |
