Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brunurd/companion
Did you know Compy, The Companion? They are a friendly mini browser to pin on top of any other desktop app and keep doing your stuff while enjoying a live stream, video on demand, or consulting any web content.
https://github.com/brunurd/companion
app browser client companion electron web
Last synced: about 1 month ago
JSON representation
Did you know Compy, The Companion? They are a friendly mini browser to pin on top of any other desktop app and keep doing your stuff while enjoying a live stream, video on demand, or consulting any web content.
- Host: GitHub
- URL: https://github.com/brunurd/companion
- Owner: brunurd
- License: mit
- Created: 2018-02-19T01:01:06.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-06-03T19:10:01.000Z (7 months ago)
- Last Synced: 2024-11-10T15:52:19.761Z (about 2 months ago)
- Topics: app, browser, client, companion, electron, web
- Language: JavaScript
- Homepage: http://getcompy.com
- Size: 5.8 MB
- Stars: 54
- Watchers: 0
- Forks: 8
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Companion
[![license][license-badge]](LICENSE.md)
[![npm-version][npm-version]](https://github.com/brunurd/companion/releases)
Did you know Compy the companion? They are a friendly mini browser to pin on top of any other desktop app and keep doing your things while enjoying a live stream or a youtube video.
⚠️ **Disclaimers:**
- I've been working in an browser extension to be this app replacement, it was in a very, very early stage:
- For a full (and more secure) browser experience with the _always-on-top_ feature I recommend use Firefox (it has the _picture-in-picture_ feature built-in).
- At the moments the releases are made manually, I need time to create a proper continous distribution automation routine, follow the instruction on [How to Compile](#user-content-how-to-compile) if you want a specific version.
---
### Tested services
|Name|Works|Info|
|-|-|-|
|Twitch|⚠️|Authentication issue, can't login|
|Youtube|:heavy_check_mark:|Ok|
|SoundCloud|:heavy_check_mark:|Ok|
|Netflix|:x:|DRM problem, needs Widevine|
|DisneyPlus|:x:|DRM problem|
## Downloads
[Windows x64][win-download] | [macOS][mac-download] | [Linux][linux-download]
![Screenshot][screenshot]
_Streamer at the screenshot: [@rawrafaela](https://www.twitch.tv/rawrafaela) member of the [@wakandastreamers](https://www.twitch.tv/team/wakandastreamers) team._
## How to Compile
Pre-requisites:
- Run on the target platform: Windows, MacOS or Linux (In Linux it uses AppImage)
- Node.js
Install dependencies with:
```bash
npm install
```
Run the distribution command:
```bash
# For Linux
npm run dist:linux
# For Windows
npm run dist:win
# For mac
npm run dist:mac
```
[screenshot]: public/images/screenshot.gif
[license-badge]: https://img.shields.io/github/license/brunurd/companion
[npm-version]: https://img.shields.io/github/package-json/v/brunurd/companion
[linux-download]: https://github.com/brunurd/companion/releases/download/v1.5.5/Companion-1.5.5.AppImage
[mac-download]: https://github.com/brunurd/companion/releases/download/v1.5.5/Companion-1.5.5.dmg
[win-download]: https://github.com/brunurd/companion/releases/download/v1.5.5/Companion.1.5.5.exe