diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..e8ed9db --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: ThaUnknown diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..4b26773 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,65 @@ +name: Bug report +description: Report a bug. +title: '[Bug]: ' +labels: + - bug +body: + - type: checkboxes + id: '1' + attributes: + label: Preflight checklist + description: Make sure you completed this before creating an issue. + options: + - label: >- + I have searched the [issue + tracker](https://github.com/ThaUnknown/miru/issues) for a bug report + that matches the one I want to file, without success. + required: true + - label: >- + I have searched the [frequently asked + questions](https://miru.watch/faq) for a solution to my problem, + for a solution that fixes this problem, without success. + required: true + - label: >- + I have checked that I'm using the [latest + stable](https://github.com/ThaUnknown/miru/releases/latest) version + of the app. + required: true + - type: input + id: '2' + attributes: + label: What app version are you using? + description: >- + The app version you are currently using, you can view this at the bottom + of the settings menu. + placeholder: v2.0.1 + validations: + required: true + - type: dropdown + id: '3' + attributes: + label: What operating system version are you using? + options: + - Windows + - Linux + - MacOS + - Android + validations: + required: true + - type: textarea + id: '4' + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + - type: textarea + id: '5' + attributes: + label: Actual Behavior + description: A clear description of what actually happens. + validations: + required: true + - type: textarea + id: '6' + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..8637bc4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,43 @@ +name: Feature Request +description: Suggest an idea for the app. +title: '[Feature Request]: ' +labels: + - enhancement +body: + - type: checkboxes + id: '1' + attributes: + label: Preflight checklist + description: Make sure you completed this before creating an issue. + options: + - label: >- + I have searched the [issue + tracker](https://github.com/ThaUnknown/miru/issues) for a bug report + that matches the one I want to file, without success. + required: true + - label: >- + I have searched the [features + list](https://github.com/ThaUnknown/miru#features) for this feature, + and I couldn't find it. + required: true + - label: >- + I have checked that I'm using the [latest + stable](https://github.com/ThaUnknown/miru/releases/latest) version + of the app. + required: true + - type: textarea + id: '4' + attributes: + label: Problem Description + description: >- + Please add a clear and concise description of the problem you are + seeking to solve with this feature request. + validations: + required: true + - type: textarea + id: '5' + attributes: + label: Proposed Solution + description: Describe the solution you'd like in a clear and concise manner. + validations: + required: true diff --git a/README.md b/README.md new file mode 100644 index 0000000..df1b521 --- /dev/null +++ b/README.md @@ -0,0 +1,135 @@ +

+ + + +

+

Miru

+ +

Stream anime torrents, real-time with no waiting for downloads

+ +

+ About • + Features • + Frequently Asked Questions • + Building and Development • + Download +

+

+ showcase
+ + chat + + + GitHub all releases + +

+ +## **About** + +A pure JS BitTorrent streaming environment, with a built-in list manager. Imagine qBit + Taiga + MPV, all in a single package, but streamed real-time. Completly ad free with no tracking/data collection. + +This app is meant to feel look, work and perform like a streaming website/app, while providing all the advantages of torrenting, like file downloads, higher download speeds, better video quality and quicker releases. + +Unlike qBit's sequential, seeking into undownloaded data will prioritise downloading that data, instead of flat out closing MPV. + +## **Features** + +### **Anime:** + +* full AniList integration + * filter anime by name, genre, season, year, format, status + * view anime on your planning and watching list + * add and remove anime from your planning list + * automatically mark episodes as complete as you watch them + * view trailers/previews for anime + * score anime + * view anime relations +* automatically find torrents for desired episodes +* automatically detect what anime a torrent is +* view latest releases on any custom RSS +* airing schedule +* find anime by image \[just paste an image into the app] + +### **Video:** + +* full subtitle support + * support for softcoded subtitles + * support for external subtitle files + * support for VTT, SSA, ASS, SUB, TXT subtitles + * subtitle display in PiP +* keybinds for all functions: + * **S** - seek forwards 90 seconds \[skip opening] + * **R** - seek backwards 90 seconds + * **→** - seek forwards 2 seconds + * **←** - seek backwards 2 seconds + * **↑** - increase volume + * **↓** - decrease volume + * **M** - mute volume + * **C** - cycle through subtitle tracks + * **N** - play next episode \[if available] + * **B** - play last episode \[if available] + * **F** - toggle fullscreen + * **P** - toggle picture in picture + * **\[** - increase playback speed + * **]** - decrease playback speed + * **\\** - reset playback speed to 1 + * **I** - view video stats for nerds + * **\`** - open keybinds UI +* editable keybinds **\`** allows drag dropping any key +* miniplayer +* media session display +* media keys support +* Discord rich pressence +* preview thumbnails +* pause on lost focus +* autoplay next episode +* multi-audio support +* torrent download progress on the seek bar + +### **Torrent:** + +* select downloads folder +* specify download/upload speeds +* support for most popular BEP's +* support for custom torrent RSS feeds for latest releases +* change what resolution to find torrents in +* stream real-time with no waiting for downloads +* support for custom extensions for custom sources and trackers + +## **Linux Installation** + +### Arch + +If you use paru: + +```bash +paru -S miru-bin +``` + +If you use yay: + +```bash +yay -S miru-bin +``` + +### Debian/Ubuntu + +* Download the `linux-Miru-version.deb` from the [releases](https://github.com/ThaUnknown/miru/releases/latest) page. +* Install the deb file with package manager. + +```bash +apt install linux-Miru-*.deb +``` + +## **Building and Development** + +*good luck* + +Dependencies: + +* Node 16 or above +* PNPM +* Docker +* Android Debug Bridge +* Java 18 or above \[probably?] +* maybe others... have fun. diff --git a/package.json b/package.json index 6d266fe..2c84a76 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ui", - "version": "6.3.19", + "version": "6.3.20", "license": "BUSL-1.1", "private": true, "packageManager": "pnpm@9.14.4",