https://github.com/paralin/go-dota2

Go implementation of the DOTA2 game-coordinator client.
https://github.com/paralin/go-dota2

Last synced: 11 months ago
JSON representation

Go implementation of the DOTA2 game-coordinator client.

• Host: GitHub
• URL: https://github.com/paralin/go-dota2
• Owner: paralin
• License: mit
• Created: 2017-09-13T23:17:24.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2025-03-25T22:44:11.000Z (11 months ago)
• Last Synced: 2025-03-28T23:48:33.779Z (11 months ago)
• Language: Go
• Size: 9.24 MB
• Stars: 135
• Watchers: 10
• Forks: 40
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Dota2

[![Go Reference](https://pkg.go.dev/badge/github.com/paralin/go-dota2.svg)](https://pkg.go.dev/github.com/paralin/go-dota2)

[![Go Report Card Widget]][Go Report Card]

[![DOI](https://zenodo.org/badge/103461337.svg)](https://zenodo.org/badge/latestdoi/103461337)

[Go Report Card Widget]: https://goreportcard.com/badge/github.com/paralin/go-dota2

[Go Report Card]: https://goreportcard.com/report/github.com/paralin/go-dota2

## Introduction 

**go-dota2** is a DOTA 2 client plugin for go-steam.

Games implemented:

 - [dota2](https://github.com/paralin/go-dota2)

 - [underlords](https://github.com/paralin/go-underlords)

Also see: the old [C#/SteamKit Implementation](https://github.com/paralin/Dota2).

This project makes use of a dynamic API generator (apigen) designed to

automatically interpret Valve's various naming conventions into a intermediate

API scheme representation, which is then converted into Go code.

## Implementation Progress

Complete.

 - [x] GC session state management

 - [x] Player profile fetching / call tracking

 - [x] SOCache tracking / state management

 - [x] Basic chat interaction

 - [x] Lobby tracking / state management

    - [x] Read lobby state correctly

    - [x] Implement normal lobby operations

 - [x] Party tracking / state management

    - [x] Read party and invite state correctly

    - [x] Implement normal party operations

 - [x] Code generation for API

 - [x] Code generation for events

## SOCache Mechanism

The caching mechanism makes it easy to watch for changes to common objects, like `Lobby, LobbyInvite, Party, PartyInvite`.

This mechanism is used everywhere, these objects are not exposed in their own events.

```go

import (

	gcmm "github.com/paralin/go-dota2/protocol"

	"github.com/paralin/go-dota2/cso"

)

eventCh, eventCancel, err := dota.GetCache().SubscribeType(cso.Lobby)

if err != nil {

    return err

}

defer eventCancel()

lobbyEvent := <-eventCh

lobby := lobbyEvent.Object.(*gcmm.CSODOTALobby)

```

Events for the object type are emitted on the eventCh. Be sure to call `eventCancel` once you are done with the channel to prevent resource leaks.

The cache object also adds interfaces to get and list the current objects in the cache.

## Implementation Generation

The base API implementation is generated by the [apigen](./apigen) code. Using heuristics, request IDs are matched to response IDs, and events and action-only requests are identified. Some manual tweaking is done in the overrides file.

Next, the API information is used to build a Go code-gen set of implementations around the `MakeRequest` request tracking mechanism.

This means that ALL of the Dota API will be available in this codebase, although only some of it is documented.

## go-steam Dependency

This library depends on [go-steam](https://github.com/paralin/go-steam).