Categorygithub.com/an0nfunc/go-steam/v3
modulepackage
3.0.6
Repository: https://github.com/an0nfunc/go-steam.git
Documentation: pkg.go.dev

# README

Steam for Go

This library implements Steam's protocol to allow automation of different actions on Steam without running an actual Steam client. It is based on SteamKit2, a .NET library.

In addition, it contains APIs to Steam Community features, like trade offers and inventories.

Some of the currently implemented features:

  • Trading and trade offers, including inventories and notifications
  • Friend and group management
  • Chatting with friends
  • Persona states (online, offline, looking to trade, etc.)
  • SteamGuard with two-factor authentication
  • Team Fortress 2: Crafting, moving, naming and deleting items

If this is useful to you, there's also the go-steamapi package that wraps some of the official Steam Web API's types.

Installation

go get github.com/an0nfunc/go-steam

Usage

You can view the documentation with the godoc tool or online on godoc.org.

You should also take a look at the following sub-packages:

Working with go-steam

Whether you want to develop your own Steam bot or directly work on go-steam itself, there are are few things to know.

  • If something is not working, check first if the same operation works (under the same conditions!) in the Steam client on that account. Maybe there's something go-steam doesn't handle correctly or you're missing a warning that's not obviously shown in go-steam. This is particularly important when working with trading since there are restrictions, for example newly authorized devices will not be able to trade for seven days.
  • Since Steam does not maintain a public API for most of the things go-steam implements, you can expect that sometimes things break randomly. Especially the trade and tradeoffer packages have been affected in the past.
  • Always gather as much information as possible. When you file an issue, be as precise and complete as you can. This makes debugging way easier.
  • If you haven't noticed yet, expect to find lots of things out yourself. Debugging can be complicated and Steam's internals are too.
  • Sometimes things break and other SteamKit ports are fixed already. Maybe take a look what people are saying over there? There's also the SteamKit IRC channel.

Updating go-steam to a new SteamKit version

Go source code is generated with code in the generator directory. Look at generator/README.md for more information on how to use the generator.

Then, after generating new Go source files, update go-steam as necessary.

License

Steam for Go is licensed under the New BSD License. More information can be found in LICENSE.txt.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This program generates the protobuf and SteamLanguage files from the SteamKit data.
The GsBot package contains some useful utilites for working with the steam package.
Package jsont Includes helper types for working with JSON data.
No description provided by the author
This package includes some basics for the Steam protocol.
Utilities for reading and writing of binary data.
No description provided by the author
No description provided by the author
Provides access to TF2 Game Coordinator functionality.
No description provided by the author
Allows automation of Steam Trading.
Implements methods to interact with the official Trade Offer API.

# Functions

No description provided by the author
GetRandomCM returns a random server from a built-in IP list.
Load initial server list from Steam Directory Web API.
No description provided by the author

# Constants

No description provided by the author

# Variables

CMServers contains a list of worlwide servers.

# Structs

No description provided by the author
No description provided by the author
Fired when a chat action has completed.
Fired in response to joining a chat.
Fired when a chat invite is received.
Fired in response to a chat member's info being received.
Fired when the client receives a message from either a friend or a chat room.
No description provided by the author
Fired when a clan's state has been changed.
Client Represents a client to the Steam network.
A list of connection manager addresses to connect to in the future.
No description provided by the author
No description provided by the author
Fired in response to adding a friend to your friends list.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Fired in response to ignoring a friend.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This event is emitted for every CMsgClientUserNotifications message and likewise only used for trade offers.
No description provided by the author
Fired when someone changing their friend details.
Fired in response to requesting profile info for a user.
Provides access to social aspects of Steam.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Provides access to the Steam client's part of Steam Trading, that is bootstrapping the trade.
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
No description provided by the author

# Type aliases

When this event is emitted by the Client, the connection is automatically closed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author