Zig Torrent Client

An multi-file torrent client using an event and coroutine system
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

The main goal of this project is to remove a lot of small projects I've made like an RSS file downloaded and an media sorter. This client's goal is to remove those while holding to some other standards.

• All torrent files should work
• Allow moving of media without breaking the connection
• Automate pulling of new content based on plugins
• Http client so client is headless by default but works on any device

Use the GETTING_STARTED.md to get started.

(back to top)

Getting Started

All that should be needed is a

zig build -Doptimize=ReleaseFast run

If that doesn't work

Prerequisites

• Currently only supports linux
• zig version

   $ zig version
   0.12.0-dev.2058+04ac028a2

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/ookami125/Zig-Torrent.git

2. Build with zig

   zig build -Doptimize=ReleaseFast

(back to top)

Roadmap

• Add Changelog
• Support DHT and other ways of getting torrent info
• Support multiple ways of changing a torrent (move files, delete, sparce download)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Any contributions you make are greatly appreciated, but under my full discretion as how and when the change gets in.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU GPLv3 License. See LICENSE.txt for more information.

(back to top)

Contact

Tyler Peterson - [email protected]

Project Link: https://github.com/ookami125/Zig-Torrent

(back to top)