https://github.com/satouriko/ushio

🍭 Get your favorite html video player in one simple html tag.
https://github.com/satouriko/ushio

Last synced: 13 days ago
JSON representation

🍭 Get your favorite html video player in one simple html tag.

• Host: GitHub
• URL: https://github.com/satouriko/ushio
• Owner: satouriko
• Created: 2018-10-04T10:32:02.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T01:59:52.000Z (almost 2 years ago)
• Last Synced: 2024-04-27T06:06:46.332Z (7 months ago)
• Language: TypeScript
• Homepage: https://ushio.js.org
• Size: 4.36 MB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 28
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🍭 Ushio Player

[![npm](https://flat.badgen.net/npm/v/ushio)](https://www.npmjs.com/package/ushio)

[![npm](https://flat.badgen.net/npm/dw/ushio)](https://www.npmjs.com/package/ushio)

[![Badgesize](https://flat.badgen.net/badgesize/gzip/rikakomoe/ushio/master/dist/ushio/bundles/ushio.min.js)](https://www.npmjs.com/package/ushio)

[![JavaScript Style Guide](https://flat.badgen.net/badge/code%20style/standard/green)](https://standardjs.com)

[![Gitmoji](https://flat.badgen.net/badge/gitmoji/%F0%9F%98%9C%20%F0%9F%98%8D/FFDD67)](https://gitmoji.carloscuesta.me)

Ushio is an HTML video player, built with the trendy technology "web component".

You are now able to have your favorite, lovely and good-looking video player integrated,

by a simple HTML tag.

## Features

Why Ushio?

Ushio is created for mainly the following needs:

1. Switch sources. You can provide a few sources to one video, and users

are able to switch between them via a menu. This is typically used for

switching video quality.

2. Multi-track subtitles. You can have multiple tracks of subtitles displaying

in your video, at the same time. Users also have the choice to decide which

track to use. Both SRT and WebVTT format are supported.

3. Responsive design. Ushio is not bad on interact experience when you use your

finger instead of a mouse. You can use this player in your responsive website,

like your blog ;)

4. Extensible. Injecting stylesheets is super easy. This player meets your need

in most situation.

5. Full-featured. Ushio player is highly completed. Volume change, playback rate

change, hot key and everything you'll use in a normal HTML video player, they're

just here.

## 👷‍♀️ User Guide

[Documentation and Demo](https://ushio.netlify.com)

## 👷‍♂️ Developer's Guide

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.3.6.

### Development server

Run `yarn start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

This command will run the ushio demo site.

### Build

Run `yarn build` to build the project. The build artifacts will be stored in the `dist/ushio` directory.

### Build demo website

Run `yarn build-demo` to build the demo website. The build artifacts will be stored in the `dist/ushio-demo` directory.