craftamap / owncast-browser-extension Goto Github PK

View Code? Open in Web Editor NEW

26.0 26.0 1.0 2.92 MB

Owncast Browser Extension is a Firefox extension used to follow various Owncast Instances

License: MIT License

JavaScript 46.09% SCSS 7.21% Vue 42.92% TypeScript 3.78%

firefox-extension owncast

owncast-browser-extension's Introduction

Owncast Browser Extension

Owncast Browser Extension is a Firefox and Chrome/Chromium extension used to follow various Owncast Instances

Installation

The addon can be installed from addons.mozilla.com or from the Chrome Web Store.

Building and Development

This extension uses webpack as build system. For most components, Vue.js and Vuex is used. Sometimes, vanillajs is used though.

tailwindcss is also used.

This Extension is built using yarn. You may also use npm, but yarn is recommended. You can use the following commands:

yarn build - Runs webpack and web-ext build. This is used to build the plugin. Use yarn yarn install first. The extension will be outputted into web-ext-artifacts directory.
yarn lint - Runs eslint and web-ext lint
yarn watch - Runs webpack --watch
yarn start - Runs web-ext start. Use together with yarn watch to see your changes in live-time.

Contributing

Pull requests are welcome.

License

MIT

owncast-browser-extension's People

Contributors

Stargazers

Watchers

Forkers

racheklos

owncast-browser-extension's Issues

Switch to modern tooling

Considering we are using vue, we should consider using vite if possible. This would also allow ts support without changing our webpack config, which I imagine being messy.

Feature Request: Open with Media Player

It would be cool if there was a button that opens the Stream with a Media Player such as VLC or MPV.

Display Stream titles: Knowing when Streamers are online is helpful. Knowing what they are doing would be even more so.

Write tests

Optional, but could be cool to do.

research if selenium can be used for this
research if we can start an owncast instance in github actions
find cool test framework for unit tests

Owncast Logo should link to the directory

Currently, clicking on the owncast Logo links to the owncast webpage/documentation. However, it should link to https://directory.owncast.online

Upgrade web-ext once JS_SYNTAX_ERROR error is resolved

We currently use web-ext in version the fixed version 6.5.0, as web-ext lint fails otherwise with JS_SYNTAX_ERROR. Check regularly if a new web-ext version is out, and upgrade if the issue is resolved.

Opt-In: Sync Storage

User Interface: If the new user interface of 0.0.11 is used, show the owncast-browser-extension icon in the "#external-actions-container".

Closes #202

Strip HTML using DomParser instead of regex

function strip(html){
   let doc = new DOMParser().parseFromString(html, 'text/html');
   return doc.body.textContent || "";
}

"Add to extension"-button is not inserted if no social media links exist

This got reported by @muesli on owncast.rocket.chat

Use a fediverse account to see which channels are live.

This change should allow you to log into a fediverse account, like a mastodon account, to get a list of followed accounts. We then can check if those are owncast instances. If true, we store them and can show them into the UI.

Popup is broken when addon-icon is in overflow menu in firefox

Don't show 0 above the Icon: Have the number only show up when at least one Streamer is online. That way, it is more likely to be noticed.

Automatic name changer

This feature was suggested in the owncast chat. When opening a stream, the extension could automatically change the username to a pre-set one.

Release/port to chrome

Currently, this browser extension is only available for firefox. To have a bigger user group, let's research on how we can make this extension available in chrome/chromium-based browsers

Migrate to TypeScript

Upgrade to vue3

Heads up! Owncast small design change

Just so you're not caught off guard I wanted to let you know about a small design change that will be in the next release. We're moving around where the social icons are, so your "Add to extension" button gets moved as well.