Jarvis Teamspeak-3 Bot

This project was made possible by TS3-NodeJS-Library, special thanks to Multivit4min!

Included Plugin Commands

• !registerLOL <Summoner Name> <Region> <Queue Type>|!deregisterLOL|!statusLOL - Registers a user's League ID to obtain their LoL Rank as a server group. Can check status and deregister.
• !registerCSGO <Steam64id>|!deregisterCSGO|!statusCSGO - Registers a user's Steam ID to obtain their CSGO Rank as a server group. Can check status and deregister.
• !createClan - A simplified CLI-style mass-channel creator for the creation of clan channels and an associative server group. Sets permissions and properties of each channel automatically.
• !joinMe <userName> - Requests another user to join your channel, independent of a user's permissions. Client moved if they accept.
• !purgeVerified - Used to remove all users in a set Server Group which are not listed in Steam-TS's Verified Database File.
• !cid - Returns a message containing the channel ID of the channel the client is in.
• !help - Provides bot help and available command list

Install

Make sure you have Node.js installed. Clone this GitHub repository to your environment:

$ mkdir jarvis-bot
$ git clone https://github.com/Forge-Media/teamspeak-bot.git jarvis-bot
$ cd jarvis-bot

Install the bot via npm:

$ npm install

Jarvis Configuration

Make sure you've renamed config.example.js to config.js before starting the bot, followed by adding your server query connection details, so that it can connect to your Teamspeak 3 server.

Edit the following configuration files:

• config.js
• /plugins/PluginName.js config settings

More documentation on setting up plugins below!

Run Jarvis

Standard method

After edited all config settings, run the following command to launch the bot:

$ npm run jarvis

PM2 method

I recommend using PM2 to run the bot, PM2 is an excellent Production Runtime and Process Manager for Node.js applications. It allows you to keep applications alive forever:

$ pm2 start app.js --name Jarvis

Setup Plugins

The following plugin's require configuration to be used, see these links to the wiki for help:

• !createClan - How to setup the !createClan plugin?
• !joinMe <userName> - How to setup the !joinMe plugin?
• !purgeVerified - How to setup the !purgeVerified plugin? Requires: steam-ts!

Development

Please report any bugs you encounter! If you'd like to improve this project feel free to start a pull request, it will be reviewed as fast as possible.

Support

You can get support by either going to the issues page or taking a look at the Jarvis documentation which explains how the bot's code works: Jarvis Documentation

Change Logs

Please see releases

Authors

• Jeremy Paton (Development and Documentation)
• Marc Berman (Assistance and testing)

This work is licensed under a Mozilla Public License 2.0