Skip to content

Commit

Permalink
Add note to README on accessing overlay directly in browser
Browse files Browse the repository at this point in the history
  • Loading branch information
MattIPv4 committed Feb 11, 2023
1 parent 80f2588 commit 564f799
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,15 @@ If you are testing the panel, make sure to activate the extension for a panel sl

If you want to use an alternate account, add the account to `Testing Account Allowlist` under the `Access` tab of the extension version and install the extension on that account.

### Running without Twitch

If you just want to test out the overlay, or the panel, locally without Twitch, you can do so by directly opening the pages in a browser. After all, Twitch overlays and panels are just embedded web apps.

The panel is available at [localhost:8080/panel.html](https://localhost:8080/panel.html) and the overlay is available at [localhost:8080/overlay.html](https://localhost:8080/overlay.html) while the development server is running.

### Running via Developer Rig

To test the overlay locally, you'll need to install the [Twitch Developer Rig](https://dev.twitch.tv/docs/extensions/rig/).
To test the overlay locally with Twitch, you'll need to install the [Twitch Developer Rig](https://dev.twitch.tv/docs/extensions/rig/).

Open the rig application and authenticate it with your Twitch account. Click on `Create your First Project` in the rig UI, and select the extension you created earlier.
When prompted, select the root of the repository as the project directory and select `None - I'll use my own code` for the boilerplate code option.
Expand Down

0 comments on commit 564f799

Please sign in to comment.