MinPluto/Zorn
MinPluto/Zorn
1
Fork 0
Code Issues Pull requests Activity

Update README

Browse source
This commit is contained in:
Korbs 2024-11-01 21:38:28 -04:00
parent cbc06d83ed
commit c793d5940f
1 changed files with 31 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -1,8 +1,24 @@
# Zorn
<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>
![Zorn using Milieu Mode](https://md.sudovanilla.org/images/Screenshot%20from%202024-08-16%2016-16-48.png)
A custom video player tailored for MinPluto.
<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:
@ -79,6 +95,7 @@ Local:
```jsx
<Zorn Video="/media/video.webm"/>
```
> [!NOTE]
> Use the `/public/` folder in your Astro project.
Remote:
@ -94,6 +111,7 @@ Local:
```jsx
<Zorn Audio="/media/audio.ogg"/>
```
> [!NOTE]
> Use the `/public/` folder in your Astro project.
Remote:
@ -127,7 +145,7 @@ Then, as a slot, add your menu like so:
</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:
@ -203,9 +221,10 @@ Just add the `Live` option with an `.m3u8` source.
| **Other Browsers**|
| FOSS Browser | ✅ | ✅ | ❌ | ✅ |
| Ladybird | 🔘 | 🔘 | 🔘 | 🔘 |
| Pale Moon | 🔘 | 🔘 | 🔘 | 🔘 |
| **WebKit Browsers**|
| Safari | 🔘 | 🔘 | 🔘 | 🔘 |
| GNOME Web | ✅ | ✅ | ✅*N| ✅ |
| GNOME Web | ✅ | ✅ | ✅ | ✅ |
| DuckDuckGo | 🔘 | 🔘 | 🔘 | 🔘 |
| **Electron Browsers**|
| Min | 🔘 | ✅ | ✅ | ✅ |
@ -215,9 +234,11 @@ Just add the `Live` option with an `.m3u8` source.
| Google Chrome | ✅ | ✅ | ✅ | ✅ |
| Microsoft Edge | ✅ | ✅ | ✅ | ✅ |
| Opera | ✅ | ✅ | ✅ | ✅ |
| Vanadium | 🔘 | 🔘 | 🔘 | 🔘 |
| Vivaldi | ✅ | ✅ | ✅ | ✅ |
| Yandex | ✅ | ❌ | ✅ | ❌ |
| Yandex | ✅ | ✅ | ✅ | ✅ |
| **Firefox Browsers**|
| Basilisk | 🔘 | 🔘 | 🔘 | 🔘 |
| Falkon | ✅ | ✅ | ✅ | ✅ |
| Firefox | ✅ | ✅ | ✅ | ✅ |
| Floorp | ✅ | ✅ | ✅ | ✅ |
@ -227,15 +248,12 @@ Just add the `Live` option with an `.m3u8` source.
| Mullvad | ✅ | ✅ | ✅ | ✅ |
| Tor | 🔘 | 🔘 | 🔘 | 🔘 |
| Waterfox | ✅ | ✅ | ✅ | ✅ |
| Zen | ✅ | ✅ | ✅ | ✅ |
| **Outdated Browsers**|
| Internet Explorer | 🔘 | 🔘 | 🔘 | 🔘 |
> All browsers are tested as-is out of box. Some functions with ❌ can probably work if you tweak the settings or interact with a built-in extension.
> [!NOTE]
> All browsers are tested as-is out of box. Some functions with ❌ can probably work if you tweak the settings or interact with a built-in extension. 🔘 means it's not been tested yet.
> IC: 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.
> N: The backdrop blur does not work. This should not affect the function of the video player.
## To Do
- [x] Support HLS (HTTP Live Streaming)
- [ ] Touch gestures for mobile
> [!NOTE]
> IC: 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.