Giter Club home page Giter Club logo

steam-boy's Introduction

Steam-Boy

Get all details related to your steam account be it normal user stats, list of games owned, achievements in a game, etc on your terminal window with a single 2 word command instead of going to different tabs on the steam website or desktop app.

contributions welcome

Requirements (Prerequisites)

Tools and packages required to successfully install this project.

Installation

A step by step list of commands / guide that informs how to install an instance of this project.

For Windows

git clone https://github.com/ishaan5199/steam-boy.git

cd steam-boy

npm i


If you want to use the application globally from any directory
npm install -g

Usage

Navigate to package.json file and place your steam API key and User ID as a value for "apiKey" and "steamID" in quotes respectively.

If either of steam API key or the User ID is invalid, the app will throw an error.

2022-01-07 (6)

Basic format

>sb <command> [option] //or if not installed globally  : node index.js <command> [option] this will not work outside the steam-boy directory
  1. Looking up the different commands available using help command.
>sb help

2022-01-07 (1)

  1. No extra command
>sb

2022-01-07 (2)

  1. Get the list of games owned by you by using games command.
>sb games

2022-01-07 (3)

  1. Get the list of achievements in a game using ach command and an optional flag -i by providing the game ID, if not provided, it will show achievements from the most played game
>sb ach -i [id]

2022-01-07 (4)

Tech Stack / Built With

  1. node.js - bootstrapped with create-node-cli
  2. Styling and color of output text via chalk

Authors

Ishaan Mahesh

You can find me here at: LinkedIn

steam-boy's People

Contributors

ishaan5199 avatar

Watchers

 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.