Creepso/Ferrite-backup
1
0
Fork 0
Code Issues 5 Pull requests Projects Releases 15 Packages Wiki Activity Actions
A media search engine for iOS with debrid support
191 commits 6 branches 15 tags 3 MiB
Swift 100%
Find a file
kingbri 46e0687bd7 Scraping: Add new source methods 
Some sources can be unique and require some extra parsing. Add the
ability to extract a magnet link instead of assuming that every
source provides a properly formatted one.

Signed-off-by: kingbri <bdashore3@proton.me>
2023-06-06 20:09:43 -04:00
.circleci Add CircleCI configuration 2022-08-04 21:33:59 -04:00
.github/workflows Actions: Add release action 2023-02-27 15:32:57 -05:00
Ferrite Scraping: Add new source methods 2023-06-06 20:09:43 -04:00
Ferrite.xcodeproj Debrid: Various updates to API and settings 2023-05-01 18:07:15 -04:00
.gitignore Ferrite: Add code up to alpha 1 2022-07-21 00:01:41 -04:00
.swift-version Ferrite: Format 2023-04-09 00:12:43 -04:00
.swiftformat Ferrite: Remove keychain shared class 2022-08-04 21:33:59 -04:00
LICENSE Add LICENSE 2022-08-31 00:41:38 -04:00
README.md Update README 2023-03-28 12:05:05 -04:00

README.md

Ferrite

A media search engine for iOS with a plugin API to extend its functionality.

Disclaimer

This project is developed with a hobbyist/educational purpose and I am not responsible for what happens when you install Ferrite.

Ferrite does not and will never host any content. It is a search engine and will be nothing more.

Why did I make this?

Finding shows and movies is usually pretty easy because there are many websites out there with the ability to search for the files you want.

However, the main problem is that these websites tend to suck in terms of UI or finding media to watch. Ferrite aims to provide a better UI to search and find the media you want.

I also wanted to support the use of debrid services since there aren't any (free) options on iOS that have support for this service.

What iOS versions are supported?

  • v0.7 and up: iOS 15 and up

  • v0.6.x and lower: iOS 14 and up

Planned features

More of these can be found in issues, but here is a small snippet:

  • More involved search filtering

  • Companion apps for playback on other devices

Downloads

Ferrite will only exist as an ipa. There will never be any plans to release on TestFlight or the App Store. Ipa builds are automatically built and are provided in Github actions artifacts.

Plugins/Sources

Sources are not provided by the application. They must be found from external means or you can make them yourself using the wiki. Various communities have created sources for Ferrite and they can be imported in the app with ease.

Building from source

Xcode 14 must be used.

There are currently two branches in the repository:

  • default: A snapshot of the latest stable build. Tags can also be used for older versions.
  • next: The development branch. Nightlies are automatically built here.

Nightly builds

Nightlies are builds automatically compiled by GitHub actions. These are development builds which may or may not be stable!

It is required to log into GitHub or ask for a nightly link to grab a build.

To install a nightly build:

  1. Download the artifact from GitHub actions

  2. Unzip the file containing the ipa

  3. Install the ipa on your device

Contribution

If you have issues with the app:

  • Describe the issue in detail
  • If you have a feature request, please indicate it as so. Planned features are in a different section of the README, so be sure to read those before submitting.
  • Please join the discord for more info

Developers and Permissions

I try to make comments/commits as detailed as possible, but if you don't understand something, please contact me via Discord.

Creator/Developer: kingbri

Developer Website: kingbri.dev

Developer Discord: kingbri#6666

Join the support discord here: Ferrite Discord