Package Exports
- steam-groups
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 (steam-groups) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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 steam-groups
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
MIT. See LICENSE
.