Aviator logo

Template by CloudCannon

Getting Started Edit

Overview

Welcome to the Interactive Console (Inco) bot, a general-purpose and server moderation program for TeamSpeak 3! Before logging issues or support requests, please be sure to fully read this documentation.

Download and Setup

Download: 
A fully functional JAR can be downloaded from our project’s GitHub releases (here) with included config templates. Alternatively, you can clone and build the project itself.

Setup:
Configure the connection and access settings. At minimum, ensure each access/permission level has a group, and that your host and login information are correct. Ensure the JAR is in the same folder as the config folder.

Running the Program

Windows: 

Closing the command prompt in which the bot is running will exit the bot program.

  1. Open the folder where you’ve saved the incobot-ts3-<version>.tar contents.
  2. In the address bar where the path is shown, click once on it to highlight all contents. Type cmd and press enter; a command prompt window should open up to your current location.
  3. In the command prompt window, use the following command as appropriate for your IncoBot version: java -jar incobot-ts3-<version>.jar

Ubuntu:

  1. Navigate to the location where you saved the contents of the incobot-ts3-<version>.tar package.
  2. Use java -jar incobot-ts3-<version>.jar to run the bot. (We recommend using a Screen, if you’re not already.)

Configuration Edit

Connection Configuration

Field Required? Input Type Description
instance-name Yes (Eventually) String The instance name of this bot config.
At this time, this field is currently not supported. 
server-address Yes String The address of the server to which this bot should connect.
server-query-port Yes Integer The query port to which your bot will connect. By default, most servers have this as 10011.
virtual-server-id Yes Integer The ID of the virtual server to which the bot is connecting.
server-query-name Yes String The server query name used for authentication.
server-query-password Yes String The server query password used for authentication.
bot-nickname Yes String The display name of the bot.
bot-slow-mode Yes (Eventually) String Whether or not the bot should throttle its message rate to prevent being banned for flooding the query.
At this time, this field is not currently supported.

Access Control List Configuration

Field Required? Input Type Description
owner-groups Yes List of Integers The group IDs of groups containing only bot owners.
super-admin-groups Yes List of Integers The group IDs of groups containing only bot super-admins.
admin-groups Yes List of Integers The group IDs of groups containing only bot admins.
moderator-groups Yes List of Integers The group IDs of groups containing only bot moderators.
sponsor-groups Yes List of Integers The group IDs of groups containing only “sponsors”.
blacklisted-groups Yes List of Integers The group IDs of groups containing only users who are not allowed to use bot commands.

Idle Checker Configuration

Field Required? Input Type Description
idle-max-time-minutes Yes Integer The time in minutes after which a user will be moved if they have been idle for the entire duration.
idle-destination-channel Yes Integer The ID of the channel to which idle users will be moved.
idle-ignore-groups Yes List of Integers The group IDs of groups containing only users who will not be moved for being idle. 
# ==============================================
# ====           META INFORMATION           ====
# ==============================================
# = Information used to identify this bot      =
# =   instance.                                =
# ==============================================

instance-name: 'testInstance'

# ==============================================
# ====        CONNECTION INFORMATION        ====
# ==============================================
# = Information used to initiate the           =
# =   connection to the server.                =
# ==============================================

server-address: 'localhost'
server-query-port: 10011
virtual-server-id: 1

server-query-name: 'serveradmin'
server-query-password: 'ultrasecretpass'

bot-nickname: 'Oh Bot Johnson'
bot-slow-mode: ''

Getting Help Edit

We offer support through the following services:

  • Gitter: https://gitter.im/IncoBot-TS3/Lobby
    • Best for quick responses to general questions about setting up or using the bot, inquiring about existing or upcoming functionality, and questions related to modifying the program code.
  • JIRA
    • Best for alerting us to bugs or requesting new features. If you provide a valid email, you will receive notifications on updates to your ticket.
      • Note: You may have to whitelist “system@jira.somefriggnidiot.com” to receive emails.
    • While our JIRA instance is restricted to contributors only, you may submit a bug report or request a feature by using the “Bug or Request?” button at the top of this page. 
      • Note: You will have to opt to allow insecure content on this page to access the issue logger.
  • GitHub Issues (Unofficially)
    • Requests and questions may be made through the GitHub issue tracker, though might not always be answered by a member of this project.

Dad Mode Edit

Minimum Permission Level: Moderator

Parameters
action
"enable" or "disable"

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!”

enable
on

!dadmode enable

Idle Checker Edit

Minimum Permission Level: Admin

Parameters
action
"enable", "disable", or "status"

Controls aspects of the Idle Checker / Idle Mover functionality. When enabled, users who are idle longer than the designated time threshold will be automatically moved to the specified channel.

!idlechecker
!idlecheck
!idle

!idlechecker enable

Kick Edit

Minimum Permission Level: Moderator

Parameters
clientId
The ID of the client being kicked.
reason
The justification for kicking the client.

Forcefully disconnects a client from the server. 

!kick 42 Because I said so.

Ping Edit

Minimum Permission Level: Default

Elicits a basic response (“Pong!”) from the bot to function as a basic health check or open a line of communication with the query.

!ping

User Information Edit

Minimum Permission Level: Moderator

Parameters
query
String containing a client's nickname, a portion of a client's nickname, or a special query.

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.

@me (Returns information about the caller only.)

!userinfo TeamSpeak User