Releases: matthewjohnston4/TwitchListOverlay
Updates to admin view
If you use Admin View, you'll find some nice new usability updates in this release. The UI has been overhauled to be more useful for streamers, with a darker look to blend in with OBS.
Separately, OBS introduced a new way of referencing local files (http://absolute/file-path-here
) when they're used in a Browser Source overlay. But they kept the old, familiar path style (file:///file-path-here
) for Custom Dock browser sources.
This broke the admin view, because there were two separate browser sources working side-by-side, and that meant the local storage used by the overlay wasn't being shared with the admin view widget. To fix this, just update your admin dock source to use http://absolute/file-path-here
as shown in the README file.
Upgrading to this release
Beyond the existing upgrade instructions you should:
- Update your admin view browser source URL as explained above
- Refresh your admin view and the list overlay itself in OBS
Full Changelog: v2.0.0...v2.1
New OBS broadcaster dock admin view and TypeScript conversion
Feature updates:
- Added a new "admin mode" view for the overlay. This mode allows direct browser interaction with the list overlay, meaning you can edit, add, or delete list items (or titles) from the browser, instead of Twitch chat. You can load in admin mode by appending
?admin
to the localfile://
URL oftwitchOverlays.htm
. - This admin mode view can be used as a custom browser dock within OBS, allowing you to pin the admin view alongside your other broadcaster dock items. See the README for more instructions on how to use this.
- One small technical note about admin mode: because the overlay uses your browser's local storage to store the list data, admin mode will only work correctly when loaded in the same browser as the public-facing overlay. Luckily, in OBS, custom browser docks and browser overlays share the same browser storage, so use it there without worrying.
Upgrade notes:
If you're upgrading from a previous version of this overlay, make sure not to interfere with the window.config = {
line at the top of config-general.js
or the similar line at the top of config-local.js
. This line has changed from previous versions, so please change only the values within the config, and not the wrapping (which might happen if you just blindly copy and paste your older config).
Boring technical updates:
- Converted the app code to strict-mode TypeScript, and added ESLint linting. All tied together by Babel and Webpack. For daily users, this should mean nothing, but strongly-typed code will be a bit less prone to bugs introduced by me.
- README contribution section has been updated to reflect the changes this causes to the compilation process. Even for potential contributors (or people working on their own fork) the process difference should be minimal.
- Due to the Webpack process,
app.js
loaded by the overlay page is nowmain.js
and is minified. - Fixed an unsurfaced bug with emojis and Twitch emotes in the same item text.
Full diff
Beta: New OBS broadcaster dock admin view and TypeScript conversion
Feature updates:
- Added a new "admin mode" view for the overlay. This mode allows direct browser interaction with the list overlay, meaning you can edit, add, or delete list items (or titles) from the browser, instead of Twitch chat. You can load in admin mode by appending
?admin
to the localfile://
URL oftwitchOverlays.htm
. - This admin mode view can be used as a custom browser dock within OBS, allowing you to pin the admin view alongside your other broadcaster dock items. See the README for more instructions on how to use this.
- One small technical note about admin mode: because the overlay uses your browser's local storage to store the list data, admin mode will only work correctly when loaded in the same browser as the public-facing overlay. Luckily, in OBS, custom browser docks and browser overlays share the same browser storage, so use it there without worrying.
Upgrade notes:
If you're upgrading from a previous version of this overlay, make sure not to interfere with the window.config = {
line at the top of config-general.js
or the similar line at the top of config-local.js
. This line has changed from previous versions, so please change only the values within the config, and not the wrapping (which might happen if you just blindly copy and paste your older config).
Boring technical updates:
- Converted the app code to strict-mode TypeScript, and added ESLint linting. All tied together by Babel and Webpack. For daily users, this should mean nothing, but strongly-typed code will be a bit less prone to bugs introduced by me.
- README contribution section has been updated to reflect the changes this causes to the compilation process. Even for potential contributors (or people working on their own fork) the process difference should be minimal.
- Due to the Webpack process,
app.js
loaded by the overlay page is nowmain.js
and is minified. - Fixed an unsurfaced bug with emojis and Twitch emotes in the same item text.
Full diff
Fixes for emote use and security simplification
- Re-added the security simplification code, corrected, and tested.
- Twitch emote (not emoji) usage in items and titles should work again.
Full changes: v1.2.1...v1.2.3
Revert security test change
EMERGENCY FIX!
Visual changes and new silent adding command
- Added fuller explanations of all config settings to the README.
- Added
useListSymbols
setting to determine whether or not bullet points should be used on list items. ThelistSymbol
determines what the bullet symbol actually is, and it can be any unicode character, or any standard emoji. - Adjusted the naming for the vertical positioning setting. Now it's called
fillMethod
and is explained in the context of the expansion direction of the list, which encourages the broadcaster to choose their own vertical position by dragging the overlay in OBS. - Added a subcommand called
addSilent
which allows people to add list items without affecting the visibility of the list. width
is now a config setting, rather than being defined in the CSS.- Also simplified security checking — there's now a
defaultSecurityCheck
function (defaults to moderators and broadcaster only) which can be changed directly within the function, or over-ridden on a per-handler basis.
Upgrading to this release
Backup any changes you've made to config-general.js
, or in the CSS, then pull the changes from the Git repo, or download this releases ZIP file below.
Minor fixes and tweaks
- Adjusted default width of the overlay from 20vw to 25vw
- Bumped the default font sizes up a wee bit
- Added a general config option for
useListSymbols
that enables bullet points on list items. - ESLint of
app.js
(sorry)