2023-10-16 15:52:17 -04:00
# Plyx-Player
2023-10-16 17:35:27 -04:00
> Currently in beta stages.
## Installing
The Plyx Player is available to download from SudoVanilla's registry, run:
```bash
npm set registry https://packages.sudovanilla.com/
```
(This registry is also a proxy for NPM)
Then, for your project, install Plyx:
```bash
npm install @sudovanilla/plyx -player
```
## Usage
Add the stylesheet and script:
```html
...
< link rel = "stylesheet" href = "/node_modules/@sudovanilla/plyx-player/src/styles/app.css" >
< script src = "/node_modules/@sudovanilla/plyx-player/src/index.js" type = "module" >
...
```
2023-10-16 17:56:26 -04:00
Also add the Font Awesome that the Pylx uses:
```html
< script src = "https://kit.fontawesome.com/ecedfeb6bc.js" crossorigin = "anonymous" > < / script >
```
< details >
< summary > About this Font Awesome Pro Kit< / summary >
This kit is a Pro kit provided by SudoVanilla, it has only a limited amount icons that can be used since subsetting is used.
< / details >
2023-10-16 17:35:27 -04:00
Then, add the class name `plyx-player` to the `<video>` element and make sure it's wrapped around a div contained with the class name `video-container` :
```html
< div class = "video-container" >
< video class = "plyx-player" src = "video.mp4" > < / video >
< / div >
```
That's it, if you've linked the stylesheet and script correctly, it should work.