Torrenium

Torrent Resource tools

Table of Contents

1. About The Project
   • Built With
   • Features
2. Getting Started
   • Platforms
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

Torrenium is an app that fetch resources from different rss providers.

Built With

(back to top)

Features

• Get latest content or search from different rss providers and YouTube
• Results grouped and sorted by title
• Direct playback for YouTube / Torrent content (WebTorrent Server required)
• Download torrent/magnet from rss providers
• Subscribe to keywords, authors and categories and automatically download new content (updated hourly or manually)
• Watch history and resume last watched position
• Automatically pause download on cellular network, and resume on WiFi/ethernet

(back to top)

Getting Started

This is an example of how you may give instructions on how to build it manually. To get a local copy up and running follow these simple example steps.

Platforms

• iOS 11.0+
• Android 6.0+
• Windows
• Linux (WIP)
• MacOS (WIP)

Prerequisites

• Clone the repo git clone https://github.com/yusing/torrenium --recursive
• Install Flutter if not already
• Install Go if not already
• (Android build only) Install Android Studio if not
• (iOS and MacOS build only) Install XCode if not already
• (Windows build only) Install Visual Studio if not already
• change directory to go_torrent and run the build script for your platform
  • cd go_torrent
  • ./build_ios.sh for iOS
  • build_windows.bat for Windows
  • build_android.bat for Android (Build on Windows)
• Build the app
  • flutter build [windows|apk|ios|macos|linux] --release for Windows

Installation

Download the release from here

Usage

Simply install the app and start using it.

(back to top)

Roadmap

• Things listed in Features
• Windows and Android build
• iOS build
• Watch History On Windows
• YouTube Video Download
• Play next episode when video ends (if available)
• Linux and MacOS build
• Limit concurrent downloads
• Custom RSS Provider Support
• Manual add torrent/magnet to torrent client by link
• Ability to decompress downloaded files (i.e. .zip,.rar, *.7z, etc.)
• Manga reader (for contents that extracts into images, or epub, etc.)
• Music player (for contents that extracts into audio files)
• Background services
  • Subscription / Download
  • Picture in Picture (PiP) support
  • Download status in Notification
  • Media controls in notification

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

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". Don't forget to give the project a star! Thanks again!

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 Apache License Version 2.0. See LICENSE.txt for more information.

(back to top)