\n\n---\n\n## About\n\nVapor is a lightweight Steam client framework for [node.js](https://github.com/nodejs/node) which provides unified API for writing custom extensions. Vapor takes care of the basic stuff such as maintaining connection, logging in and exposes simple API which allows custom plugins to extend its behaviour.\n\n## Install\n\n```sh\nnpm install vapor\n```\n\n## Usage\n\n```js\nvar vapor = require('vapor');\n\nvar bot = vapor();\nbot.init({username: 'myUsername', password: 'myPassword'});\nbot.connect();\n```\n\n## Client\n\nVapor provides a very simple automated client. This client uses [node-steam](https://github.com/seishun/node-steam) to connect to Steam servers.\n\nVapor provides several key features:\n- handles log in process, including auth codes and sentry files\n- provides API for plugins\n- provides unified logging interface\n- provides a bunch of [built-in plugins](docs) to make your life easier\n\nEverything else needs to be programmed separately using plugin system.\n\n## Plugins\n\nPlugins are self-contained code snippets which extend Vapor's behaviour.\n\nPlugins have:\n- access to active Steam client instance and handlers\n- access to Steam's enums\n\nThey can:\n- emit custom events\n- listen to events\n- have their own configuration\n- store data\n- and more ...\n\nPlugins are entirely event driven, there are no hard dependencies. Each plugin can emit an event and any plugin may register a callback for such event. This architecture allows your code to be modular and decoupled.\n\n## More information\n\nVisit this repo's Wiki for more information regarding installation, configuration, API, plugins, etc.\n\nExamples are provided in the [examples](examples) folder.\n\nYou can also find auto-generated API docs in the [docs](docs) folder.\n\n## LICENSE\n\nMIT. See `LICENSE`.\n","maintainers":[{"name":"scholtzm","email":"michael.scholtz@outlook.com"}],"time":{"modified":"2022-06-28T09:03:46.315Z","created":"2015-05-26T15:20:25.429Z","0.0.1":"2015-05-26T15:20:25.429Z","0.8.0":"2015-08-03T08:57:06.645Z","0.8.1":"2015-08-03T10:22:39.986Z","0.8.2":"2015-08-04T16:04:41.133Z","0.9.0":"2015-08-22T18:33:16.963Z","0.10.0":"2015-09-16T21:00:54.268Z","0.11.0":"2015-10-01T21:10:53.743Z","0.12.0":"2015-10-08T19:00:42.400Z","0.13.0":"2015-10-15T20:19:44.320Z","0.13.1":"2015-11-29T16:24:27.603Z","1.0.0":"2015-12-07T19:23:11.930Z","1.1.0":"2015-12-27T16:42:39.477Z","1.2.0":"2016-01-12T21:32:03.200Z","1.2.1":"2016-02-09T19:34:50.289Z","1.2.2":"2016-02-11T17:06:25.477Z","1.3.0":"2016-04-14T20:30:19.250Z"},"homepage":"https://github.com/scholtzm/vapor#readme","repository":{"type":"git","url":"git+https://github.com/scholtzm/vapor.git"},"author":{"name":"Michael Scholtz","email":"michael.scholtz@outlook.com"},"bugs":{"url":"https://github.com/scholtzm/vapor/issues"},"license":"MIT","readmeFilename":"README.md"}
![](\"https://cloud.githubusercontent.com/assets/2640934/10439290/2a3aede4-7139-11e5-88c3-5ceed9b80a0f.png\")
\n \n ![\"NPM](\"http://img.shields.io/npm/v/vapor.svg?style=flat\")
\n ![\"Build](\"https://travis-ci.org/scholtzm/vapor.svg?branch=master\")
\n ![\"Dependency](\"https://david-dm.org/scholtzm/vapor.svg\")
\n ![\"devDependency](\"https://david-dm.org/scholtzm/vapor/dev-status.svg\")
\n ![\"Gitter\"](\"https://badges.gitter.im/Join%20Chat.svg\")
\n