1.1.0 - 2022.09.21 | Icon folder

Author: JustCoderdev

.gitignore

@@ -1,4 +1,6 @@
 .vscode/
-env.py
-temp/
-index.spec
+build/scripts/__pycache__
+build/scripts/env.py
+build/scripts/index.spec
+build/temp/
+helpers/tools/

Changelog.md

@@ -4,7 +4,7 @@ A plugin for [Touch Portal](https://www.touch-portal.com/) to have information a
 
 Here there is going to be the changelog of the new versions of the plugin
 
-## [Released]
+## [Released][released]
 
 ## [1.0.0] - 2022.07.09 | Release
 
@@ -42,13 +42,26 @@ All of the basic features on the plugin
 ## [1.0.3] - 2022.07.14 | Visual improvement and fixed start crash
 
 ### Added
+
 - When the settings are updating the counter is set to `x`
-- Added a blank icon to help TP to 'refresh' the visual 
+- Added a blank icon to help TP to 'refresh' the visual
 
 ### Fixed
+
 - On startup, if offline, the plugin should no longer crash and will set up channels once it is online
 - In the helpers the icon didn't update because the default one wasn't nothing and it covered the plug-in icon being on a higher level
 
+## [1.1.0] - 2022.09.21 | Icon folder
+
+### Added
+
+- Log helper and a clean look to the log file (more info in the README under EXTRA section)
+
+### Changed
+
+- Updated the README to include the new functions
+- New folder added to the plugin called `utils` that contains the log file and the logo of the plugin
+- New folder called `Icons` that collects all of the used icon by the plugins to allow customization and reduce fetch time on start
 
 <!-- ## [Unreleased] -->
 <!--
@@ -66,4 +79,5 @@ All of the basic features on the plugin
 [1.0.0]: https://github.com/JustCoderdev/TwitchActivity/tree/d5b02548cd3f141b0994c05cfed2e136c222fb90
 [1.0.1]: https://github.com/JustCoderdev/TwitchActivity/tree/d4de7b5ebb64ea9d45755294f22e8d6bb2cf3b4a
 [1.0.2]: https://github.com/JustCoderdev/TwitchActivity/tree/63585f733113ce215415e845e96538d5620764fa
-[1.0.3]: https://github.com/JustCoderdev/TwitchActivity/tree/
+[1.0.3]: https://github.com/JustCoderdev/TwitchActivity/tree/79fe641c2a4aafadd0e475d0a9108062c80480a1
+[1.1.0]: https://github.com/JustCoderdev/TwitchActivity/tree/

README.md

@@ -7,21 +7,35 @@ This documentation is partially generated with [Python TouchPortal SDK](https://
 ## Quick Setup
 
 1. Import the plugin from the release section on [github](https://github.com/JustCoderdev/TwitchActivity/releases)
-2. Go to the plugin settings and change `Channel names` to the names of your followed channels and if you need adjust the refresh time (enter the time in minutes)
-   > NOTE: `Channel names` **must** be formatted like it is by default (MonikaCinnyRoll,xSgtPepperx)without spaces (otherwise it will automatically remove them) and separated by a `,` (capital letters have no influence over the functioning of the plugin but you can change it for esthetic) and contain up to 100 channels (the last one are going to be ignored)
+2. Go to the plugin settings and change `Channel names` to the names of your followed channels and, if you need, adjust the refresh time (enter the time in minutes)
+   > NOTE: `Channel names` **must** be formatted like this (MonikaCinnyRoll,xSgtPepperx) and separated by `,` (capital letters and spaces have no influence over the functioning of the plugin) and contain up to 100 channels (the extra ones are just going to be ignored)
 3. Import a simple button from `helpers/touchportal`
-4. Go to the button GUI and change `Open stream` action field to your channel name
+4. Go to the button GUI and change `Open stream` action field to any channel name (doesn't need to be one from `Channel names`, anyone is fine)
 5. Press the `On Event` tab and change the value in `Update Button text...` from `${value:com.github.justcoderdev.twitchactivity.state.xSgtPepperx.viewers}` to `${value:com.github.justcoderdev.twitchactivity.state.YOURCHANNELNAME.viewers}` and `Change the icon...` from `xSgtPepperx icon` to `YOURCHANNELNAME icon`
 6. Done! Now you can customize this button as you wish, adding a shade of red when the connection is lost, showing 🔴 next to the viewers number, adding a default image to avoid having the blank icon in TP from the pc, showing the channel name, etc... (view the [FAQ](#faq) for more info)
 
+## Extra
+
+- Custom icons
+  > Use your own set of icons that can gray out and automatically be integrated with the plugin)
+  1. Wait until the plugin loads the `Icons` folder in `%APPDATA%\TouchPortal\plugins\TwitchActivity`
+  2. Drop your icons (in PNG format) in the folder and rename them like this `YOURCHANNELNAME.png` with `YOURCHANNELNAME` in lowercase (`yourchannelname.png`)
+  3. Done!
+
+- Read the Log
+  > The log file has a symbol before each action
+  - `!`: initialization process
+  - `?`: general information log
+  - `*`: update on the states
+
 ## Plugin features
 
 ### Actions
 
-| Action Name | Description                                              | Format          | Data                                       | On Hold |
-| ----------- | -------------------------------------------------------- | --------------- | ------------------------------------------ | :-----: |
-| Refresh     | This action will refresh the channels states             |                 |                                            |   No    |
-| Open stream | This action will open selected channel stream in browser | Open [1] stream | 1. Type: text   Default: **ImKibitz** |   No    |
+| Action Name | Description                                              | Format           | Data                                       | On Hold |
+| ----------- | -------------------------------------------------------- | ---------------- | ------------------------------------------ | :-----: |
+| Refresh     | This action will refresh the channels states             |                  |                                            |   No    |
+| Open stream | This action will open selected channel stream in browser | Open \[1] stream | 1. Type: text   Default: **ImKibitz** |   No    |
 
 ### States
 
@@ -31,6 +45,14 @@ This documentation is partially generated with [Python TouchPortal SDK](https://
 | .state.time_until_refresh | Time until refresh | 600               | Twitch Activity |
 | .state.blank_icon         | Blank icon         | _b64 blank Image_ | Twitch Activity |
 
+### Streamer Specific States
+
+| Id                               | Description               | DefaultValue | parentGroup       |
+| -------------------------------- | ------------------------- | ------------ | ----------------- |
+| .state.`YOURCHANNELNAME`.state   | `YOURCHANNELNAME` state   | Offline      | `YOURCHANNELNAME` |
+| .state.`YOURCHANNELNAME`.icon    | `YOURCHANNELNAME` icon    | ''           | `YOURCHANNELNAME` |
+| .state.`YOURCHANNELNAME`.viewers | `YOURCHANNELNAME` viewers | 0            | `YOURCHANNELNAME` |
+
 ### Events
 
 | Id                      | Name             | Evaluated State Id   | Format  | Type   | Choice(s)                                                            |
@@ -59,7 +81,7 @@ The viewers count if the channel is offline it's a simple empty string (`''`) el
 
 ## Error handling
 
-In case the countdown doesn't tick anymore, the plugin has crashed, try reloading TP or just stop and restart the plugin. If the problem persists contact me (info below)
+In case the countdown doesn't tick anymore, the plugin has crashed, try reloading TP or just stop and restart the plugin. If the problem persists [contact me](#Notes)
 
 If, when adding a new streamer, its icon is not displayed and after TP restarts none of the plugin icons are displayed there may be a space in the `Channel names` setting
 

TwitchActivity/entry.tp

@@ -1,6 +1,6 @@
 {
   "sdk": 6,
-  "version": 4,
+  "version": 5,
   "name": "Twitch Activity",
   "id": "com.github.justcoderdev.twitchactivity",
   "configuration": {
@@ -12,7 +12,7 @@
     {
       "id": "com.github.justcoderdev.twitchactivity.cat",
       "name": "Twitch Activity",
-      "imagepath": "%TP_PLUGIN_FOLDER%TwitchActivity\\logo.png",
+      "imagepath": "%TP_PLUGIN_FOLDER%TwitchActivity\\utils\\logo.png",
       "actions": [
         {
           "id": "com.github.justcoderdev.twitchactivity.act.refresh",

TwitchActivity/index.exe

@@ -2,15 +2,16 @@
 from env import CLIENT_ID, CLIENT_SECRET
 from base64 import b64decode, b64encode
 from webbrowser import open as browse
+from os import mkdir, path
 from io import BytesIO
 from PIL import Image
 
 #* DEBUG
 from logging import INFO, basicConfig, info
 
 
-open('.\log.txt', 'w').write('')
-basicConfig(filename='.\log.txt', level=INFO)
+open('./utils/log.txt', 'w').write('')
+basicConfig(filename='./utils/log.txt', level=INFO)
 
 
 def log(msg: str):
@@ -30,11 +31,11 @@ def checkOnline():
 
     try:
         get('https://www.twitch.tv/')
-        log('Check online | True')
+        log('? Check online | True')
         isOnline = True
         return True
     except ConnectionError:
-        log('Check online | False')
+        log('? Check online | False')
         isOnline = False
         return False
 
@@ -47,16 +48,30 @@ def getChannelsInfo(channels: list[str], set: bool = False) -> list:
     global CHANNELS
 
     if set:
-        log(f'Settings channels | {channels}')
+        log(f'! Setting data | {channels}')
 
-        usersDataApi = API.getUsers(channels)
-        streamsDataApi = API.getStreams(channels)
+        #? Check available icons
+        if not path.exists('./Icons'): mkdir("./Icons")
+        noIconUsers: list = []
+
+        for channel in channels:
+            if not path.exists(f"./Icons/{channel.lower()}.png"): noIconUsers.append(channel)
+
+        if len(noIconUsers) != 0:
+            noIconUsersDataApi = API.getUsers(noIconUsers)
+            noIconUsersData = [] if noIconUsersDataApi == None else noIconUsersDataApi['data']
+
+            for noIconUser in noIconUsers:
+                userData = getChannelUserData(noIconUsersData, noIconUser)
+                saveIcon(userData['defIcon'], noIconUser)
+
+            log(f"! New Icon for | {noIconUsers}")
 
-        usersData = [] if usersDataApi == None else usersDataApi['data']
+        streamsDataApi = API.getStreams(channels)
         streamsData = [] if streamsDataApi == None else streamsDataApi['data']
 
         for channel in channels:
-            userData = getChannelUserData(usersData, channel)
+            userData = {'display_name': channel, 'defIcon': getIcon(channel)}
             streamData = getChannelStreamData(streamsData, channel)
 
             CHANNELS[channel.lower()] = {
@@ -67,7 +82,7 @@ def getChannelsInfo(channels: list[str], set: bool = False) -> list:
             } # yapf: disable
 
     else:
-        log(f'Updating channels | {channels}')
+        log(f'* Updated data | {channels}')
 
         streamsDataApi = API.getStreams(channels)
         streamsData = [] if streamsDataApi == None else streamsDataApi['data']
@@ -94,7 +109,7 @@ class Twitch:
     _TOKEN: str = ''
 
     def __init__(self, client_id: str, client_secret: str):
-        log('Twitch initialization')
+        log('! Twitch initialization')
         self._CLIENT_ID = client_id
         self._CLIENT_SECRET = client_secret
         self._newToken()
@@ -224,3 +239,36 @@ def getGrayImage(b64Image: str) -> str | None:
     imgGrayB64 = b64encode(buffered.getvalue()).decode('ascii')
 
     return imgGrayB64
+
+
+    # b64Image = userData['defIcon']
+def saveIcon(b64Image: str, channel: str) -> None:
+    if not path.exists('./Icons'): mkdir("./Icons")
+    if b64Image == None: return
+
+    with open(f"./Icons/{channel.lower()}.png", "wb") as icon:
+        #? Convert to byte
+        imgBytes = b64decode(b64Image)
+
+        #? Convert to Image object
+        imgDef = Image.open(BytesIO(imgBytes))
+
+        #? Convert to PNG
+        buffered = BytesIO()
+        imgDef.save(buffered, format="PNG")
+
+        icon.write(buffered.getvalue())
+
+
+def getIcon(channel: str) -> str | None:
+    if not path.exists(f"./Icons/{channel.lower()}.png"): return None
+
+    #? Convert to Image object
+    imgDef = Image.open(f"./Icons/{channel.lower()}.png")
+
+    #? Convert to B64
+    buffered = BytesIO()
+    imgDef.save(buffered, format="PNG")
+    imgB64 = b64encode(buffered.getvalue()).decode('ascii')
+
+    return imgB64