Forge-Media / teamspeak-bot

Jarvis is an extensible Teamspeak 3 bot written in Javascript. Can be extended by building your own plugins! Now with Slack integration!
https://forge-media.github.io/teamspeak-bot/
Mozilla Public License 2.0
3 stars 1 forks source link
es7-javascript javascript node nodejs promises raw slack slack-bot ssh teamspeak teamspeak-query teamspeak3 teamspeak3-bot ts3

Jarvis Teamspeak-3 Bot

GitHub package.json version Libraries.io dependency status for GitHub repo Maintainability GitHub code size in bytes

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

Included Plugin Commands

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:

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:

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

This work is licensed under a Mozilla Public License 2.0