BBF's Ranked Society
Author: bbftest
Description Source Code Launch Bot Current Users

Short Description:

A universal, customizable Crew Bot to manage users in groups in your room

Full Description

The Ranked Society Bot allows you to sort your Users into groups, depending on their tips.

It offers 6 different Ranks, from an appointed (by the broadcaster) Friend-Rank, 4 different ranks (automatically appointed by tipping) to the High Tip King, the highest tipper you had.

The Ranked Society adds two Custom Fan Clubs and adds custom Titles to the rank and club members messages.
You can give each user group a custom greeting and select a background color for them.

The Bot keeps track of all tips, shows you a tip scoreboard (all tips), announces the top X tippers (public) and can add their tips from today to the titles.

You can disable Greys ability to use Emotes and ban User completely from your room.

It can allow Mods to use commands, configure 2 custom notifications with selectable time delay, send a notice to all mods (in the normal chat tab instead of the PM tab) and allow them to send a private notice to you the same way.

The Ranked Society is based on ideas of tablesalt90's crew bots, thanks to him, but it is a massive rewrite, made for paolaturbay_v, but usable for all broadcasters!

##### Version History #####


##### Configuration #####


With the names and titles in Ranked Society you can set a theme and tone for your Room. It is preset with the theme of a Kingdom in mind, so the Broadcaster Tag is Queen, the friend rank is called Ally, the others go by Lover, Noble, Prince and King and the High Tip King is called Emperor.

All these Titles are changeable, so for a family theme you could go with buddy, family, lover, fiance, husband, patriarch etc, for ship crew with Deckhand, Sailor, 1. Mate, Captain & Admiral...
Whatever you like, get creative!

In the first section you make basic decisions for your society:
The next section is about the Friend Rank
Friend is the only rank that users can not buy with tokens. It is meant for Users who can't tip much, but are there often and helpful for you in other ways, like being supportive, fun to talk to, keeping unruly greys at bay or however. And here I took the liberty to write myself in, as a reward for the work on this bot ;-)

The next 5 sections are for the next 4 Ranks of your Society and the High Tip King Rank.
All have the same configurations as the friend rank (Tag/Userlist/Background Color), with the addition of Tips needed.
Here you define how much token a user must tip (single tip or accumulated as defined above) to get that rank.
A value of '0' (zero) or below deactivates that rank (including the high tip king feature), as no one can tip that low :-).
If the name of the High Tip King is empty, there is no High tip King so far, and the number of tokens the minimum need to get that rank.

After a show or before the next show you should update the lists to make the ranks earned stick.
There is a function exporting all ranks ('/rs x', discussed below) so you can copy and paste the lists from chat to the configuration here.


The next three sections cover the Fan Clubs:

*** Moderators ***
Moderators are assigned as usual in chat, so no list or token cost here.
But you can assign a Tag for them and a background color.
The chat color of a Moderator is internally changed to red by the bot.

*** Persona Non Grata *** *** List of permanently silenced Users
Here you can insert a list of usernames of people you want permanently silenced/banned.
A moderator can silence a user for only 6 hours.
If a broadcaster kicks/bans a user, that wears off after some time, between 1 days and 2 month, depending on how often that user got banned in the past.
Users listed here as Persona Non Grata (undesireable person) are permanently silenced in public chat and the model gets a notification when one of them enters the room, so they can kick them again!
They loose all their ranks and group affiliations and their internal tip count is set to 0.

##### Use & Commands #####


After starting the Bot it simply does its work of sorting the users into the defined Ranks and groups, greeting them on entrance, coloring their messages and applying them their tags.

Every user in a rank gets the Rank Tag you defined before his message in '[ ]' like this: [ RankName ]
If you activated the 'Show Tips' option his tip amount for the day is added: [ RankName : 123 ]
If 'Show Tips' is active and the user has no rank, only his current tip amount will be displayed: [ 36 ]
Every user has only one rank.

If a user is in a group like CBs Fan Club, the custom Fan Clubs, or is a Moderator he gets a Group Tag.
In the Group Tag all his groups are listed, separated by a '|' like this: [ CB FanClub | Fan Club 1 | Fan Club 2 | Mod ]
This is another good reason to be canny with emotes as group tags.

To control the bot and manage your users there is a set of commands. They all start with /rs to trigger the command, the command itself and one or two parameter. The command is a short word. Most commands can be shortened to 1 or 2 characters (shown in () in the list below:
[username] here gets replaced by the users actual name
[rank] is a shortcut for the rank/group you wish to use. The following shortcuts are legit:
fr = Friend Rank
r1 = Rank 1
r2 = Rank 2
r3 = Rank 3
r4 = Rank 4
htk = High Tip King
fc1 = Custom Fan Club 1
fc2 = Custom Fan Club 2


The Ranked Society Bot is brand new, so most likely there are bugs I haven't found, despite all my testing.
So if there are any questions left, errors found, suggestions to be made or feedback to be given please use the comments here to let me know! I will check here regularly.















© Copyright Chaturbate 2011- 2024. All Rights Reserved.