Skip to content

Releases: PatchaIT/greetings

Greetings_v2.2.0

10 Dec 19:39
@PatchaIT PatchaIT
v2.2.0
aea20da
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
Greetings_v2.2.0 Latest
Latest

development status | 5 - Production
code style: pep-008
license
release

Greetings

(On your Streamlabs Chatbot) Greet new viewers by playing a sound and/or a text message when they write in chat for the first time each session. Can also be used to play sounds when users send additional messages.

Table of Contents

About The Project

Hi all,
this script is mainly dedicated to streamers with low chat activity.

It just produces a sound and writes a greetings message when somebody
sends his first message in chat, for current session.

Additionally, it can also reproduce another sound each time somebody
writes again in chat, to get the streamer's attention on chat activity.

Anyway you can disable one or all sounds, so it would only greet
textually for first user's message in chat.

Enjoy.

Warning Notes

Note:
If you're updating from a previous 1.x version to new 2.x versions,
they have no code retrocompatibility at all, so I suggest to:

  1. note all settings from old version
  2. completely delete old version
  3. put new version
  4. apply settings noted from old version

Note:
If you're updating from a previous 2.x version,
you may have to delete old "lib" directory before update,
because all new releases use new lib versions.

Note for Save Settings:
Sometimes Streamlabs Chatbot doesn't trigger ReloadSettings method on new
settings save from Save Settings GUI button.

If you can't hear TTS say the Configuration updated successfully sentence
(by default Configuration updated successfully) probably new settings
are saved, but you can't be sure if they're already reloaded and applied
into current Chatbot session.

In this case I'd suggest you to shut down and restart the Chatbot,
or at least to refresh scripts from Scripts screen (the circle arrow icon
on the top right).
After that, make some checks to see if new settings are actually applied.

Anyway, after every Chatbot start or reboot, I always suggest to refresh
scripts at least once.

In Shorts

  • Script: Greetings
  • Version: 2.2.0
  • Description: Greet new viewers by playing a sound and/or a text
    message when they write in chat for the first time each session.
    Can also be used to play sounds when users send additional messages.
  • Change: Fixed issue with sometimes custom settings not correctly
    loaded
    Script should no more work on whispers
  • Services: Twitch, Youtube
  • Overlays: None
  • Made By: @Patcha_it
  • Update Date: 2023/11/25

Changelog

  • 2018/05/01 v1.0.0
    • Initial Release
  • 2018/05/01 v1.1.0
    • Fixed compatibility with Mixer and Youtube
  • 2018/10/05 v1.2.0
    • Added option for Text To Speach feature to read writer's nickname
  • 2018/14/12 v1.2.1
    • Now TTS nick black list filter is case-insensitive
  • 2018/17/12 v1.2.2
    • Now you can filter nicknames not to greet neither textually
      (aka: your own bots)
  • 2019/04/07 v1.3.0
    • Now you can set a different sentence for VIP, subriscribers
      and moderators
  • 2021/12/06 v1.4.1
    • Now you can filter nicknames to not check their messages
      and play no sound (aka: your own bots)
  • 2021/12/06 v1.4.2
    • Fixed youtube name showing
  • 2021/12/06 v1.4.3
    • Hidden the whole old TTS setting stuff, looking for a new
      working TTS server
  • 2021/12/08 v1.4.4
    • Hotfixes thank to Castorr91
  • 2022/02/09 v1.5.0
    • Now you can filter message by starting characters or words
      (i.e.: ! for chat commands)
  • 2022/02/16 v1.5.1
    • Fixed typo on Ignore messages starting by splitter character
      (was comma, have to be space)
  • 2022/08/05 v1.5.2
    • Fixed volume setting for sounds
  • 2023/07/29 v2.0.0 -
    • TTS Functions restored, enhanced and tweaked
      (original code from LuisSanchezDev's The NewTTS script,
      recently reworked by me as The ReNewTTS script)
    • Settings section with fields to totally customize greetings
      details per specific users
    • Minor fixes and tweaks
    • Adopting file organization in subfolders
    • NOTE: There's no retrocompatibility with old 1.x versions
      You'll have to delete old versions first
      (while noting old settings)
  • 2023/10/02 v2.0.1
    • Wrong default files into .zip distribution
  • 2023/10/21 v2.1.0
    • Fixed blocking no default for Character series to swap option
      when options were still not saved
    • Fixed empty Users not to greet + Blacklisted words option was
      resulting like not greeting anybody at all
  • 2023/11/25 v2.2.0
    • Fixed issue with sometimes custom settings not correctly loaded
    • Script should no more work on whispers
    • Thanks Chidinma for testing!

PS:
Thanks @Castorr91 for some fixes suggestion. ;)

Getting Started

Prerequisites

Have an installation of Streamlabs Chatbot, already logged in to your accounts.

Follow this tutorial to prepare your Streamlabs Chatbot installation to accept scripts.

Installation

  1. Download the latest version of the script.
  2. If you haven't already, open your Streamlabs Chatbot and log in to your Streamer and Bot accounts.
  3. On the left side, wait for the Scripts tab to pop up and click it.
  4. On the top right corner of the window, next to the reload button is an import script button (Arrow pointing right to a box) and select the script downloaded before.
  5. You will receive a message box confirming the import, accept it.
  6. The window will update and show the Greetings script.
  7. Click on the Greetings name to see the configuration pane.

Usage

Vip, Subscriber, Moderator Message

You can customize greeting message distinguishing between moderators,
subscribers and VIPs.

Note:
Priority levels are moderator -> subscriber -> VIP -> everyone.
Which means if your moderator is also subscriber, he'll still have
moderator's message; or if your subscriber is also VIP, he'll still
have subscriber's message, and so on.

Ignore Starting By

  (Don't greet messages starting by)

If your chat uses often messages starting by some characters or words,
like chat minigames, commands or emotes, you can filter those message,
by listing sequences of characters, and seaparte each sequence with a space.

If you also want to filter them for New message audio function, just list
them the same way into the Ignore messages starting by field.

Note: spaces cannot be set into character sequences, because they're used
as separators.

Alias

If you want some users to be named with a different name, you can set an
alias for each of them.

Just use this format to apply it:

TwitchNickName:Alias

(note: should work also for Youtube nicknames)

For every user you can set an alias, use semicolon to separate them:

AnUserNickName:HisAlias;AnotherUserNickName:AnotherAlias

You can use spaces and punctuation in aliases,
except colon and semicolon.

Do Not Greet

  (Users not to greet)

If you have bots or other users you don't want to greet on chat, just
list their nick separated by commas, into field
Users not to greet + Blacklisted words.

Into this same field, you can also filter black listed words to prevent
sudden inopportune nicknames to be greeted by the script.
You can use plus simbol + between two words meaning any character between them like: Bad+Word would filter both BadWord and BadDamnWord.

If you also want to filter them for New message audio function, when
they write a new message in chat, just list them also into the field
Users not to check messages.
You find it into Chat message sound settings section.
Only Twitch or Youtube nicknames can be listed there, no words.

Greetings Audio

You can disable audio by writing no file name (empty field) on field
Greeting audio, or set Volume greeting audio to zero.

You can also personalize your sounds to play a different file, editing
Greeting audio field.

Note:
If the file is not located into script's audio subfolder or
script's folder itself, please use its absolute path.

Note:
Audio files have to be in mp3 format.

New Message Audio

  (After First Message)

It works same identical way as greeing audio, except it's setting
field is named New message audio, it's volume settings is
Volume new message audio and ...

Read more
Assets 3
Loading

Greetings_v1.5.2

22 Nov 18:56
@PatchaIT PatchaIT
v1.5.2
9546a0e
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
Greetings_v1.5.2

development status | 7 - Inactive
code style: pep-008
license
release
version

Greetings

(On your Streamlabs Chatbot) Produces a sound and writes a greetings message when somebody sends his first message in chat, for current session.

Table of Contents

About The Project

Hi all,
this script is mainly created for early streamers with low chat activity.

It just produces a sound and writes a greetings message when somebody sends his
first message in chat, for current session.

Additionally, it can also reproduce another sound each time somebody writes
again in chat.

Anyway you can disable one or all sounds, so it would only greet textually
for first message in chat.

Enjoy.

Warning Note

If you're updating for a previous versions, after loading Chatbot and
all scripts, do as follows:

  1. if you can't find Greetings anymore, go to script folder (right click
    on a script + click Open Script Folder + open Greetings folder) and
    backup/delete/rename these files: settings.js and settings.json
    (they are your current config files)
  2. click refresh script buttons (two cicle arros icon, the first on top
    right), click on Greetings script and save again settings (even if you
    didnt' change them). This would recreate settings.js and settings.json
    files with new options included.
  3. I suggest to refresh scripts again.

In Shorts

  • Script: Greetings
  • Version: 1.5.2
  • Description: Produces a greetings sound and message when somebody write first
    time in a session. It can reproduce another sound each time somebody writes
    again in chat. Sounds can still be disabled, to just greet textually for first
    message in chat.
  • Change: Fixed volume setting for sounds.
  • Services: Twitch, Youtube
  • Overlays: None
  • Made By: @Patcha_it
  • Update Date: 2022/08/05

Changelog

  • 2018/05/01 v1.0.0
    • Initial Release
  • 2018/05/01 v1.1.0
    • Fixed compatibility with Mixer and Youtube
  • 2018/10/05 v1.2.0
    • Added option for Text To Speach feature to read writer's nickname
  • 2018/14/12 v1.2.1
    • Now TTS nick black list filter is case-insensitive
  • 2018/17/12 v1.2.2
    • Now you can filter nicknames not to greet neither textually
      (aka: your own bots)
  • 2019/04/07 v1.3.0
    • Now you can set a different sentence for VIP, subriscribers and moderators
  • 2021/12/06 v1.4.1
    • Now you can filter nicknames to not check their messages and play no sound
      (aka: your own bots)
  • 2021/12/06 v1.4.2
    • Fixed youtube name showing
  • 2021/12/06 v1.4.3
    • Hidden the whole text to speach setting stuff, looking for a new working TTS server
  • 2021/12/08 v1.4.4
    • Hotfixes thank to Castorr91
  • 2022/02/09 v1.5.0
    • Now you can filter message by starting characters or words
      (i.e.: ! for chat commands)
  • 2022/02/16 v1.5.1
    • Fixed typo on "Ignore messages starting by" splitter character
      (was comma, have to be space)
  • 2022/08/05 v1.5.2
    • Fixed volume setting for sounds

PS:
Thanks @Castorr91 for some fixes suggestion. ;)

Getting Started

Prerequisites

Have an installation of Streamlabs Chatbot, already logged in to your accounts.

Follow this tutorial to prepare your Streamlabs Chatbot installation to accept scripts.

Installation

  1. Download the latest version of the script.
  2. If you haven't already, open your Streamlabs Chatbot and log in to your Streamer and Bot accounts.
  3. On the left side, wait for the Scripts tab to pop up and click it.
  4. On the top right corner of the window, next to the reload button is an import script button (Arrow pointing right to a box) and select the script downloaded before.
  5. You will receive a message box confirming the import, accept it.
  6. The window will update and show the Greetings script.
  7. Click on the Greetings name to see the configuration pane.

Usage

Vip, Subscriber, Moderator Message

You can personalize that message distinguishing between moderators, VIPs
and subscribers.

Note: priority levels are moderator -> subscriber -> VIP -> everyone.
Which means if your moderator is also subscriber, he'll still have moderator
message; or if your subscriber is also VIP, he'll still have subscriber
message, and so on.

Do Not Greet

  (Users not to greet)

If you have bots or other users you don't want to greet on chat, just list
their nick separated by commas, into Users not to greet field.

If you also want to filter them for New message audio function, just list
them the same way into the Users not to check messages field.

Ignore Starting By

  (Don't greet messages starting by)

If your chat uses often messages starting by some characters or words,
like chat minigames, commands or emotes, you can filter those message,
by listing sequences of characters, and seaparte each sequence with a space.

If you also want to filter them for New message audio function, just list
them the same way into the Ignore messages starting by field.

Note: spaces cannot be set into character sequences, because they're used
as separators.

Greetings Audio

You can disable audio by writing no file name (empty field) on Greeting audio
or set Volume greeting audio to zero.

You can also personalize your sounds to play a different file, by editing
Greeting audio field. If file is not located into script's folder,
please use an absolute path.

Audio files have to be in mp3 format.

New Message Audio

  (After First Message)

It works same identical way as greeing audio, except it's file path field
is named New message audio and it's volume is Volume new message audio.

Assets 3
Loading