GithubHelp home page GithubHelp logo

narugo / node-steam-groups Goto Github PK

View Code? Open in Web Editor NEW

This project forked from scholtzm/node-steam-groups

0.0 2.0 1.0 140 KB

node-steam extension which adds group functions

License: MIT License

node-steam-groups's Introduction

Steam Groups for node-steam

This is a tiny node.js module which allows user to extend node-steam to support group functions. This module therefore fully depends on node-steam.

Installation

npm install git://github.com/scholtzm/node-steam-groups.git

Usage

Firstly, require steam module ...

var Steam = require('steam');

After that, simply extend Steam variable with steam-groups ...

require('steam-groups')(Steam);

That's it. You can now use additional group functions.

Functions

groupInvite(steamIdGroup, steamIdInvited)

Invite user steamIdInvited to group steamIdGroup. steamIdGroup has to be in groupID64 format.

Example of groupID64 can be found here.

acceptGroup(steamIdGroup)

Accept group invite. This can be used in conjuntion with node-steam's group event.

declineGroup(steamIdGroup)

Decline group invite. This can be used in conjuntion with node-steam's group event.

Example

// Require node-steam first
var Steam = require('steam');

// Extend node-steam with group functions
require('steam-groups')(Steam);

// Create new SteamClient object
var client = new Steam.SteamClient();

// Call logOn and add additional code here ...

// This will work
client.on('group', function(steamID, relationship) {
    if(relationship === Steam.EClanRelationship.Invited) {
        client.acceptGroup(steamID);
    }
});

Disclaimer

node-steam is port of SteamKit2, which does not support group functions. Automating group functionalities might be against Steam's EULA. There are many people who run trading bots and automate this process, but remember that you are using this at your own risk.

License

See LICENSE.

node-steam-groups's People

Contributors

scholtzm avatar

Watchers

 avatar  avatar

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.