diff --git a/Misc/Media/Demo/Dark/Bookmarks.png b/Misc/Media/Demo/Dark/Bookmarks.png new file mode 100644 index 0000000..511d323 Binary files /dev/null and b/Misc/Media/Demo/Dark/Bookmarks.png differ diff --git a/Misc/Media/Demo/Dark/Cloud.png b/Misc/Media/Demo/Dark/Cloud.png new file mode 100644 index 0000000..be257f2 Binary files /dev/null and b/Misc/Media/Demo/Dark/Cloud.png differ diff --git a/Misc/Media/Demo/Dark/History.png b/Misc/Media/Demo/Dark/History.png new file mode 100644 index 0000000..7366970 Binary files /dev/null and b/Misc/Media/Demo/Dark/History.png differ diff --git a/Misc/Media/Demo/Dark/Plugins.png b/Misc/Media/Demo/Dark/Plugins.png new file mode 100644 index 0000000..1e3ef9f Binary files /dev/null and b/Misc/Media/Demo/Dark/Plugins.png differ diff --git a/Misc/Media/Demo/Dark/Search.png b/Misc/Media/Demo/Dark/Search.png new file mode 100644 index 0000000..3a25c14 Binary files /dev/null and b/Misc/Media/Demo/Dark/Search.png differ diff --git a/Misc/Media/Demo/Light/Bookmarks.png b/Misc/Media/Demo/Light/Bookmarks.png new file mode 100644 index 0000000..2d35db5 Binary files /dev/null and b/Misc/Media/Demo/Light/Bookmarks.png differ diff --git a/Misc/Media/Demo/Light/Cloud.png b/Misc/Media/Demo/Light/Cloud.png new file mode 100644 index 0000000..ab078aa Binary files /dev/null and b/Misc/Media/Demo/Light/Cloud.png differ diff --git a/Misc/Media/Demo/Light/History.png b/Misc/Media/Demo/Light/History.png new file mode 100644 index 0000000..e77177c Binary files /dev/null and b/Misc/Media/Demo/Light/History.png differ diff --git a/Misc/Media/Demo/Light/Plugins.png b/Misc/Media/Demo/Light/Plugins.png new file mode 100644 index 0000000..b660d4a Binary files /dev/null and b/Misc/Media/Demo/Light/Plugins.png differ diff --git a/Misc/Media/Demo/Light/Search.png b/Misc/Media/Demo/Light/Search.png new file mode 100644 index 0000000..208b13b Binary files /dev/null and b/Misc/Media/Demo/Light/Search.png differ diff --git a/README.md b/README.md index ca4bb28..aa91b90 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ # Ferrite +

+ + Donate on Ko-Fi + + Swift 5.2 + Platform: iOS | iPadOS + + License: GPL v3 + +

+ +

+ + Nightly Build Status + + + Discord Server + +

+ A media search engine for iOS with a plugin API to extend its functionality. ## Disclaimer @@ -16,31 +36,62 @@ However, the main problem is that these websites tend to suck in terms of UI or 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. +## Features + +- [x] Ad-free +- [x] Clean UI with native performance +- [x] Powerful search with an intuitive filter system +- [x] Modular plugin system +- [x] Integrates with many debrid providers +- [x] Flexible parser system written in native Swift +- [x] Local library with bookmarks and history +- [x] Manage your debrid cloud +- [x] Does not pollute your debrid cloud +- [x] Kodi integration + +If there's a feature that's not listed here, open an issue or ask in the support Discord. + ## What iOS versions are supported? +To decide what minimum version of iOS is supported, Ferrite follows an "n - 2" patten. For example, if iOS 18 is the latest version, the minimum supported iOS version is 16 (18-2 = 16). + +To make this easier, the minimum required iOS version and Ferrite versions are listed below: + +- v0.8 and up: iOS 16 and up + - v0.7 and up: iOS 15 and up - v0.6.x and lower: iOS 14 and up -## Planned features +## Supported debrid services -More of these can be found in [issues](https://github.com/bdashore3/Ferrite/issues), but here is a small snippet: +Ferrite primarily uses Debrid services for instant streaming. A list of supported services are provided below: -- More involved search filtering +- RealDebrid +- AllDebrid +- Premiumize +- TorBox +- OffCloud -- Companion apps for playback on other devices +Want another debrid service? Make a request in issues or the support Discord. ## 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. +At this time, Ferrite will only exist as an ipa. There are no 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](https://github.com/bdashore3/Ferrite/wiki). Various communities have created sources for Ferrite and they can be imported in the app with ease. +Plugins are not provided by the application. They must be found from external means or you can make them yourself using the [wiki](https://github.com/bdashore3/Ferrite/wiki). Various communities have created sources for Ferrite and they can be imported in the app with ease. + +There are two types of plugins: +- Source: A plugin that looks something up in an indexer +- Action: A plugin that "does" something, such as opening a result in a separate application + +To start off, a plugin list is located here (you can copy and paste this in the app) -> [https://raw.githubusercontent.com/Ferrite-iOS/example-sources/default/public-domain-plugins.yml](https://raw.githubusercontent.com/Ferrite-iOS/example-sources/default/public-domain-plugins.yml) ## Building from source -Xcode 14 must be used. +Use the latest stable version of Xcode. There are currently two branches in the repository: @@ -67,7 +118,7 @@ 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](https://discord.gg/sYQxnuD7Fj) for more info +- Please join [the discord](https://discord.gg/sYQxnuD7Fj) for more info and support ## Developers and Permissions @@ -80,3 +131,25 @@ Developer Website: [kingbri.dev](https://kingbri.dev) Developer Discord: kingbri#6666 Join the support discord here: [Ferrite Discord](https://discord.gg/sYQxnuD7Fj) + +## Screenshots + +### Dark Mode + +| Search | Bookmarks | History | +| ------------- | -------- | -------- | +| ![1](Misc/Media/Demo/Dark/Search.png) | ![2](Misc/Media/Demo/Dark/Bookmarks.png) | ![3](Misc/Media/Demo/Dark/History.png) | + +| Debrid Cloud | Plugins | +| ----------- | -------------------- | +| ![4](Misc/Media/Demo/Dark/Cloud.png) | ![5](Misc/Media/Demo/Dark/Plugins.png) | + +### Light Mode + +| Search | Bookmarks | History | +| ------------- | -------- | -------- | +| ![1](Misc/Media/Demo/Light/Search.png) | ![2](Misc/Media/Demo/Light/Bookmarks.png) | ![3](Misc/Media/Demo/Light/History.png) | + +| Debrid Cloud | Plugins | +| ----------- | -------------------- | +| ![4](Misc/Media/Demo/Light/Cloud.png) | ![5](Misc/Media/Demo/Light/Plugins.png) |