Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.12 KB

README.md

File metadata and controls

70 lines (45 loc) · 2.12 KB
Raw

PHP Torrent File Library

Packagist PHP License Gitlab pipeline status Codecov

A PHP Class to work with torrent files

Installation

composer require arokettu/torrent-file

Usage

<?php

use Arokettu\Torrent\TorrentFile;

// open file
$torrent = TorrentFile::load('debian.torrent');
// create for path (file or directory)
$torrent = TorrentFile::fromPath('/home/user/dists/debian');

// manipulate fields
$torrent->setAnnounce('http://tracker.example:1234');

// list files
foreach ($torrent->v1()->getFiles() as $file) {
    echo implode('/', $file->path()) , ': ' , $file->length, PHP_EOL;
}

Features

  • Torrent file data manipulation
  • Torrent file creation
  • Torrent file listing
  • Support for torrent files version 1, version 2, Hybrid v1+v2, a lot of BEPs like Nodes, Url Lists, etc
  • Torrent file signing

CLI tool

A CLI tool based on the library: https://sandfox.dev/php/torrent-file-cli.html

Documentation

Read full documentation here: https://sandfox.dev/php/torrent-file.html

Also on Read the Docs: https://torrent-file.readthedocs.io/

Support

Please file issues on our main repo at GitLab: https://gitlab.com/sandfox/torrent-file/-/issues

Feel free to ask any questions in our room on Gitter: https://gitter.im/arokettu/community

Supported versions:

  • 5.x (current, PHP 8.1+)

License

The library is available as open source under the terms of the MIT License.