Interactive console application for TS3 server administration, featuring front-and-back-end operation of most aspects.
Syntax notes:
- Any command with multiple syntaxes will allow any of those listed.
- Parameters with [brackets] are required, and can be any valid value.
- Parameters with <angled_brackets> are required, and can only be one of the values denoted
within, separated by a pipe. Example:
<on | off> - Parameters with (parentheses) are optional.
- Do not include the brackets or parentheses when calling the command.
Grant clients the ability to use certain levels of commands, or prevent them from using commands altogether by adding them to a controlled server group. Groups can be used as an access group by adding the group ID to the ServerGroupAccessConfiguration.yaml file.
Example Configuration for Groups:
owner-groups:
- 10101
super-admin-groups:
admin-groups:
- 10102
- 10103
moderator-groups:
sponsor-groups:
- 10110
blacklisted-groups:
- 10104
- 10105
- 10106Establish a set time in minutes before idle users are automatically moved to a designated channel. Users can be exempt from the check by being added to one of the groups listed as an ignore
group in the IdleChecker.yaml file. IdleChecker must be restarted for config changes to take
effect if changes are made to the file while it is running.
For control information, see Idle Checker.
Example Configuration for Idle Checker:
idle-max-time-minutes: 60
idle-destination-channel: 90210
idle-ignore-groups:
- 10101
- 10102
- 10103Minimum Permission Level: Admin
Dual-side support for controlling whether or not the bot will check for (and move) idle users.
For configuration information, see Idle Checker Configuration.
Syntax: !idlechecker <enable | disable>
Use: Enables or disables the IdleChecker functionality. When enabled, users will be moved to
the designated idle channel after a certain threshold of time.
Syntax: !idlechecker, !idlechecker status
Use: Displays whether or not Idle Checker is running. If it is running, this command also displays the threshold at which time users will be moved, and the name of the channel to which the idle user will be moved.
Dual-side support for forced disconnects of connected clients.
Minimum Permission Level: Moderator
Syntax: !kick [clientId] [reason]
Use: Kicks the client matching the clientId from the server with the provided reason.
Dual-side support for forced disconnect of connected clients.
Minimum Permission Level: Moderator
Syntax: !userinfo (query)
Use: Retrieves information about users whose names the query partially matches. Special query @me retrieves information about the user who called the command. Failing to provide a query results in all online users being returned.
Server-side support for moving the bot to the caller's channel.
Minimum Permission Level: Default
Syntax: !comehere
Use: Moves the query bot to the channel of the user who issued the command. Upon success, the bot will announce itself within channel chat.
Dual-side support for "Dad Mode" controls.
Minimum Permission Level: Moderator
Syntax: !dadmode <enable | disable>
Use: Enables or disables DadMode functionality. When enabled, the bot will automatically respond to messages along the lines of "I'm {X}" with "Hi, {X}. I'm dad!"
Dual-side support for simple bot health-check by having it return a simple phrase when pinged.
Minimum Permission Level: Default
Syntax: !ping
Use: Elicits a basic response ("Pong!") from the bot to function as a basic health check or open a line of communication with the query.
Provide a way to easily manage idle users by either messaging, moving, or kicking after a specified threshold.
Allow the bot to assign roles to users who match certain criteria. More info TBD.
Remote and back-end support for moving players between channels.
Remote and back-end support for banning players from the server.
Remote and back-end support for temporarily confining players to a channel.
Remote and back-end support for sending messages to the server.
Remote and back-end support for sending messages to one or many individual channels.
Remote and back-end support for privately messaging a single user.
Remote and back-end support for privately messaging group of users.
Remote and back-end support for poking a user.