https://github.com/2called-chaos/ts3r

A little framework to build teamspeak 3 bots.
https://github.com/2called-chaos/ts3r

Last synced: 2 months ago
JSON representation

A little framework to build teamspeak 3 bots.

• Host: GitHub
• URL: https://github.com/2called-chaos/ts3r
• Owner: 2called-chaos
• License: mit
• Created: 2014-05-20T00:31:21.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-05-21T05:28:40.000Z (over 10 years ago)
• Last Synced: 2024-10-14T13:47:33.855Z (3 months ago)
• Language: Ruby
• Size: 258 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Ts3r

A little framework to build teamspeak 3 bots.

## Requirements

- Ruby >= 1.9.3

- Git

- [bundler](http://bundler.io) gem

- TeamSpeak 3 server

## Important

You'll need to add the IP address of this bot to the TeamSpeak 3 server query_ip_whitelist.txt or the anti-spam feature will ban the bot every other minute.

## Installation

Choose and change to a directory in which you want to install the bot. You may want to run the bot under another user.

    su - teamspeak

    cd /home/teamspeak

    git clone https://github.com/2called-chaos/ts3r.git

    cd ts3r

    bundle install

You may also want to add the `bin` directory to your path:

    PATH=/home/teamspeak/ts3r/bin:$PATH

    export PATH

## Configuration

We are lacking a bit of documentation here but there are quite a few examples in the configuration directory.

For the most part this [Docu PDF of hell](http://media.teamspeak.com/ts3_literature/TeamSpeak%203%20Server%20Query%20Manual.pdf) will help you a lot.

You will need to copy and modify the example configuration

    cp config/bot.rb.example config/bot.rb

    vim config/bot.rb

## Usage

After editing the configuration you can start the bot with

    ts3rd start

or if you want to debug start it attached to the terminal with

    ts3r

## Contributing

1. Fork it ( http://github.com/2called-chaos/ts3r/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request