-brightgreen.svg){kind=icon}
Nimbus is a desktop application built with Flutter, designed for Windows (MacOS planned). It helps users easily cache movies and TV shows to your Premiumize cloud storage that aren't already cached. The app provides a streamlined interface for searching, selecting, and caching media content.
-
🎬 Media Search & Caching
- OMDB integration for movie and TV show information
- Torrentio and Orionoid integration for finding content
- Direct caching to Premiumize cloud storage
-
☁️ Premiumize Integration
- Account information display
- Transfer management and monitoring
- Detailed instructions for setup
- Cache status checking
-
🔍 Indexer Support
- Orionoid
- Torrentio
- Prawlarr * Note Prowlarr is not yet implemented but it planned
-
🎨 User Interface
- Dark mode theming
- Responsive design for desktop platforms
- Dynamic sizing
- Easy sidebar navigation
- State Management: Riverpod
- Navigation: Go Router
- Storage: Shared Preferences
- HTTP Client: Dio
- UI: ScreenUtil, Google Fonts, Flutter Animate
- Platform Specific: Windows Notifications, Windows Registry
-
Prerequisites
- Flutter SDK (^3.6.0)
- Dart SDK
- Windows development environment
-
Compilation
git clone [repository-url] cd nimbus flutter pub run build_runner build --delete-conflicting-outputs flutter build windows -
testing before compilation
flutter clean flutter pub run build_runner build --delete-conflicting-outputs flutter run -d windows
- Download the precompiled exe or compile it yourself and run it. Note: this app has no installation it comes only as portable exe.
- Set required api keys and any optionals you might need:
- OMDB API key required if you want to search movies/shows
- Premiumize API key required
- Orionoid API key required if you plan to use it
- Either search for your desired movie/show or use a site to find what your needing cached. Note: if you integrate with windows allowing for association of torrent/magnet you must keep the exe in the same directory or else you need to re integrate. integration works by adding a registery entry telling windows Nimbus is the default program for magnet links and torrent files. if the exe is moved the windows registry needs updating to reflect that thus need to reclick the button.
- Use Riverpod for state management
- Go Router for navigation
- Ensure resizxable UI with ScreenUtil
- Adhere to dark mode theming
- Fork the repository
- Create your feature branch
- Commit your changes
- Push to the branch
- Create a Pull Request
- Flutter Team for the amazing framework
- Orionoid for their comprehensive media API
- Torrentio for their comprehensive media API
- Premiumize.me for their cloud service integration
- Riverpod maintainers for state management solutions
- Material Design team for UI components
MIT License
Copyright (c) 2024 Nimbus
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.