added viewership rate statistic to uptime command under the variable …

…#viewrate-current bot users need to update the uptime output message to utilize it; adjusted the conditions for PubSub start button to be enabled when using the auth code token method-the prior checks only included the manual token method and disabled PubSub unless using 'turn on when stream is online' method.
WrithemTwine · Jan 9, 2024 · 4b0023a · 4b0023a
1 parent 670d33d
commit 4b0023a
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 7 deletions.
diff --git a/StreamerBot/StreamerBot.xaml.cs b/StreamerBot/StreamerBot.xaml.cs
@@ -723,9 +723,10 @@ private void CheckFocus()
                                                                     && OptionFlags.TwitchAuthStreamerClientSecret != ""
                                                                     && OptionFlags.TwitchAuthStreamerAuthCode == "";
 
-            Radio_Twitch_PubSubBotStart.IsEnabled = OptionFlags.TwitchStreamerUseToken ?
-                                                    (OptionFlags.TwitchStreamOauthToken != "" && OptionFlags.TwitchStreamerValidToken)
-                                                    : OptionFlags.TwitchBotAccessToken != "";
+            Radio_Twitch_PubSubBotStart.IsEnabled = OptionFlags.TwitchTokenUseAuth ?
+                (OptionFlags.TwitchStreamerUseToken ? OptionFlags.TwitchAuthStreamerAccessToken != "" : OptionFlags.TwitchAuthBotAccessToken != "") :
+                OptionFlags.TwitchStreamerUseToken ?
+                                                    (OptionFlags.TwitchStreamOauthToken != "" && OptionFlags.TwitchStreamerValidToken) : OptionFlags.TwitchBotAccessToken != "";
 
             // Twitch
 

diff --git a/StreamerBotLib/Culture/Msgs.resx b/StreamerBotLib/Culture/Msgs.resx
@@ -405,6 +405,9 @@
   <data name="Helpviewers" xml:space="preserve">
     <value>display the number of viewers</value>
   </data>
+  <data name="Helpviewrate" xml:space="preserve">
+    <value>Shows the current viewers / current followers percentage for the current live stream.</value>
+  </data>
   <data name="Helpwinner" xml:space="preserve">
     <value>display winner of Giveaway event</value>
   </data>
@@ -662,7 +665,7 @@
     <value>#user has returned. Welcome back!</value>
   </data>
   <data name="Msguptime" xml:space="preserve">
-    <value>#user has been streaming for #uptime, with #viewers (#deltaviewers).</value>
+    <value>#user has been streaming for #uptime, now with #viewers (#deltaviewers). The current viewer to follower rate is #viewrate, note, all viewers may not be followers.</value>
     <comment>leave #(variable) intact, the message otherwise can be re-arranged/translated as necessary. also used as default message to build data table</comment>
   </data>
   <data name="Msgusage" xml:space="preserve">

diff --git a/StreamerBotLib/Data/DataManager.cs b/StreamerBotLib/Data/DataManager.cs
@@ -1120,6 +1120,15 @@ public string GetNewestFollower()
             return ((FollowersRow)GetRows(_DataSource.Followers, null, $"{_DataSource.Followers.FollowedDateColumn.ColumnName} DESC").FirstOrDefault()).UserName;
         }
 
+        /// <summary>
+        /// Query the Follower table to count the current active channel followers.
+        /// </summary>
+        /// <returns>The count of the current follower list.</returns>
+        public int? GetFollowerCount()
+        {
+            return (GetRows(_DataSource.Followers, $"{_DataSource.Followers.IsFollowerColumn}='true'"))?.Length ?? null;
+        }
+
         /// <summary>
         /// Clear all user watchtimes
         /// </summary>

diff --git a/StreamerBotLib/Enums/MsgVars.cs b/StreamerBotLib/Enums/MsgVars.cs
@@ -50,6 +50,7 @@ public enum MsgVars
         quote,
         Pluralquote,
         Pluralbe,
-        be
+        be,
+        viewrate
     }
 }
diff --git a/StreamerBotLib/StreamerBotLib.csproj b/StreamerBotLib/StreamerBotLib.csproj
@@ -16,6 +16,10 @@
 		<Copyright>2024</Copyright>
 	</PropertyGroup>
 
+	<ItemGroup>
+	  <None Remove="Overlay\img\seconds.png" />
+	</ItemGroup>
+
 	<ItemGroup>
 		<Folder Include="MultiLive\Culture\" />
 	</ItemGroup>
@@ -36,6 +40,10 @@
 		<PackageReference Include="TwitchLib.PubSub" Version="3.2.6" />
 	</ItemGroup>
 
+	<ItemGroup>
+	  <Resource Include="Overlay\img\seconds.png" />
+	</ItemGroup>
+
 	<ItemGroup>
 		<Compile Update="Data\DataSource.Designer.cs">
 			<DesignTime>True</DesignTime>

diff --git a/StreamerBotLib/Systems/CommandSystem.cs b/StreamerBotLib/Systems/CommandSystem.cs
@@ -612,12 +612,16 @@ private string ParseCommand(string command, LiveUser User, List<string> arglist,
                 {
                     int DeltaViewers = Convert.ToInt32(arglist[0]) - LastLiveViewerCount;
 
-                    result = VariableParser.ParseReplace(OptionFlags.IsStreamOnline ? (DataManage.GetCommand(command).Message ?? LocalizedMsgSystem.GetDefaultComMsg(DefaultCommand.uptime)) : LocalizedMsgSystem.GetVar(Msg.Msgstreamoffline), VariableParser.BuildDictionary(new Tuple<MsgVars, string>[]
+                    result = VariableParser.ParseReplace(OptionFlags.IsStreamOnline ? 
+                        (DataManage.GetCommand(command).Message ?? LocalizedMsgSystem.GetDefaultComMsg(DefaultCommand.uptime)) : 
+                        LocalizedMsgSystem.GetVar(Msg.Msgstreamoffline), 
+                    VariableParser.BuildDictionary(new Tuple<MsgVars, string>[]
                     {
                     new( MsgVars.user, ChannelName ),
                     new( MsgVars.uptime, FormatData.FormatTimes(GetCurrentStreamStart) ),
                     new( MsgVars.viewers, FormatData.Plurality(arglist.Count > 0 ? arglist[0] : "", MsgVars.Pluralviewers) ),
-                    new( MsgVars.deltaviewers, $"{(DeltaViewers>0?'+':"")}{DeltaViewers}" )
+                    new( MsgVars.deltaviewers, $"{(DeltaViewers>0?'+':"")}{DeltaViewers}" ),
+                    new( MsgVars.viewrate, arglist.Count > 0 ? (Convert.ToDouble(arglist[0])/(DataManage.GetFollowerCount() ?? 1)).ToString("{P2}") : "0")
                     }));
 
                     LastLiveViewerCount = Convert.ToInt32(arglist[0]);