263 lines
9.6 KiB
Markdown
263 lines
9.6 KiB
Markdown
<br/>
|
|
<h3 align="center">
|
|
<img src="https://md.sudovanilla.org/images/Zorn%20Player.png" alt="Logo" height="64"/>
|
|
</h3>
|
|
<br/>
|
|
|
|
<div align="center">
|
|
Tailored for MinPluto, customizable for you.
|
|
<br />
|
|
<br />
|
|
<br />
|
|
</div>
|
|
|
|
|
|
|
|
<div align="center">
|
|
|
|
<a href="https://codeberg.org/MinPluto/Zorn/" target="_blank"> <img src="https://img.shields.io/badge/Codeberg-blue"> </a>
|
|
<a href="https://npm.sudovanilla.org/-/web/detail/@minpluto/zorn" target="_blank"> <img src="https://img.shields.io/badge/SudoVanilla%20Packages-purple"> </a>
|
|
<a href="https://www.npmjs.com/package/@minpluto/zorn" target="_blank"> <img src="https://img.shields.io/badge/NPM-red"> </a>
|
|
</div>
|
|
|
|
## Installation
|
|
To install Zorn for your Astro project, run the following:
|
|
|
|
```bash
|
|
npm install @minpluto/zorn --registry https://npm.sudovanilla.org
|
|
```
|
|
|
|
Zorn uses icons from Iconoir using their Vue package, you'll need to integrate Astro's Vue package if you want to use the custom controls.
|
|
|
|
Learn how: https://docs.astro.build/en/guides/integrations-guide/vue/#manual-install
|
|
|
|
## Examples
|
|
**Basic Usage**
|
|
|
|
Import `Zorn` from the package and add it to your page.
|
|
|
|
```jsx
|
|
---
|
|
import {Zorn} from '@minpluto/zorn'
|
|
---
|
|
|
|
<Zorn
|
|
PlayerName="nameit_whatever_you_want"
|
|
Poster="https://md.sudovanilla.org/images/eay-p-v.jpg"
|
|
Video="https://md.sudovanilla.org/videos/webm/Ennie-and-Yoyki.webm"
|
|
CustomControls
|
|
Milieu
|
|
/>
|
|
```
|
|
|
|
> [!NOTE]
|
|
> The option `PlayerName` is now required as of v0.4.6.
|
|
|
|
**With Separated Audio Source**
|
|
|
|
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.
|
|
|
|
```jsx
|
|
---
|
|
import {Zorn} from '@minpluto/zorn'
|
|
---
|
|
|
|
<Zorn
|
|
PlayerName="nameit_whatever_you_want"
|
|
Poster="https://md.sudovanilla.org/images/wote-p-v.jpeg"
|
|
Video="https://ocean.sudovanilla.org/media/videos/The%20Mark%20On%20The%20Wall/1080.mp4"
|
|
Audio="https://ocean.sudovanilla.org/media/videos/The%20Mark%20On%20The%20Wall/audio.mp4"
|
|
CustomControls
|
|
VideoAttributes="muted"
|
|
AudioAttributes=""
|
|
/>
|
|
```
|
|
|
|
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
|
|
<Zorn Title="Ennie and Yoyki: Non-Girly Games"/>
|
|
```
|
|
|
|
**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
|
|
<Zorn Poster="https://example.org/media/thumbnail.webp"/>
|
|
```
|
|
|
|
**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
|
|
<Zorn Video="/media/video.webm"/>
|
|
```
|
|
> [!NOTE]
|
|
> Use the `/public/` folder in your Astro project.
|
|
|
|
Remote:
|
|
```jsx
|
|
<Zorn Video="https://example.org/media/video.webm"/>
|
|
```
|
|
|
|
**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 `<audio/>` element is used, this will use a sync function in JavaScript to make sure the video and audio are synced. As before with the video source, it can be local or remote.
|
|
|
|
Local:
|
|
```jsx
|
|
<Zorn Audio="/media/audio.ogg"/>
|
|
```
|
|
> [!NOTE]
|
|
> Use the `/public/` folder in your Astro project.
|
|
|
|
Remote:
|
|
```jsx
|
|
<Zorn Audio="https://example.org/media/audio.ogg"/>
|
|
```
|
|
|
|
**Settings Menu** - `SettingsMenu`
|
|
|
|
<video title="Settings Menu in action on MinPluto" controls autoplay muted loop src="https://md.sudovanilla.org/videos/webm/Screencast%20from%202024-07-31%2000-44-01.webm"></video>
|
|
|
|
If you want to add additional settings to the player, you can enable the Settings button and add your own menu and sub-menus.
|
|
|
|
To enable the menu, add the `SettingsMenu` option:
|
|
```jsx
|
|
<Zorn SettingsMenu/>
|
|
```
|
|
|
|
Then, as a slot, add your menu like so:
|
|
```jsx
|
|
<Zorn SettingsMenu>
|
|
<div id="settings" class="vc-menu">
|
|
<button>Stats for Geeks</button>
|
|
<hr/>
|
|
<button>Open Video URL <ArrowUpRight/></button>
|
|
<button>Download <ArrowUpRight/></button>
|
|
<button>Embed <ArrowUpRight/></button>
|
|
<hr/>
|
|
<button id="has-switch">Milieu <SwitchOn/></button>
|
|
<button>Close Captions <NavArrowRight/></button>
|
|
</div>
|
|
</Zorn>
|
|
```
|
|
> [!NOTE]
|
|
> Use `OpenZornMenu()` as the open menu function. You can use the scripts provided in `/test/` of this package.
|
|
|
|
You can also add sub-menus with additional scripts you'll need to add:
|
|
```jsx
|
|
<Zorn SettingsMenu>
|
|
<div id="settings" class="vc-menu">
|
|
<button>Stats for Geeks</button>
|
|
<hr/>
|
|
<button>Open Video URL <ArrowUpRight/></button>
|
|
<button>Download <ArrowUpRight/></button>
|
|
<button>Embed <ArrowUpRight/></button>
|
|
<hr/>
|
|
<button id="has-switch">Milieu <SwitchOn/></button>
|
|
<button>Close Captions <NavArrowRight/></button>
|
|
<button onclick="PlayerMenu_Quality()">Quality <NavArrowRight/></button>
|
|
</div>
|
|
<div id="quality-changer" class="vc-menu">
|
|
<button onclick="OpenZornMenu()"><span style="display: flex; align-items: center;"><NavArrowLeft/> Back</span></button>
|
|
<button>1080p</button>
|
|
<button>720p</button>
|
|
<button>360p</button>
|
|
</div>
|
|
</Zorn>
|
|
|
|
<script is:inline>
|
|
function PlayerMenu_HideAll() {
|
|
document.querySelector('.vc-menu#settings').style.display = 'none'
|
|
document.querySelector('.vc-menu#quality-changer').style.display = 'none'
|
|
document.querySelector('#open-zorn-settings-button').setAttribute('onclick', 'OpenZornMenu()')
|
|
}
|
|
function OpenZornMenu() {
|
|
PlayerMenu_HideAll()
|
|
document.querySelector('.vc-menu#settings').style.display = 'flex'
|
|
document.querySelector('#open-zorn-settings-button').setAttribute('onclick', 'PlayerMenu_HideAll()')
|
|
}
|
|
function PlayerMenu_Quality() {
|
|
PlayerMenu_HideAll()
|
|
document.querySelector('.vc-menu#quality-changer').style.display = 'flex'
|
|
}
|
|
</script>
|
|
```
|
|
|
|
**Attributes** - `VideoAttributes` / `AudioAttributes`
|
|
|
|
If you need to add an addition attribute to either the video and/or audio source, then you can with `VideoAttributes` and `AudioAttributes`.
|
|
|
|
```jsx
|
|
<Zorn VideoAttributes="muted" AudioAttributes={'download="media.ogg"'}/>
|
|
```
|
|
|
|
**Milieu** - `Milieu`
|
|
|
|
The Milieu option is an attempt to copy YouTube's ambient player feature. Where it adds a blurry glow around the player. This uses two `<canvas/>`s behind the player to make a smooth transition when it changes.
|
|
|
|
```jsx
|
|
<Zorn Milieu/>
|
|
```
|
|
|
|
**Live** - `Live`
|
|
|
|
Zorn can stream `.m3u8` content with HLS support added. The HLS support is only added if you add the `Live` option.
|
|
|
|
Just add the `Live` option with an `.m3u8` source.
|
|
|
|
```jsx
|
|
<Zorn Live Video="https://example.org/cats.m3u8"/>
|
|
```
|
|
|
|
## Compatibility
|
|
### Web Browsers
|
|
| Browser | Live Streams |Player | CSS | JavaScript | Milieu |
|
|
|--------------------|--------------|-------|-----|------------|--------|
|
|
| **Other Browsers**|
|
|
| FOSS Browser | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Ladybird | 🔘 | 🔘 | 🔘 | 🔘 | 🔘 |
|
|
| Pale Moon | ❌ | ✅ | ✅ | ✅ | ✅ |
|
|
| **WebKit Browsers**|
|
|
| Safari | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| GNOME Web | ✅ | ✅ | ✅ | ✅ | ❌ |
|
|
| DuckDuckGo | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| **Electron Browsers**|
|
|
| Min | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| **Chromium Browsers**|
|
|
| Brave | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Chromium | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Google Chrome | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Microsoft Edge | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Opera | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Vivaldi | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Yandex | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| **Firefox Browsers**|
|
|
| Falkon | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Firefox | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Floorp | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| GNU/IceCat | ✅ | ✅ | ✅ | ✅❶ | ✅ |
|
|
| Ghostery | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Huma | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Librewolf | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Mull | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Mullvad | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Waterfox | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
| Zen | ✅ | ✅ | ✅ | ✅ | ✅ |
|
|
|
|
**Symbols**
|
|
- ✅ Supported
|
|
- ❌ Not Supported or broken
|
|
- 🔘 Not Tested
|
|
|
|
> [!NOTE]
|
|
> ❶ By default, GNU/IceCat has the LibreJS extension installed, it will block all JS by default if it does not provide a valid license. Examples for settings menu do not provide one nor one is shown in the test version. For settings menu script, you can add [this license](https://ark.sudovanilla.org/MinPluto/Zorn/src/commit/9bcbd72237f7ccb56f526d96b8f4a3caf1289bfb/src/Controls/Controller.astro#L2-L26) to the top of the script. Learn more: https://www.gnu.org/software/librejs/free-your-javascript.html |