2d98df6122 | ||
---|---|---|
.. | ||
cryptoutil | ||
netutil | ||
protocol | ||
rwu | ||
socialcache | ||
steamid | ||
.gitignore | ||
.gitmodules | ||
LICENSE.txt | ||
README.md | ||
auth.go | ||
auth_events.go | ||
client.go | ||
client_events.go | ||
connection.go | ||
doc.go | ||
gamecoordinator.go | ||
go.mod | ||
go.sum | ||
keys.go | ||
notifications.go | ||
notifications_events.go | ||
servers.go | ||
social.go | ||
social_events.go | ||
steam_directory.go | ||
trading.go | ||
trading_events.go | ||
web.go | ||
web_events.go |
README.md
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/Philipp15b/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:
gsbot
utilites that make writing bots easier- example bot and its source code
trade
for tradingtradeoffer
for trade offerseconomy/inventory
for inventoriestf2
for Team Fortress 2 related things
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
andtradeoffer
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.