mirror of
https://github.com/cranci1/Sora.git
synced 2026-04-19 23:52:09 +00:00
101 lines
4.3 KiB
Markdown
101 lines
4.3 KiB
Markdown
# Sora
|
|
> Also known as Sulfur due to copyright considerations.
|
|
|
|
<div align="center">
|
|
|
|
<img src="https://raw.githubusercontent.com/cranci1/Sora/refs/heads/main/assets/Sulfur.png" width="750px">
|
|
|
|
[](https://github.com/cranci1/Sora/actions/workflows/build.yml) [](https://discord.gg/XR3SrmUbpd) [](https://img.shields.io/badge/Platform-iOS%20%7C%20iPadOS%2015.0%2B%20%26%20macOS%2012.0%2B-red?logo=apple&logoColor=white)
|
|
|
|
**A modular media player for iOS and macOS, under the GPLv3.0 License.**
|
|
|
|
</div>
|
|
|
|
## Table of Contents
|
|
|
|
- [Features](#features)
|
|
- [Installation](#installation)
|
|
- [Frequently Asked Questions](#frequently-asked-questions)
|
|
- [Acknowledgements](#acknowledgements)
|
|
- [License](#license)
|
|
- [Legal](#legal)
|
|
|
|
## Features
|
|
|
|
- [x] macOS 12.0+ support
|
|
- [x] iOS/iPadOS 15.0+ support
|
|
- [x] JavaScript-based module loader
|
|
- [x] HLS and MP4 format support with optional offline watching (via user-installed modules)
|
|
- [x] Tracking services (AniList, Trakt)
|
|
- [x] Apple Keychain support for auth tokens
|
|
- [x] Support for personal media servers (e.g., Jellyfin, Plex)
|
|
- [x] External metadata providers (TMDB, AniList)
|
|
- [x] Background playback and Picture-in-Picture (PiP) support
|
|
- [x] External media player support (VLC, Infuse, Outplayer, nPlayer, SenPlayer, IINA, TracyPlayer)
|
|
|
|
## Installation
|
|
|
|
You can download Sora using Xcode or using the .ipa file, which you can find in the [Releases](https://github.com/cranci1/Sora/releases) tab or the [Nightly](https://nightly.link/cranci1/Sora/workflows/build/dev/Sulfur-IPA.zip) build page.
|
|
|
|
## Frequently Asked Questions
|
|
|
|
1. **What is Sora?**
|
|
Sora is a modular media player for iOS and macOS, enabling custom modules to play media from user-provided sources.
|
|
|
|
2. **Is Sora safe?**
|
|
Yes, Sora is open-source and prioritizes user privacy. It does not store user data on external servers and does not collect crash logs.
|
|
|
|
3. **Will Sora ever be paid?**
|
|
No, Sora will always remain free without subscriptions, paid content, or any type of login.
|
|
|
|
4. **How can I get modules?**
|
|
Sora does not include any modules by default. You will need to find and add the necessary modules yourself, or create your own.
|
|
|
|
## Acknowledgements
|
|
|
|
Frameworks:
|
|
- [Drops](https://github.com/omaralbeik/Drops) - MIT License
|
|
- [NukeUI](https://github.com/kean/NukeUI) - MIT License
|
|
- [SoraCore](https://github.com/cranci1/SoraCore) - Custom License
|
|
- [MarqueeLabel](https://github.com/cbpowell/MarqueeLabel) - MIT License
|
|
|
|
Misc:
|
|
- [50/50](https://github.com/50n50) for the app icon
|
|
- [Ciro](https://github.com/CiroHoodLove) for the episodes banners
|
|
|
|
## License
|
|
|
|
This project is licensed under the [GNU General Public License v3.0](LICENSE) (GPLv3.0).
|
|
|
|
```
|
|
Copyright © 2024-2025 cranci. All rights reserved.
|
|
|
|
Sora is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
Sora is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with Sora. If not, see <https://www.gnu.org/licenses/>.
|
|
```
|
|
|
|
## Legal
|
|
|
|
**Sora is a media player that does not host or provide any content. Users are responsible for providing their own content.**
|
|
|
|
### User Responsibility
|
|
- Users must ensure they have legal rights to any content they use
|
|
- Users are responsible for complying with all applicable laws
|
|
- Users must respect copyright and intellectual property rights
|
|
|
|
### No Liability
|
|
The developers assume no responsibility for user actions or content. This software is provided "as-is" without warranties. Users bear full responsibility for their use of the software and any modules.
|
|
|
|
### Modules
|
|
Sora does not include any modules. Third-party modules are the responsibility of their creators, not the Sora developers.
|
|
|