JSPM

  • Created
  • Published
  • Downloads 70
  • Score
    100M100P100Q66163F
  • License ISC

A NodeJS Steam Bot Management tool.

Package Exports

  • node-steam-bot-manager

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (node-steam-bot-manager) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

About

A bot management tool for Steam Community built using NodeJS backend.

forthebadge forthebadge

Demo:

TODO: None available yet.

Examples:

You can check examples of bots you can build by navigating to the 'examples' folder in the root of the project.

Features:

  • GUI-based
  • Talk to people on the Bot's friends list
  • Trade with people on the Bot's friends list.
  • Set-up 2-factor-authentication (including the phone-number if not yet on account)
  • Handle API sign-up process*
  • Manage multiple bots at once
  • API system
  • Plugin-capable (Customize the actions of the bot)

TODO:

  • Add registration account checking

Set-up

Prerequisites:

  • NodeJS
  • npm

Install and run:

Using clone/git:

git clone https://github.com/Undeadkillz/node-steam-bot-manager # Clone the repo
cd node-steam-bot-manager # Change directory to the cloned repo
npm install # Installs all libraries required
chmod -R 777 examples/config # Make the config folder accessible for edits
cd examples # Change directory to examples folder
node InventoryBot.js # Run the example bot

Using npm:

How to run 24/7 (Linux)

  • 'yum install screen' or 'apt-get install screen' (Use based on your distro)
  • Create a 'server.sh' file wherever the bot you would like to run is (ex. InventoryBot.js) and paste the following:
#!/bin/bash
screen -dmLS BotManager node InventoryBot.js
  • Make sure permissions are set appropriately
chmod 755 server.sh
  • Finally, just run the script with
./server.sh
  • You may then access it, by typing 'screen -x BotManager'

Configuration:

On first run, a config file will be be generated using the template file. Simply close the bot and edit the config.json

Once completed, you may run the bot again with the changes taking effect.


Registering a Bot:

  • Choose 'register' option from main menu (use arrow keys to navigate the menu)
  • Enter the username of the bot [The credentials are not yet checked, so be sure of the credentials.]
  • Enter the password of the bot [The credentials are not yet checked, so be sure of the credentials.]
  • Main menu will appear with new bot.
  • Use arrow keys to choose the bot you want to manage.

Libraries used:

How to contribute:

git clone https://github.com/Undeadkillz/node-steam-bot-manager # Clone project files locally
node install # To install the tool and dependancies

The project is still in early stages, and any feedback or contribution is appreciated.

To contribute:

Simply make your desired changes and submit your pull request. At this point, there is no specific format you have to follow, just make sure the code is easily readable, and if possible comment where possible so that the pull request could be approved faster.

To help:

Install the tool, and try out the different examples or even build your own, and try to break the tool. Once you break it, just make sure to inform us via the ISSUES pages, about the issue.

Make sure to atleast include a log of the error message and if possible inform us about the steps to reproduce the issue.

Testing Policy

forthebadge

I will ensure everything works, however I won't be building any unit-tests at this time.


Credits:

  • Undeadkillz | Add me on: Steam - Skype
  • All authors and helpers of the libraries listed above (with their respective library urls)

forthebadge forthebadge

* Using this feature means you agree to Steam's API terms found at: Steam API Terms