This guide will give you a detailed information how to configure the script to your needs.
Table of Contents (click to expand)
A good start to configure a script is to understand its functionality. Here are a few small points which are important if you want to set everything up correctly.
- The script checks all users it has to list and their online status right when the script starts to build an initial list that is displayed in the selected channel. After that, different events trigger a new check. Such events are for example: a client joins/leaves, a client switches rooms, a client sets themself to mute/deaf/away.
- Since there is no way of retrieving usernames from offline users, the script stores each user it has to list in a storage so their name and information is also available if the user is not online. This means that a user you want to list has to be online at least once while the bot is running with the script. Important to know is that users are only stored if they are a part of the potential list so you have to add them to any staff group.
- Groups that are set up but don't have any users stored by script are skipped and won't be displayed so there is no empty group section in the staff list.
- Users of a staff group are sorted by their status (online, away, offline) and alphabetically.
- The script detects a lot of misconfiguration and provides standard values. Just make sure to fill out each field marked with (*).
- If there is a severe error that affects the script's functionality, it will be written in the log and the script won't be executed.
- Last but most important thing: the staff groups you list in the configuration are prioritized from top to bottom. A user can only be listed in one group in the staff list. If a user is a member of two groups and both are added to the list, they will only show up in the group which is the lowest in the config.
The first section is all about the general options. You configure every basic aspect of the script here.
Please click the option you want to configure to get more information.
Display-Channel
Details:
- required option | default value: none
- enter the channel id
- you can also select the channel from a dropdown menu if the bot is connected to the TeamSpeak server
Info:
- defines the channel in the TeamSpeak where the list should be displayed in
- it will use the channel description for it
- all other parameters of the channel such as the name, the codec and others are untouched
Clickable-Names
Details:
- optional option | default value:
Yes - select Yes or No
Info:
- defines if usernames in the list should be formatted as hyperlinks
- hyperlink usernames can be used to edit groups, send messages and other actions right from the list
- uses the same menu as when you rightclick a user in TeamSpeak by yourself
- if you choose no, it will just use plain text
Away-Status
Details:
- optional option | default value:
No - select Yes or No
Info:
- defines if the script should check for the away status of users to display it instead of online or offline
- you can configure what counts as away later and also format how it looks like
Advanced Options:
-
the following options are only shown if you activated the away status
Away-Channel
Details:
- optional option | default value:
No - select Yes or No
Info:
- defines whether a user is set to away if they enter the afk-channel
Advanced Options:
-
the following option is only shown if you activated the away channel
AFK-Channel
Details:
- required option | default value: none
- enter the channel id
- you can also select the channel from a dropdown menu if the bot is connected to the TeamSpeak server
Info:
- defines the afk-channel in the TeamSpeak where users that are away normally go
- if a user joins this channel, they will be set to away in the list
Away-Mute
Details:
- optional option | default value:
No - select Yes or No
Info:
- defines if a muted user is counted as away
- deactivated microphone does not count to this
Away-Deaf
Details:
- optional option | default value:
No - select Yes or No
Info:
- defines if a user that set themself to deaf is counted as away
- deactivated speakers do not count to this
- optional option | default value:
The next section is all about how the staff list looks and what should be written into it.
Please click the option you want to configure to get more information.
Custom-Template
Details:
- optional option | default value:
No - select Yes or No
Info:
- this is an advanced option and will change a lot in the script so read carefully
- defines if the script should use a custom template from the config to display the staff list
- if you use the custom template, you can configure every formatting aspect of the staff list yourself
- if you don't use the custom template, the list will be formatted in the default way
- you can still customize the list a bit
- specific strings such as the online, away and offline phrases are still editable
Preview:
-
these two preview images show how the staff list could look like, with and without the custom template
-
as you can see, the custom template offers editing nearly every aspect of the list
with custom template
without custom template
Next up, you should open the section depending on the option you chose for the template as you will have different options for each template.
Custom-Template - Yes
-
all texts you can edit support BB code formatting, that's the same formatting style TeamSpeak uses
-
there is also an editor for it built into TeamSpeak if you edit a channel description and click on the pop-out editor
where do I find the BB code editor
-
the following options will only show up if you selected Yes for the custom template
Username
Details:
- optional option | default value:
[B]%name%[/B] - enter the format a username should have in the list
- available placeholders:
- %name% - the name of the user
Info:
- defines the format of a username and how it's shown in the staff list
- this is only a part of the whole line
- if you want to edit the whole line, you have to configure the User-Line option
- keep in mind that not all BB code formatting works if the usernames are clickable hyperlinks
Online-Phrase
Details:
- optional option | default value:
[COLOR=#00ff00][B]ONLINE[/B][/COLOR] - enter the phrase of the status if the user is online
Info:
- defines the format of the status phrase if the user is online
- this is only a part of the whole line
- if you want to edit the whole line, you have to configure the User-Line option
Away-Phrase
Details:
- optional option | default value:
[COLOR=#c8c8c8][B]AWAY[/B][/COLOR] - enter the phrase of the status if the user is away/afk
- this option is only shown if you selected Yes for the away status
Info:
- defines the format of the status phrase if the user is away/afk
- this is only a part of the whole line
- if you want to edit the whole line, you have to configure the User-Line option
Offline-Phrase
Details:
- optional option | default value:
[COLOR=#ff0000][B]OFFLINE[/B][/COLOR] - enter the phrase of the status if the user is offline
Info:
- defines the format of the status phrase if the user is offline
- this is only a part of the whole line
- if you want to edit the whole line, you have to configure the User-Line option
User-Line
Details:
- optional option | default value:
%name% [COLOR=#aaff00][B]>[/B][/COLOR] %status% - enter the format a whole user line in the staff list should have
- available placeholders:
- %name% - the formatted username from the option Username
- %status% - the formatted online status from the options Phrase-Online, Phrase-Away & Phrase-Offline
- %lb% - a linebreak, same like pressing the Enter-key in a text file
Info:
- defines the format of a user line and how it's shown in the staff list
- this uses the earlier defined phrases as placeholders so it doesn't matter if you formatted them earlier or here but it is recommended to only format once to avoid interference
- this option can be used to align the line or for other options that are then applied to the whole line
- keep in mind that there is always a line break at each end of the user lines to have the next user in the next line
Group-Section
Details:
- optional option | default value:
[center]%group%%lb%%users%____________________[/center] - enter the format a whole group section in the staff list should have
- available placeholders:
- %group% - the formatted group name, you can set this in the staff groups later
- %users% - the formatted user lines from the option User-Line
- %lb% - a linebreak, same like pressing the Enter-key in a text file
Info:
- defines the format of a whole group and how it's shown in the staff list
- this uses the earlier defined phrases as placeholders so it doesn't matter if you formatted them earlier or here but it is recommended to only format once to avoid interference
- this option can be used to align the whole group section or for other options that are then applied to the whole group
- you can also globally format the group name here, specific formats for each group name can be done later in the staff groups
- optional option | default value:
Custom-Template - No
-
all texts you can edit support BB code formatting, that's the same formatting style TeamSpeak uses
-
there also is an editor for it built into TeamSpeak if you edit a channel description and click on the pop-out editor
where do I find the BB code editor
-
the following options will only show up if you selected No for the custom template
Separator
Details:
- optional option | default value:
_______________________________________ - enter the format a separator should have in the list
Info:
- defines the format of a separator and how it's shown in the staff list
- this is attached after each group section so they are separated in the list
Online-Phrase
Details:
- optional option | default value:
[COLOR=#00ff00][B]ONLINE[/B][/COLOR] - enter the phrase of the status if the user is online
Info:
- defines the format of the status phrase if the user is online
- this is attached after the username and a dash to separate the name from the status
Away-Phrase
Details:
- optional option | default value:
[COLOR=#c8c8c8][B]AWAY[/B][/COLOR] - enter the phrase of the status if the user is away/afk
- this option is only shown if you selected Yes for the away status
Info:
- defines the format of the status phrase if the user is away/afk
- this is attached after the username and a dash to separate the name from the status
Offline-Phrase
Details:
- optional option | default value:
[COLOR=#ff0000][B]OFFLINE[/B][/COLOR] - enter the phrase of the status if the user is offline
Info:
- defines the format of the status phrase if the user is offline
- this is attached after the username and a dash to separate the name from the status
- optional option | default value:
The last section is all about the staff groups. You can set individual settings for each group here. These are the groups that are displayed in the staff list.
Please click the option you want to configure to get more information.
ID
Details:
- required option | default value: none
- enter the id of the group you want to have displayed
Info:
- if you don't enter an id of a group or the id does not refer to a valid group, the corresponding staff group will be skipped and not be listed
Name
Details:
- optional option | default value: name of the group
- enter the name of the group in case you want to overwrite the default value
Info:
- if you leave this field empty, the script will use the normal name of the group
- this can be used to format the name for each group individually for example making it more colorful
Clients
Details:
- optional option | default value: none
- enter a list of client uids you want to list in the same section
Info:
- this list does not need the uids of clients that are already members of the main group
- this can be used if you want to list clients in the same section although they don't have the main group
Groups
Details:
- optional option | default value: none
- enter a list of group ids you want to list in the same section
Info:
- this list does not need the id of the main group
- this can be used if you want to list groups in the same section although they don't have the main group
You are done with the configuration now!