Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
itsjfx committed Oct 7, 2020
1 parent c5899c7 commit e2f8fee
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Dota 2 for SteamUser (node-steam-user)

[![npm version](https://img.shields.io/npm/v/globaloffensive.svg)](https://npmjs.com/package/globaloffensive)
[![npm version](https://img.shields.io/npm/v/dota2-user.svg)](https://npmjs.com/package/dota2-user)

This module provides a very flexible interface for interacting with the Dota 2 Game Coordinator. It's designed to work with a node-steam-user SteamUser instance.

This module is based off the codebases of [node-globaloffensive](https://github.com/doctormckay/node-globaloffensive), [node-tf2](https://github.com/doctormckay/node-tf2) and [node-steam-user](https://github.com/doctormckay/node-steam-user) with how it communicates to Steam. The Dota 2 functionality is based off [node-dota2](https://github.com/Arcana/node-dota2/).
This module is based off the codebases of [node-globaloffensive](https://github.com/doctormckay/node-globaloffensive), [node-tf2](https://github.com/doctormckay/node-tf2) and [node-steam-user](https://github.com/doctormckay/node-steam-user). The Dota 2 functionality is based off [node-dota2](https://github.com/Arcana/node-dota2/).

*This module is not affiliated with those listed above.*

**You will need node-steam-user v4.2.0 or later and Node.js v8 or later to use node-dota2-user.**

# This project

My goal is to structure the codebase similar to `node-steam-user`'s component-based approach to keep this maintainable. Although I'm basing the GC communication off `node-globaloffensive`, there's changes here and there that I've adopted to make development easier (namely in how messages are sent to the GC, and the project structure).
My goal is to structure the codebase similar to `node-steam-user`'s component-based approach to ensure maintainability. Although I'm basing the GC communication off `node-globaloffensive`, there's changes here and there that I've adopted to make development easier (namely in how messages are sent to the GC, and the project structure).

As much as I think `node-dota2` is a great module for Dota 2, the lack of maintainability and no support for `node-steam-user` makes me hate using the module. I have several Dota 2 related bots which use `node-dota2` and development is not as great as it could be due to these issues. At the end of the day I want this to be an alternative to `node-dota2` which supports `node-steam-user`. I will also try my best to keep it as maintained as possible.

In the projects current state, it only supports connecting to Steam GC (sending and receiving a Hello). Development is going to take a lot of time since Dota 2 has so many messages and possible features, but I'll continue incrementally adding features. In the current state, there is enough base behaviour to accomplish anything with the Dota 2 GC.
In the projects current state, it only supports connecting to Dota 2 GC (sending and receiving a Hello). Development is going to take a lot of time since Dota 2 has so many messages and possible features, but I'll continue incrementally adding features. Despite the lack of features, there is enough base behaviour in the project to accomplish anything with the Dota 2 GC.

# Setup

Expand Down

0 comments on commit e2f8fee

Please sign in to comment.