-
-
Notifications
You must be signed in to change notification settings - Fork 161
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
13bed67
commit 7b71cd9
Showing
5 changed files
with
176 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| export default class AbstractSource { | ||
| name = 'Missing name' | ||
| description = 'No description provided' | ||
| /** @type {import('./type-definitions').Accuracy} */ | ||
| accuracy = 'Low' | ||
| /** @type {import('./type-definitions').Config} */ | ||
| config = {} | ||
|
|
||
| /** | ||
| * Gets results for single episode | ||
| * @type {import('./type-definitions').SearchFunction} | ||
| */ | ||
| single (options) { | ||
| throw new Error('Source doesn\'t implement single') | ||
| } | ||
|
|
||
| /** | ||
| * Gets results for batch of episodes | ||
| * @type {import('./type-definitions').SearchFunction} | ||
| */ | ||
| batch (options) { | ||
| throw new Error('Source doesn\'t implement batch') | ||
| } | ||
|
|
||
| /** | ||
| * Gets results for a movie | ||
| * @type {import('./type-definitions').SearchFunction} | ||
| */ | ||
| movie (options) { | ||
| throw new Error('Source doesn\'t implement movie') | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| export interface Result { | ||
| title: string // torrent title | ||
| link: string // link to .torrent file, or magnet link | ||
| id?: number | ||
| seeders: number | ||
| leechers: number | ||
| downloads: number | ||
| hash: string // info hash | ||
| size: number // size in bytes | ||
| verified: boolean // if it's a verified release, e.g. it's 100% certain it's the correct episode, manually verified by the provider e.g. anidb | ||
| date: Date // date the torrent was uploaded | ||
| type?: 'batch' | 'best' | 'alt' | ||
| } | ||
|
|
||
| export interface Options { | ||
| anilistId: number // anilist anime id | ||
| anidbAid?: number // anidb anime id | ||
| anidbEid?: number // anidb episode id | ||
| titles: string[] // list of titles and alternative titles | ||
| episode?: number | ||
| episodeCount?: number // total episode count for the series | ||
| resolution: '2160' | '1080' | '720' | '540' | '480' | '' | ||
| exclusions: string[] // list of keywords to exclude from searches | ||
| } | ||
|
|
||
| export type SearchFunction = (options: Options) => Promise<Result[]> | ||
|
|
||
| export type Config = { | ||
| seed?: 'perma' | number // seed ratio to hit | ||
| } | ||
|
|
||
| export type Accuracy = 'High' | 'Medium' | 'Low' | ||
|
|
||
| export class Source { | ||
| name: string | ||
| description: string | ||
| accuracy: Accuracy | ||
| config: Config | ||
| single: SearchFunction | ||
| batch: SearchFunction | ||
| movie: SearchFunction | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| <div class='container font-size-18 pb-20'> | ||
| <div class='content'> | ||
| <div class='h-vh-half px-20 px-sm-0 d-flex justify-content-center flex-column'> | ||
| <h1 class='font-weight-bold text-white title'>About Extensions</h1> | ||
| <div class='font-size-18 text-muted'>Frequently Asked Questions about Extensions.</div> | ||
| </div> | ||
| <hr class='my-20' /> | ||
| <h3 class='text-white font-weight-bold'>What are some recommended extensions and sources?</h3> | ||
| <p>Miru is bring-your-own-content and does not offer anything, however <kbd>anisearch</kbd> is recommended.</p> | ||
| <hr class='my-20' /> | ||
| <h3 class='text-white font-weight-bold'>Is there a curated list of extensions and sources?</h3> | ||
| <p>No. Miru is not directly associated with any extensions or sources. It's merely a client for streaming one's own media.</p> | ||
| <hr class='my-20' /> | ||
| <h3 class='text-white font-weight-bold'>How to install/uninstall extensions?</h3> | ||
| <p>Inside <kbd>Settings > Torrent > Extensions</kbd> you can add extensions by either inputting a full URL such as <kbd>https://example.website/file.js</kbd> or if an extension is published on npm <kbd>packagename</kbd> and pressing add. This will automatically import all sources the extension provides. You can then uninstall an extension by pressing the remove button next to it.</p> | ||
| <hr class='my-20' /> | ||
| <h3 class='text-white font-weight-bold'>Can you disable sources?</h3> | ||
| <p>You can disable sources in the sources list by clicking on it's toggle.</p> | ||
| <hr class='my-20' /> | ||
| <h3 class='text-white font-weight-bold'>How to develop new extensions?</h3> | ||
| <p>Extensions for Miru need to be written in JavaScriptn which are run in an isolated <a href='https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API' target='_blank'>Web Worker</a>. Make sure the data you're fetching is CORS enabled. Extension type definitions and example structures are available on <a href='https://github.com/ThaUnknown/miru/tree/master/extensions' target='_blank'>GitHub</a>.</p> | ||
| <p>Options object, which is passed to the class's single, batch and movie functions as the first parameters has the following fields:</p> | ||
| <ul> | ||
| <li>anilistId: number - Anilist anime id, can be used to query data from Anilist, such as MalID, episode metadata etc</li> | ||
| <li>anidbAid?: number - AniDB anime id, not always present, useful to query mapping API's</li> | ||
| <li>anidbEid?: number - AniDB episode id, not always present, useful to query specific data, as AnidbEIDs map to manually maintained files</li> | ||
| <li>titles: string[] - list of titles and alternative titles for the given anime</li> | ||
| <li>episode?: number - episode to look for, not always present</li> | ||
| <li>episodeCount?: number - total episode count for the series, not always present</li> | ||
| <li>resolution: '2160' | '1080' | '720' | '540' | '480' | '' - resolution height. empty string means any</li> | ||
| <li>exclusions: string[] - list of keywords to exclude from searches such as codecs unsuppored by the platform, etc</li> | ||
| </ul> | ||
| <p>Results object, array of which is returned by the functions of the class has the following fields:</p> | ||
| <ul> | ||
| <li>title: string - torrent title, this isn't always the file title as a torrent might include multiple files</li> | ||
| <li>link: string - http:// link to .torrent file, or magnet:// link</li> | ||
| <li>id?: number - unused for now</li> | ||
| <li>seeders: number</li> | ||
| <li>leechers: number</li> | ||
| <li>downloads: number</li> | ||
| <li>hash: string - info hash REQUIRED</li> | ||
| <li>size: number - size in bytes</li> | ||
| <li>verified: boolean - if it's a verified release, e.g. it's 100% certain it's the correct episode, manually verified by the provider e.g. anidb</li> | ||
| <li>date: Date - date the torrent was uploaded</li> | ||
| <li>type?: 'batch' | 'best' | 'alt' - type of the result best/alt means it's the best known release</li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
|
|
||
| <style> | ||
| a { | ||
| --dm-link-text-color: #1890ff !important; | ||
| --dm-link-text-color-hover: #45a3fb !important; | ||
| } | ||
| h3 { | ||
| margin-top: 0; | ||
| padding-top: 0.75em; | ||
| } | ||
| p { | ||
| margin-bottom: 0; | ||
| padding-bottom: 1em; | ||
| } | ||
| .title { | ||
| font-size: 5rem | ||
| } | ||
| </style> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters