chore: docs

This commit is contained in:
ThaUnknown 2024-03-20 19:10:49 +01:00
parent 777794d488
commit 88d05a75a9
5 changed files with 20 additions and 76 deletions

View file

@ -1,27 +1,28 @@
<h1 align="center">
<p align="center">
<a href="https://github.com/ThaUnknown/miru">
<img src="./docs/logo.png" width="200">
<img src="./web/static/logo_filled.svg" width="200">
</a>
</h1>
</p>
<h1 align="center"><b>Miru</b></h1>
<h4 align="center"><b>Stream anime torrents, real-time with no waiting for downloads</b></h4>
<p align="center">
<a href="#about">About</a>
<a href="#features">Features</a>
<a href="./docs/faq.md">Frequently Asked Questions</a>
<a href="https://miru.watch/#about">About</a>
<a href="https://miru.watch/features/">Features</a>
<a href="https://miru.watch/faq/">Frequently Asked Questions</a>
<a href="#building-and-development">Building and Development</a>
<a href="https://github.com/ThaUnknown/miru/releases/latest">Download</a>
<a href="https://miru.watch/download/">Download</a>
</p>
<p align="center">
<img src="./docs/show.gif" alt="chat"><br>
<video src="./docs/showcase.mp4" autoplay muted controls></video>
<br><br>
<a href="https://discord.gg/Z87Nh7c4Ac">
<img src="https://img.shields.io/discord/953341991134064651?style=flat-square" alt="chat">
</a>
<a href="https://github.com/ThaUnknown/miru/releases/latest">
<a href="https://miru.watch/download/">
<img alt="GitHub all releases" src="https://img.shields.io/github/downloads/ThaUnknown/miru/total?style=flat-square">
</a>
</p>
## **About**
@ -52,8 +53,6 @@ Unlike qBit's sequential, seeking into undownloaded data will prioritise downloa
- support for VTT, SSA, ASS, SUB, TXT subtitles
- subtitle display in PiP
- keybinds for all functions:
- **,** - seek 1 frame backwards
- **.** - seek 1 frame forwards
- **S** - seek forwards 90 seconds [skip opening]
- **R** - seek backwards 90 seconds
- **→** - seek forwards 2 seconds
@ -63,6 +62,7 @@ Unlike qBit's sequential, seeking into undownloaded data will prioritise downloa
- **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
@ -87,6 +87,7 @@ Unlike qBit's sequential, seeking into undownloaded data will prioritise downloa
- 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**
@ -113,21 +114,12 @@ apt install linux-Miru-*.deb
## **Building and Development**
*dont*
Dependencies:
- Node 16 or above
- PNPM
To build/develop, in the root folder of the repo you need to first run:
```bash
pnpm install
```
To build for your OS just run:
```bash
pnpm run build
```
To run the development server run:
```bash
pnpm start
```
- Docker
- Android Debug Bridge
- Java 18 or above [probably?]
- maybe others... have fun.

View file

@ -3,7 +3,7 @@
import { alToken, settings } from '@/modules/settings.js'
import { anilistClient, currentSeason, currentYear } from '@/modules/anilist.js'
const bannerData = anilistClient.search({ method: 'Search', sort: 'POPULARITY_DESC', perPage: 25, onList: false, season: currentSeason, year: currentYear })
const bannerData = anilistClient.search({ method: 'Search', sort: 'POPULARITY_DESC', perPage: 15, onList: false, season: currentSeason, year: currentYear })
const manager = new SectionsManager()

View file

@ -1,48 +0,0 @@
## **Won't this kill swarm health?**
Depends. On average no. The app is always seeding 1 torrent as long as it's open. Additionally the upload speed is forced to be x1.5 that of the download speed. Those 2 things combined will already make this app seed more than the average leecher which removes the torrent the moment it's downloaded.
## **Can I close the miniplayer?**
No. See above. The miniplayer provides feedback that something is happening in the background. Closing it would make the user feel like the app is lagging [because it's maxing out your internet in the background by torrenting] when nothing is happening.
## **Can I reduce the upload speed?**
No. See above. This app is also meant to seed the torrents the user downloads, if you want freeleech go to some private tracker.
## **Is this safe?**
I recommend you read the [guide about basics of piracy.](https://thewiki.moe/guides/torrenting)
## **Will this replace streaming sites?**
Not really. The underlying source of video are still torrents, which aren't always seeded, so anime that's a few years old might not play back smoothly.
## **Can I log in with MAL?**
No. You can however migrate MAL to AL, see [this guide.](https://anilist.co/forum/thread/3393)
## **Why is anime X not playing?**
One of four reasons:
- the anime isn't seeded
- your download speed isn't fast enough
- your ISP blocks Nyaa, see [this tutorial](https://thewiki.moe/en/tutorials/unblock) for a fix
- the app couldn't find a matching torrent for the anime
## **I selected an episode to play, but Miru plays something else!**
Finding desired episodes can sometimes be difficult, if Miru auto-selects an episode incorrectly you can either disable auto-play torrents in settings to select torrents yourself during episode choosing, or manually find and paste in a .torrent file URL or a magnet URL into Miru to play a desired episode manually.
## **Will you make an android version?**
No. This app cannot be ported to android in any way.
## **Can I play my own torrents?**
Yes. For the home menu you can specify a different RSS feed to check when the app looks for new releases. Additionally you can just paste a torrent file/magnet link anywhere when using the app, and it will auto-detect what anime is playing.
## **Can I change what tracker torrents are found from?**
Not really. No other tracker has the kind of API/search functionality which is required, which Miru uses to the fullest extent to make sure it finds the torrents it's looking for without false-positives.
## **How is this different from sequential qBit?**
Unlike qBit's sequential, this will prioritise downloading torrent pieces directly needed for playback, which with the user seeking isn't always just sequential.
## **Why Electron?**
Electron has node.js integration, which can use TCP/UDP, that is the only reason. Browsers can't access TCP/UDP which means they can't access the global BT swarm.
> Can't you make this just use WebRTC?
Yes. A BitTorrent implementation which uses WebRTC exists, but it's not yet adopted by any clients, and libtorrent [the library which qBit and others use] is still working/just added support for WebRTC, which means there's no swarm. This will hopefully change in the future.
## **Miru crashed too many times.**
This is likely because Miru updated from a very old version to a very new one. Uninstall Miru, go to `%appdata%/miru` remove all files and re-install it. If this issue persists visit the Discord for help.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7 MiB