PHPackages                             redbeed/openoverlay - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. redbeed/openoverlay

ActiveLibrary[Utility & Helpers](/categories/utility)

redbeed/openoverlay
===================

Your self hosted service for twitch web-based overlays and custom bot with Laravel.

0.7.0(4y ago)152611[4 issues](https://github.com/redbeed/OpenOverlay/issues)[1 PRs](https://github.com/redbeed/OpenOverlay/pulls)MITPHPCI failing

Since Dec 4Pushed 3y ago2 watchersCompare

[ Source](https://github.com/redbeed/OpenOverlay)[ Packagist](https://packagist.org/packages/redbeed/openoverlay)[ Docs](https://github.com/redbeed/openoverlay)[ RSS](/packages/redbeed-openoverlay/feed)WikiDiscussions main Synced 6d ago

READMEChangelog (10)Dependencies (9)Versions (21)Used By (0)

OpenOverlay
===========

[](#openoverlay)

[![Latest Version on Packagist](https://camo.githubusercontent.com/2959c31c61cda42d88714415c65df0fdec452777b396d9c2b58d36b782f2e977/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f726564626565642f6f70656e6f7665726c61792e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/redbeed/openoverlay)[![Total Downloads](https://camo.githubusercontent.com/6fdfb698e0b859cc0ae3cd0e4abae9413580fee3d2b5a3ccba69b4a733856bf9/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f726564626565642f6f70656e6f7665726c61792e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/redbeed/openoverlay)

OpenOverlay is a self-hosted service for your web-based twitch overlays and bot. This Laravel package helps you to receive all twitch events actions while you streaming and show them on your overlay. Also, you can develop your own bot with simple and advanced commands.

If you want to start from scratch with your overlay we have an example project. Standalone-Version: *[redbeed/OpenOverlay-Standalone](https://github.com/redbeed/OpenOverlay-Standalone)*

Installation
------------

[](#installation)

Via Composer

```
$ composer require redbeed/openoverlay
```

### Configuring

[](#configuring)

Add laravel config for OpenOverlay

```
php artisan vendor:publish --provider="Redbeed\OpenOverlay\OpenOverlayServiceProvider"
```

Migrate User Connections & Twitch Event table

```
php artisan migrate
```

Add configuration to `config/services.php`

```
'twitch' => [
  'client_id' => env('TWITCH_CLIENT_ID'),
  'client_secret' => env('TWITCH_CLIENT_SECRET'),
  'redirect' => env('TWITCH_REDIRECT_URI')
],
```

*Thanks to [SocialiteProviders/Twitch](https://github.com/SocialiteProviders/Twitch)*

Add ENV Keys

```
TWITCH_CLIENT_ID=
TWITCH_CLIENT_SECRET=

OVERLAY_SECRET=
OVERLAY_TWITCH_APP_TOKEN=

TWITCH_REDIRECT_URI=${APP_URL}/connection/callback
```

Add `UserOpenOverlay` trait to `User.php`

```