https://github.com/0xdaksh/idler

Easy Idling for your Steam Account with Node.js
https://github.com/0xdaksh/idler

idle idler master nodejs steam steam-idler

Last synced: 5 days ago
JSON representation

Easy Idling for your Steam Account with Node.js

• Host: GitHub
• URL: https://github.com/0xdaksh/idler
• Owner: 0xDaksh
• License: mit
• Created: 2017-08-04T15:50:49.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-08-11T08:47:54.000Z (over 7 years ago)
• Last Synced: 2024-11-29T12:11:42.685Z (2 months ago)
• Topics: idle, idler, master, nodejs, steam, steam-idler
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/idler
• Size: 29.3 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
## Easy Idling for your Steam Account with Node.js

[![Build Status](https://travis-ci.org/DakshMiglani/Idler.svg?branch=master)](https://travis-ci.org/DakshMiglani/Idler)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/DakshMiglani/Idler/master/LICENSE.md)

[![npm version](https://badge.fury.io/js/idler.png)](https://badge.fury.io/js/idler)

> Idle Your Steam Account Easily.

### Possible Login Types

- twoFactorCode (your steam account shared secret)

- authCode (your steam account auth code)

- Manual (this would prompt for steamGuard Code on the terminal)

### Idler Class Parameters

- Username (Mandatory)

- Password (Mandatory)

- gameId (Mandatory)

- Method Object (Can have any of the three following values)

    - twoFactorCode

        - value (your shared secret)

    - authCode

        - value (your email auth code)

    - Manual (this would prompt for steamGuard Code on the terminal)

### How to Use?

```javascript

var Idler = require('idler');

var user = new Idler('username', 'password', 'gameId', {method: 'twoFactorCode', value: 'YourSharedSecret'})

user.idle().then(User => {

    // on login it would send the User Object

}).catch(err => {

    // on err it would send the Err Object

    throw err;

})

```

## License

Copyright to [Daksh Miglani](https://dak.sh) | Licensed to MIT.