diff --git a/.gitignore b/.gitignore index a51da91..16e52f8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ # Generated +.vscode node_modules test/.astro test/node_modules diff --git a/README.md b/README.md index 2953534..6c4e2f3 100644 --- a/README.md +++ b/README.md @@ -1,307 +1,59 @@ -
-

-Logo -

+
+ +
Logo
+
+ In-House Player built by MinPluto +
-
-
+ + + + +
-![Zorn using Milieu enabled](https://md.sudovanilla.org/images/zorn_player_milieu_with_transparency-video_islandia.webp) +
-
+![Zorn using Milieu enabled](https://md.sudovanilla.org/images/zorn_player_milieu_with_transparency-video_islandia.png) - - - -
+
-## Installation -To install Zorn for your Astro project, run the following: +## About +Zorn is a web video player built for Astro. Originally built for a MinPluto frontend project, that was scrapped. The player offers features such as ambient mode, custom settings menu, YouTube with Invidious API, and the ability to add a separated audio source. Ability to view m3u8 streams are also possible, supporting live streams. -```bash -npm install @minpluto/zorn --registry https://npm.sudovanilla.org -``` +## Links -## Examples -**Basic Usage** +General: + - [Showcase](https://studio.sudovanilla.org/) + - [Demo](https://zorn.demo.sudovanilla.org/) + - [Documentations](https://zorn.docs.sudovanilla.org/) -Import `Zorn` from the package and add it to your page. + Source Code: + - [SudoVanilla Ark](https://ark.sudovanilla.org/MinPluto/Zorn/) (Official) + - [Codeberg](https://codeberg.org/MinPluto/Zorn/) (Mirror) -```jsx ---- -import {Zorn} from '@minpluto/zorn' ---- + > Any other mirrors of the repository that are not listed here are not official and not controlled by SudoVanilla or MinPluto. There are plans to expand the list to other Forgejo instances. - -``` -> [!NOTE] -> The option `PlayerName` is now required as of v0.4.6. + ## License -**With Separated Audio Source** + ``` +Copyright (C) 2023 - 2025 MinPluto -Since Zorn is built for the MinPluto project, there are scenarios where the video source has no audio to get higher quality options, so Zorn has an option to add a seprated audio source to include. +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as +published by the Free Software Foundation, either version 3 of the +License, or (at your option) any later version. -```jsx ---- -import {Zorn} from '@minpluto/zorn' ---- +This program 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 Affero General Public License for more details. - -``` - -Make sure to add `muted` to the `VideoAttributes` option, just in case. - -## References -**Title** - `Title` - -When the video enters fullscreen, the title of the video will appear in the upper left corner of the screen. - -```jsx - -``` - -**Poster** - `Poster` - -Setting a thumbnail for the video player is done using the [`poster`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#poster) attribute. Just use a valid URL. - -```jsx - -``` - -**Video Source** - `Video` - -The main part of the video player, is of course the video. You can set any video source you want, local or remote. - -Local: -```jsx - -``` -> [!NOTE] -> Use the `/public/` folder in your Astro project. - -Remote: -```jsx - -``` - -**Audio Source** - `Audio` - -If you're in a scenario where the video source is missing audio, but you do have the audio itself, you can add that audio source to the video player. A separated `