Giter Site home page Giter Site logo

sherpic / node-steam-bot-manager Goto Github PK

View Code? Open in Web Editor NEW

This project forked from sameralsayegh/node-steam-bot-manager

0.0 2.0 0.0 488 KB

A NodeJS Steam Community Bot Management tool.

License: Apache License 2.0

JavaScript 27.36% HTML 68.08% CSS 4.56%

node-steam-bot-manager's Introduction

About

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

npm version

forthebadge forthebadge

Demo:

Check out www.csgospin.win for a demo of the bot in action using a custom built handler.

To showcase a demo of your use, pm Undeadkillz on Steam or Github with your website using this bot.

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
  • Custom handler for your usage (Customize the actions of the bot)

TODO:

  • Add registration account checking
  • Add further error handling

Set-up

Prerequisites:

  • NodeJS
  • npm

Install and run (using Example bot):

NPM

Using npm:

npm i node-steam-bot-manager --save

Copy 'InventoryBot.js' found in 'examples' folder. Link to raw-file

node InventoryBot.js # Run the example bot

That's it! If you encounter issues, just post in 'Issues' or contact me on Steam (link below)

How to run 24/7 (Linux - using Example bot)

  • '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
  • Enter the password of the bot
  • Main menu will appear with new bot which is navigated using arrow keys.

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
  • 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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.