ched-dev / obs-tasks-overlay

A browser source application to add Tasks to your OBS Overlays

OBS Tasks Overlay

A browser application to show Tasks in an OBS Browser Source, controlled via Twitch chat commands (!task add A New Task)

OBS Browser Source URL: 
https://obs-tasks-overlay.vercel.app/?channelName=ched_dev&scale=2&verticalAlign=middle
Width: 800
Height: 800

OBS Browser Source URL: 
https://obs-tasks-overlay.vercel.app/?channelName=ched_dev&scale=1.2
Width: 400
Height: 400

Features

• !task add Task Title adds task to end of list
• !task start [taskId] starts taskId or next available task
• !task pause [taskId] pauses current task
• !task next [taskId] ends current task, starts taskId or next available task
• !task end [taskId] ends current task
• !task edit taskId New Task Title
• !task move 4 3 or !task swap 4 3 swaps task from #4 to #3
• !task sort sorts the tasks by completed, in progress, remaining
• !task reset taskId resets the task to incomplete with no time
• !task clear [taskId] removes taskId or all completed tasks from list
• !task title Title of the List changes the title of the list on screen
• Saved to localStorage (enabled by default)
• Custom task commands can be added in taskHandlers/index.js
• Configuration: Command Name, Allow Mods, Allowed Users List, Title Text, Font Family, Font Color, Scale, Vertical Align
• Configuration UI

OBS Installation

Load a new Browser Source to the URL:

https://obs-tasks-overlay.vercel.app/?channelName=twitchUsername

The task list will stretch the full width of the browser source, allowing you to create it at your desired size.

Additional configuration options are available as query parameters:

channelName=twitchUsername

Required

The Twitch channel chat to join and watch for messages. By default, only the broadcaster can run the !task commands.

command=!task

Set the command you wish to listen for. We use !task by default. No spaces allowed in command.

allowMods=true

Allow mods to run the !task commands on your behalf. Defaults false.

allowedUsers=Streamlabs,Nightbot

Allow specific users to run the !task commands on your behalf. Defaults empty.

fontFamily="PT Mono",monospace

Change the font family for all text on the page. Accepts a standard css font-family value. Defaults sans-serif.

fontColor=crimson

Change the color for all text on the page. Accepts a standard css color value (rgb, hex, css3 color names). Defaults white.

scale=2

Scale of the text on the page. Defaults to 1, increments by .1. E.g. 1.4 is valid

verticalAlign=middle

Vertically aligns the list within your OBS browser source window. Options are top, center, middle, bottom. Defaults to top.

Fully Configured Example URL:

https://obs-tasks-overlay.vercel.app/?channelName=ched_dev&scale=2&verticalAlign=middle

Getting Setup for Development

This is a Next.js project bootstrapped with create-next-app.

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.