steamworks

Steamworks API

Go implementation of the Steamworks API that aims to load the Steam API dynamic-link libraries without the use of CGo.

This package was built so that I could utilize the synchronous functions such as SetAchievement, ClearAchievement and GetAchievement. You will will not be able to utilize methods that rely on callbacks as Go functions cannot be called from C-code without CGo.

If you're looking for a package with more API calls supported such as callbacks, consider looking at BenLubar's Steamworks implementation.

Install

1. Install the package

go get github.com/silbinarywolf/steamworks

1. Copy DLL into your project directory (provided in the Steamworks SDK zip file)

steamworks_sdk_146.zip/sdk/redistributable_bin/win64/steam_api64.dll

1. Initialize Steamworks API

const steamAppId = YOUR_STEAM_ID_HERE; // 220 = Half Life 2's Steam App ID

func main() {
	if steamworks.RestartAppIfNecessary(steamAppId) {
		log.Println("restarting with steam")
		os.Exit(1)
	}
	if !steamworks.Init() {
		log.Fatalln("Fatal Error - Steam must be running to play this game")
	}
}

1. Build your project directly into the Steam directory for testing

go build -o "D:\SteamLibrary\steamapps\common\\{YOUR_GAME}\game.exe" && /D/SteamLibrary/steamapps/common/{YOUR_GAME}/game

Potential Problems

• Achievements only appear or trigger once the user quits the game. Not sure if this is normal behaviour or a quirk of initializing the Steam API without CGo.
• Clearing achievements will take effect immediately and not require quitting the game, ie. if you view your game on your Steam page, the achievement will become locked again immediately after you call ClearAchievement.
• RestartAppIfNecessary will call the DLL function SteamAPI_RestartAppIfNecessary, which will return 1163264 in error cases rather than 0 or 1. Currently I'm unsure if this means I'm doing something wrong or if this value is expected. In anycase, this logic might need to be changed or adjusted in the future so that we only return true if ret == 1.
• Currently tests are failing on Travis due to a "Class not registered" error that I cannot reproduce on my local machine. My research seems to suggest that it means a DLL it expects isn't registered however this specific DLL is not meant to be registered, so my hunch is that this error might be a symptom of Steam not being installed.

Supported Operating Systems

• Windows

Requirements

• Golang 1.13+

Documentation

• Documentation
• License

Credits

• FoxCouncil for their .NET implementation which I was able to use as a reference in the porting process.