mirror of
https://github.com/liyunze-coding/Chat-Task-Tic-Overlay.git
synced 2026-08-24 10:04:00 -05:00
updated README
This commit is contained in:
liyunze
@@ -4,10 +4,17 @@
|
||||
|
||||
---
|
||||
|
||||
## Variations
|
||||
## Videos
|
||||
|
||||
- [Infinite Scroll version](https://github.com/liyunze-coding/chat-task-tic-overlay-infinity)
|
||||
- [Horizontal Scroll version](https://github.com/liyunze-coding/Chat-Task-Tic-Overlay-Horizontal)
|
||||
- [Setup + Customization details](https://youtu.be/-5EdJcvDuFQ)
|
||||
- [Setup without Visual Studio Code](https://youtu.be/7lK16yn6ho0)
|
||||
|
||||
---
|
||||
|
||||
## Variations
|
||||
|
||||
- [Infinite Scroll version](https://github.com/liyunze-coding/chat-task-tic-overlay-infinity)
|
||||
- [Horizontal Scroll version](https://github.com/liyunze-coding/Chat-Task-Tic-Overlay-Horizontal)
|
||||
|
||||
---
|
||||
|
||||
@@ -15,43 +22,44 @@
|
||||
|
||||
## Content
|
||||
|
||||
- [Chat-Task-Tic Widget](#chat-task-tic-widget)
|
||||
- [Variations](#variations)
|
||||
- [Content](#content)
|
||||
- [Commands](#commands)
|
||||
- [Moderators only](#moderators-only)
|
||||
- [Why you should use this](#why-you-should-use-this)
|
||||
- [For Twitch Task Overlay users (my old task list)](#for-twitch-task-overlay-users-my-old-task-list)
|
||||
- [Installation](#installation)
|
||||
- [Customization settings](#customization-settings)
|
||||
- [settings](#settings)
|
||||
- [fonts](#fonts)
|
||||
- [scroll](#scroll)
|
||||
- [task list](#task-list)
|
||||
- [header](#header)
|
||||
- [body](#body)
|
||||
- [task (individual tasks)](#task-individual-tasks)
|
||||
- [checkbox](#checkbox)
|
||||
- [bullet point](#bullet-point)
|
||||
- [colon](#colon)
|
||||
- [Aliases](#aliases)
|
||||
- [Credits](#credits)
|
||||
- [Chat-Task-Tic Widget](#chat-task-tic-widget)
|
||||
- [Videos](#videos)
|
||||
- [Variations](#variations)
|
||||
- [Content](#content)
|
||||
- [Commands](#commands)
|
||||
- [Moderators only](#moderators-only)
|
||||
- [Why you should use this](#why-you-should-use-this)
|
||||
- [For Twitch Task Overlay users (my old task list)](#for-twitch-task-overlay-users-my-old-task-list)
|
||||
- [Installation](#installation)
|
||||
- [Customization settings](#customization-settings)
|
||||
- [settings](#settings)
|
||||
- [fonts](#fonts)
|
||||
- [scroll](#scroll)
|
||||
- [task list](#task-list)
|
||||
- [header](#header)
|
||||
- [body](#body)
|
||||
- [task (individual tasks)](#task-individual-tasks)
|
||||
- [checkbox](#checkbox)
|
||||
- [bullet point](#bullet-point)
|
||||
- [colon](#colon)
|
||||
- [Aliases](#aliases)
|
||||
- [Credits](#credits)
|
||||
|
||||
---
|
||||
|
||||
## Commands
|
||||
|
||||
- !task \<task\> - Add a task
|
||||
- !done \<task\> - Mark a task as done
|
||||
- !remove \<task\> - Remove a task
|
||||
- !edit \<task\> - Edit a task
|
||||
- !check - Check your last task
|
||||
- !task \<task\> - Add a task
|
||||
- !done \<task\> - Mark a task as done
|
||||
- !remove \<task\> - Remove a task
|
||||
- !edit \<task\> - Edit a task
|
||||
- !check - Check your last task
|
||||
|
||||
### Moderators only
|
||||
|
||||
- !clear - Clear all tasks
|
||||
- !cleardone - Clear all done tasks
|
||||
- !adel @user - Remove all tasks from a user
|
||||
- !clear - Clear all tasks
|
||||
- !cleardone - Clear all done tasks
|
||||
- !adel @user - Remove all tasks from a user
|
||||
|
||||
For aliases, see [here](https://github.com/liyunze-coding/Chat-Task-Tic-Overlay#aliases)
|
||||
|
||||
@@ -59,11 +67,11 @@ For aliases, see [here](https://github.com/liyunze-coding/Chat-Task-Tic-Overlay#
|
||||
|
||||
## Why you should use this
|
||||
|
||||
- Free
|
||||
- Easy to use
|
||||
- Easy to setup
|
||||
- Easy to customize
|
||||
- No third-party database required
|
||||
- Free
|
||||
- Easy to use
|
||||
- Easy to setup
|
||||
- Easy to customize
|
||||
- No third-party database required
|
||||
|
||||
Note: It's only available on Twitch for now
|
||||
|
||||
@@ -115,8 +123,8 @@ const oauth = "OAUTH_TOKEN_HERE"; // do NOT include the 'oauth:' part
|
||||
|
||||
6. Setup `Browser Source` in OBS studio or other streaming software with the following settings:
|
||||
|
||||
- Local File: `checked`
|
||||
- Local File: `index.html`
|
||||
- Local File: `checked`
|
||||
- Local File: `index.html`
|
||||
|
||||
---
|
||||
|
||||
@@ -318,89 +326,89 @@ Edit `configs.js` to edit the style of the task list
|
||||
|
||||
**add task commands:**
|
||||
|
||||
- `!addtask`
|
||||
- `!add`
|
||||
- `!task`
|
||||
- `!taska`
|
||||
- `!taskadd`
|
||||
- `!atask`
|
||||
- `!todo`
|
||||
- `!addtask`
|
||||
- `!add`
|
||||
- `!task`
|
||||
- `!taska`
|
||||
- `!taskadd`
|
||||
- `!atask`
|
||||
- `!todo`
|
||||
|
||||
**delete task commands:**
|
||||
|
||||
- `!taskd`
|
||||
- `!taskdel`
|
||||
- `!taskdelete`
|
||||
- `!deltask`
|
||||
- `!deletetask`
|
||||
- `!taskr`
|
||||
- `!taskremove`
|
||||
- `!rtask`
|
||||
- `!removetask`
|
||||
- `!remove`
|
||||
- `!delete`
|
||||
- `!taskd`
|
||||
- `!taskdel`
|
||||
- `!taskdelete`
|
||||
- `!deltask`
|
||||
- `!deletetask`
|
||||
- `!taskr`
|
||||
- `!taskremove`
|
||||
- `!rtask`
|
||||
- `!removetask`
|
||||
- `!remove`
|
||||
- `!delete`
|
||||
|
||||
**edit task commands:**
|
||||
|
||||
- `taske`
|
||||
- `taskedit`
|
||||
- `etask`
|
||||
- `edittask`
|
||||
- `edit`
|
||||
- `taske`
|
||||
- `taskedit`
|
||||
- `etask`
|
||||
- `edittask`
|
||||
- `edit`
|
||||
|
||||
**finish task commands:**
|
||||
|
||||
- `!taskf`
|
||||
- `!taskfinish`
|
||||
- `!ftask`
|
||||
- `!finishtask`
|
||||
- `!taskdone`
|
||||
- `!donetask`
|
||||
- `!finish`
|
||||
- `!done`
|
||||
- `!finished`
|
||||
- `!taskf`
|
||||
- `!taskfinish`
|
||||
- `!ftask`
|
||||
- `!finishtask`
|
||||
- `!taskdone`
|
||||
- `!donetask`
|
||||
- `!finish`
|
||||
- `!done`
|
||||
- `!finished`
|
||||
|
||||
**check commands:** \(check last task of yourself or user\)
|
||||
|
||||
- `!taskc`
|
||||
- `!taskcheck`
|
||||
- `!ctask`
|
||||
- `!checktask`
|
||||
- `!mytask`
|
||||
- `!check`
|
||||
- `!taskc`
|
||||
- `!taskcheck`
|
||||
- `!ctask`
|
||||
- `!checktask`
|
||||
- `!mytask`
|
||||
- `!check`
|
||||
|
||||
Note: You can also use it like this: `!check @user` or `!check user`
|
||||
|
||||
**help commands:**
|
||||
|
||||
- `!taskh`
|
||||
- `!taskhelp`
|
||||
- `!htask`
|
||||
- `!helptask`
|
||||
- `!tasks`
|
||||
- `!taskh`
|
||||
- `!taskhelp`
|
||||
- `!htask`
|
||||
- `!helptask`
|
||||
- `!tasks`
|
||||
|
||||
**admin delete commands:** \(delete a task from a user\) \(mods only\)
|
||||
|
||||
- `!taskadel`
|
||||
- `!adel`
|
||||
- `!adelete`
|
||||
- `!admindelete`
|
||||
- `!taskadel`
|
||||
- `!adel`
|
||||
- `!adelete`
|
||||
- `!admindelete`
|
||||
|
||||
**admin clear done commands:** \(clear all done tasks from list\) \(mods only\)
|
||||
|
||||
- `!acleardone`
|
||||
- `!admincleardone`
|
||||
- `!cleardone`
|
||||
- `!acleardone`
|
||||
- `!admincleardone`
|
||||
- `!cleardone`
|
||||
|
||||
**admin clear all commands:** \(clear all tasks from list\) \(mods only\)
|
||||
|
||||
- `!clearall`
|
||||
- `!allclear`
|
||||
- `!adminclearall`
|
||||
- `!adminallclear`
|
||||
- `!aclearall`
|
||||
- `!aclear`
|
||||
- `!clear`
|
||||
- `!clearall`
|
||||
- `!allclear`
|
||||
- `!adminclearall`
|
||||
- `!adminallclear`
|
||||
- `!aclearall`
|
||||
- `!aclear`
|
||||
- `!clear`
|
||||
|
||||
---
|
||||
|
||||
@@ -412,11 +420,11 @@ Note: You can also use it like this: `!check @user` or `!check user`
|
||||
|
||||
**Contributors:**
|
||||
|
||||
- [**@MohFocus**](https://twitch.tv/MohFocus) \(helped with the code\)
|
||||
- [**@MohFocus**](https://twitch.tv/MohFocus) \(helped with the code\)
|
||||
|
||||
**Special thanks to:**
|
||||
|
||||
- [**@Instafluff**](https://twitch.tv/Instafluff) \(for the Comfy JS library\)
|
||||
- [**@Instafluff**](https://twitch.tv/Instafluff) \(for the Comfy JS library\)
|
||||
|
||||
**Shoutout to the following streamers for using my task list:** \(if you use my task list, please let me know and I'll add you to this list\)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user