-
Notifications
You must be signed in to change notification settings - Fork 0
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
Showing
1 changed file
with
30 additions
and
41 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,51 @@ | ||
| # MAL-Stremio Addon | ||
|
|
||
| This Stremio addon enables users to access their anime list from MyAnimeList (MAL) directly within the Stremio media | ||
| center. | ||
| With this addon, you can easily keep track of your watched anime, plan to watch, and more, all from the convenience of | ||
| Stremio. | ||
| This Stremio addon allows users to access their anime lists from MyAnimeList (MAL) directly within the Stremio media center. With this addon, you can easily keep track of your watched anime, plan to watch, and more, all from the convenience of Stremio. | ||
|
|
||
| <b><font color="#FFFF00"> | ||
| NB: Currently, this addon only handles catalogs and meta content. Syncing watched content with MyAnimeList will be added | ||
| in the near future. | ||
| </b></font> | ||
| ## Usage 🧑💻 | ||
|
|
||
| ## Installation | ||
| - **User's Anime Lists**: View your personal anime list from MyAnimeList, including the titles you have watched, plan to watch, and any other categories you have set up. | ||
| - **Content Tracking and Syncing from within Stremio**: | ||
| - Currently, only Kitsu catalogs are supported. | ||
| - When users watch content in their "plan to watch" list: | ||
| - Shows will be marked as watching and moved to the "watching" list, and the currently watched episode will be updated on MyAnimeList. | ||
| - Movies will be moved to the "completed" list. | ||
| - When users watch content in their "watching" list: | ||
| - Episodes watched will be updated for shows, and a show is marked and moved to the "completed" list when the last episode is watched. | ||
| - When users watch content in their "on hold" list: | ||
| - When a new episode is watched, the show is moved to the "watching" list. | ||
|
|
||
| To install the MyAnimeList Anime List addon, please follow these steps: | ||
|
|
||
| 1. Visit [The Addon Website](https://mal-stremio.vercel.app/) and generate an API Key for MyAnimeList using the " | ||
| Generate Token" button. This will redirect you to the MyAnimeList authentication page. | ||
| 2. Login to your MyAnimeList account and authorize the addon to access your anime list. | ||
| 3. After authorization, a manifest URL will be generated. Copy the manifest URL. | ||
| 4. Open the Stremio media center and go to the addon search box. | ||
| 5. Paste the copied manifest URL into the addon search box and press Enter. Alternatively, you can click the magnet URL | ||
| generated on the website to automatically add the addon to Stremio. | ||
| 6. The MyAnimeList Anime List addon will be added to your Stremio and ready for use. | ||
|
|
||
| <h4 style="color: #FFFF00"> | ||
| NB: If no content is being displayed, it could be the result of your session expiring. | ||
| to renew your session, return to the | ||
| <a href="https://mal-stremio.vercel.app/">Addon's website</a> to "Sign in with MyAnimelist" or | ||
| "Refresh MyAnimeList Session". | ||
| Afterwards, content should then show up in Stremio. | ||
| </h4> | ||
| **NOTE**: Due to Stremio not having a native way of handling content tracking, the only way to achieve this is by having Stremio request subtitles from the addon. Instead of returning subtitles, the addon will look at the content that is currently being played that the subtitles are being requested for and mark that content accordingly upon playback, not when the content has been watched all the way through. | ||
|
|
||
| ## Installation 🛠️ | ||
|
|
||
| ## Usage | ||
| To install the addon: | ||
|
|
||
| Once you have installed the MyAnimeList Anime List addon, you can access it within the Stremio media center. The addon | ||
| provides the following features: | ||
| 1. Visit [The Addon Website](https://mal-stremio.vercel.app/) and generate an API Key for MyAnimeList using the "Generate Token" button. This will redirect you to the MyAnimeList authentication page. | ||
| 2. Log in to your MyAnimeList account and authorize the addon to access your anime list. | ||
| 3. After authorization, a manifest URL will be generated. Copy the manifest URL. | ||
| 4. Open Stremio and go to the addon search box. | ||
| 5. Paste the copied manifest URL into the addon search box and press Enter. Alternatively, you can click "Open In Stremio" to automatically add the addon to Stremio. | ||
| 6. In Stremio, click install, and the addon will be added and ready for use. | ||
|
|
||
| - **Anime List**: View your personal anime list from MyAnimeList, including the titles you have watched, plan to watch, | ||
| and any other categories you have set up. | ||
| **NB**: If no content is being displayed, it could be the result of your session expiring. To renew your session, return to the [Addon's website](https://mal-stremio.vercel.app/) to "Sign in with MyAnimeList" or "Refresh MyAnimeList Session". Afterwards, content should then show up in Stremio. | ||
|
|
||
| ## Support | ||
|
|
||
| If you encounter any issues or have any questions regarding the addon, feel free | ||
| to [report them here](https://github.com/SageTendo/mal-stremio-addon/issues). | ||
| If you encounter any issues or have any questions regarding the addon, feel free to [report them here](https://github.com/SageTendo/mal-stremio-addon/issues). | ||
|
|
||
| ## API References | ||
|
|
||
| This addon is developed using the following API references: | ||
|
|
||
| - **Stremio Addon SDK**: This SDK provides the necessary tools and functions to create addons for Stremio. You can refer | ||
| to the [official Stremio Addon SDK documentation](https://github.com/Stremio/stremio-addon-sdk) for more information. | ||
| - **Stremio Addon SDK**: This SDK provides the necessary tools and functions to create addons for Stremio. You can refer to the [official Stremio Addon SDK documentation](https://github.com/Stremio/stremio-addon-sdk) for more information. | ||
|
|
||
| - **MyAnimeList (MAL)**: MyAnimeList is a popular online community and database for anime and manga enthusiasts. This | ||
| addon utilizes the MyAnimeList API to fetch and display user-specific anime list data. You can explore | ||
| the [MyAnimeList API Documentation](https://myanimelist.net/apiconfig/references/api/v2) for more details. | ||
| - **MyAnimeList (MAL)**: MyAnimeList is a popular online community and database for anime and manga enthusiasts. This addon utilizes the MyAnimeList API to fetch and display user-specific anime list data. You can explore the [MyAnimeList API Documentation](https://myanimelist.net/apiconfig/references/api/v2) for more details. | ||
|
|
||
| - **Stremio-Kitsu-Anime**: Unofficial Kitsu anime catalog for Stremio. Credits | ||
| to [TheBeastLT](https://github.com/TheBeastLT/stremio-kitsu-anime). | ||
| - **Stremio-Kitsu-Anime**: Unofficial Kitsu anime catalog for Stremio. Credits to [TheBeastLT](https://github.com/TheBeastLT/stremio-kitsu-anime). | ||
|
|
||
| Please refer to these API references for detailed information on how to interact with the respective APIs. | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
| - **Animeo**: Inspiration for the content syncing functionality. [More info here](https://github.com/Jenrykster/animeo). |