feat(channel): add channelDisplayName/channelUserName global variables

sogebot · Oct 15, 2023 · a2dcc87 · a2dcc87
1 parent 3cc262e
commit a2dcc87
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 12 deletions.
diff --git a/docs/_master/filters/all.md b/docs/_master/filters/all.md
@@ -156,6 +156,14 @@ bot it is twitch by default
 
 - return uptime of the stream
 
+`$channelDisplayName`
+
+- return channel display name
+
+`$channelUserName`
+
+- return channel user name
+
 ## Count subs / follows/ bits / tips in date interval
 
 - `(count|subs|<interval>)`

diff --git a/docs/filters/all.md b/docs/filters/all.md
@@ -156,6 +156,14 @@ bot it is twitch by default
 
 - return uptime of the stream
 
+`$channelDisplayName`
+
+- return channel display name
+
+`$channelUserName`
+
+- return channel user names
+
 ## Count subs / follows/ bits / tips in date interval
 
 - `(count|subs|<interval>)`

diff --git a/src/helpers/api/stats.ts b/src/helpers/api/stats.ts
@@ -1,11 +1,14 @@
-import { Types } from '~/plugins/ListenTo';
 import { persistent } from '../core/persistent';
 import { eventEmitter } from '../events';
 
+import { Types } from '~/plugins/ListenTo';
+
 const old = new Map<string, any>();
 const stats = persistent({
   value: {
     language:                   'en',
+    channelDisplayName:         '',
+    channelUserName:            '',
     currentWatchedTime:         0,
     currentViewers:             0,
     maxViewers:                 0,
@@ -21,6 +24,8 @@ const stats = persistent({
 
   } as {
     language: string;
+    channelDisplayName: string;
+    channelUserName: string;
     currentWatchedTime: number;
     currentViewers: number;
     maxViewers: number;

diff --git a/src/helpers/checkFilter.ts b/src/helpers/checkFilter.ts
@@ -95,17 +95,19 @@ class HelpersFilter {
     const uptime = vars.get('services.twitch.uptime') as number;
 
     const variables: Record<string, any> = {
-      $game:            stats.value.currentGame,
-      $language:        stats.value.language,
-      $viewers:         isStreamOnline.value ? stats.value.currentViewers : 0,
-      $followers:       stats.value.currentFollowers,
-      $subscribers:     stats.value.currentSubscribers,
-      $bits:            isStreamOnline.value ? stats.value.currentBits : 0,
-      $title:           stats.value.currentTitle,
-      $source:          opts.sender && typeof opts.discord !== 'undefined' ? 'discord' : 'twitch',
-      $isBotSubscriber: isBotSubscriber(),
-      $isStreamOnline:  isStreamOnline.value,
-      $uptime:          getTime(Date.now() - uptime, false),
+      $game:               stats.value.currentGame,
+      $language:           stats.value.language,
+      $viewers:            isStreamOnline.value ? stats.value.currentViewers : 0,
+      $followers:          stats.value.currentFollowers,
+      $subscribers:        stats.value.currentSubscribers,
+      $bits:               isStreamOnline.value ? stats.value.currentBits : 0,
+      $title:              stats.value.currentTitle,
+      $source:             opts.sender && typeof opts.discord !== 'undefined' ? 'discord' : 'twitch',
+      $isBotSubscriber:    isBotSubscriber(),
+      $isStreamOnline:     isStreamOnline.value,
+      $uptime:             getTime(Date.now() - uptime, false),
+      $channelDisplayName: stats.value.channelDisplayName,
+      $channelUserName:    stats.value.channelUserName,
     };
 
     if (message.includes('$thumbnail') && stats.value.currentGame) {

diff --git a/src/plugins/Sandbox.ts b/src/plugins/Sandbox.ts
@@ -152,6 +152,8 @@ export const runScriptInSandbox = (plugin: Plugin,
     game:               stats.value.currentGame,
     status:             stats.value.currentTitle,
     currentWatched:     stats.value.currentWatchedTime,
+    channelDisplayName: stats.value.channelDisplayName,
+    channelUserName:    stats.value.channelUserName,
   };
 
   eval(getTranspiledCode(___code___.id, ___code___.source));

diff --git a/src/services/twitch/calls/getChannelInformation.ts b/src/services/twitch/calls/getChannelInformation.ts
@@ -76,6 +76,8 @@ export async function getChannelInformation (opts: any) {
       apiStats.value.contentClasificationLabels = getChannelInfo[rawDataSymbol].content_classification_labels;
       apiStats.value.currentGame = getChannelInfo.gameName;
       apiStats.value.currentTitle = getChannelInfo.title;
+      apiStats.value.channelDisplayName = getChannelInfo.displayName;
+      apiStats.value.channelUserName = getChannelInfo.name;
 
       gameCache.value = getChannelInfo.gameName;
       rawStatus.value = _rawStatus;