beatyt / jankbot

A Steam bot for Dota 2 communities

Jankbot

A Steam chat bot, built for Dota 2, made for everyone!

Current version: 3.2.0

Maintained by @twisterghost

Table of Contents

1. Introduction
2. Installation
3. Running Jankbot
4. Adding Modules
5. Administrating Your Jankbot
6. FAQ
7. For Developers
8. Module API

Introduction

Jankbot is an open source module-oriented Steam bot designed to help organize player communities. The system is open for use and devleoped with scale in mind so that any size group can make use of it. Jankbot is designed with Dota 2 in mind, but any gaming community should find him to be a major asset to their group.

The Jankbot project is rapidly developing and is very welcome to pull requests.

Installation

As of version 3.0.0, Jankbot is natively able to run on Window, Linux and OSX.

In-depth installation instructions

Installation TL;DR

Please be sure you understand what you're doing if you use this summary!

1. Install NodeJS 4.2.* LTS
2. Make a steam account with at least one purchase on it
3. Download Jankbot's latest release
4. Unzip it to a folder
5. Open that folder in a terminal
6. Run npm install --production
7. Run npm run config and follow the prompt

Running Jankbot

Once you have installed and configured Jankbot and you have a Steam account ready to go with at least one purchase, you are READY TO RUN JANKBOT, WOOHOO!

To run Jankbot: npm start

And that's it! Jankbot should now log in to steam and accept friend requests. Simply add him as you would another user and he will add you back, ready to help improve your community!

Adding Modules

Jankbot is designed to use custom modules to extend his abilities. Jankbot modules can be installed via npm, the node package manager. Published Jankbot modules should use the naming scheme jankbot-MODULENAME, so you can search npm's registry for Jankbot modules to install.

Legacy Modules

To add a legacy module (a module not found on npm, designed before Jankbot 2.1.0), place the module source folder in the bot_modules/ directory. Jankbot will load the module next time you run the program.

JankDota Jankbot Modules

We have a collection of modules you can add immediately at the Jankbot Modules Repository on GitHub.

Administrating Your Jankbot

See Administrating Your Jankbot in the Jankbot Wiki.

FAQ

I'm getting errors when Jankbot attempts to log in, why?

Be sure you have disabled Steam Guard on the account you want to use Jankbot with. Steam Guard is the two-factor authentication system that helps to prevent unauthorized logins, but Jankbot is not able to handle this, because it requires you to enter a code sent to your email address.

Why won't Jankbot accept friend requests?

You need to be sure that the account Jankbot is using has full permissions. You must make at least 1 transaction on the account to make use of friends lists.

How do I add Jankbot modules?

Starting with Jankbot v2.1.0, you can add modules to Jankbot using npm. NPM is a database of Node.js packages. Included among them are Jankbot modules. Jankbot modules are prefixed with jankbot-, so you can search npm for Jankbot modules and run npm install jankbot-some-module to install the module.

For older versions of Jankbot, simply download the module and place the folder inside of Jankbot's bot_modules/ directory. Jankbot will auto-discover modules on startup.

How do I keep Jankbot running after I close the terminal?

You may want to look into pm2. It is a handy program manager that will keep it running in the background.

How do I update Jankbot?

Updating Jankbot is as simple as replacing the files. Just make sure you don't delete or overwrite any module data files like friendslist. Soon enough a patch system will be put in place and Jankbot will be able to update himself. Remember that you will need to restart Jankbot after updating.

Why is Jankbot a 'he'?

By all means, refer to Jankbot as Jankettebot. Just feels easier saying 'he' instead of 'it' or 'Jankbot' all the time.

I'm still having trouble. How can I get help?

Tons of ways! You can email the head developer at [email protected], tweet @JankDota, send a reddit message to /u/twisterghost, or if you think it is a problem with the code, open an issue right here on GitHub.

Trello

Jankbot has a public Trello page where you can see what is being worked on and what is being released next. If you have a Trello account, you can even vote on cards to weigh in on what should be done next.

For Developers

Jankbot is an open source project far more than open to pull requests. If you are a developer and wish to contribute, code review, fix a bug or whatever, please join in! We can only do so much alone, but together Jankbot can be strong!

Module API

See The Module API on the Jankbot Wiki for documentation on creating your own custom modules.

Contributing

If you would like to contribute to the Jankbot project on GitHub, fork this repo and send pull requests. We are more than happy to review and add changes.

You may also feel free to add yourself to the contributors file.