Arlo/Rusty-Torrent
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
9 Commits 2 Branches 0 Tags 18 MiB
Rust 100%
393234b41b
Go to file
ArloFilley 393234b41b update cargo.toml keys
2023-08-27 14:23:53 +01:00
.vscode Initial commit 2023-08-27 13:21:53 +01:00
src Initial commit 2023-08-27 13:21:53 +01:00
.gitignore Update Cargo.toml for publishing on crates.io 2023-08-27 13:45:06 +01:00
Cargo.toml update cargo.toml keys 2023-08-27 14:23:53 +01:00
LICENSE fixed typo 2023-08-27 13:30:22 +01:00
readme.md Initial commit 2023-08-27 13:21:53 +01:00

readme.md

Rusty_Torrent BitTorrent Client

GitHub GitHub last commit GitHub stars

A BitTorrent client implemented in Rust that allows you to interact with the BitTorrent protocol and download torrents.

Table of Contents

Introduction

This BitTorrent client is designed to provide a simple and functional implementation of the BitTorrent protocol. It supports downloading torrents and interacting with peers to exchange pieces of files.

Features

  • Handshake and communication with peers using the BitTorrent protocol.
  • Support for downloading torrents in both single-file and multi-file mode.
  • Ability to request and download individual pieces from peers.
  • Piece verification using SHA-1 hashes to ensure data integrity.
  • Logging using the log crate for better debugging and tracing.

Getting Started

Prerequisites

  • Rust programming language: Install Rust
  • Cargo: The Rust package manager, usually installed with Rust.

Installation

  1. Clone the repository:
git clone https://github.com/ArloFilley/rusty_torrent.git
  1. Navigate to the project directory:
cd rusty_torrent
  1. Build the project
cargo build --release

Usage

To use the BitTorrent client, follow these steps:

  1. Run the compiled binary:
cargo run --release
  1. Provide the path to a .torrent file:
cargo run --release /path/to/your.torrent
  1. Provide the path to download
cargo run --release /path/to/your.torrent /path/to/downloads

The client will start downloading the torrent files and interacting with peers.

How It Works

This BitTorrent client uses Rust's asynchronous programming features to manage connections with peers and perform file downloads. It employs the BitTorrent protocol's handshake and communication mechanisms to exchange pieces of data with other peers in the network. The client also verifies downloaded pieces using SHA-1 hashes provided by the torrent file.

Contributing

Contributions are welcome! If you find any bugs or want to add new features, please feel free to open issues and pull requests on the GitHub repository.

License

This project is licensed under the MIT License.