Steamworks for Nim

nimby install steamworks

API reference

This library has no dependencies other than the Nim standard library.

About

Steamworks is a Nim wrapper for Valve's Steamworks API under the MIT license.

It contains everything you need to use the various Steamworks APIs from your Nim game.

• User accounts and friends
• Achievements
• Controller support
• Networking support
• Workshop items
• ...and much more

The bindings are slightly adapted to feel comfortable in Nim rather than being raw and awkward C definitions.

This project generates bindings directly from the Steamworks SDK specification and emits the equivalent Nim API.

Nim-Friendly API

The generated API is shaped for Nim instead of exposing the C names directly. Steam prefixes and suffixes such as m_, k_, k_E, k_i, k_c, k_cb, and _t are removed where possible. For example, C-style names become Nim-style names such as AppId, friendFlagImmediate, apiCallInvalid, numberOfCurrentPlayersCallbackId, and playerCount.data.success.

String-heavy APIs are also wrapped. When Steam expects a fixed char buffer, mutable char* plus a size, a const char*, char**, or SteamParamStringArray, the public wrapper uses Nim string or openArray[string] wherever the SDK signature makes that safe. The raw C import is kept privately with a Raw suffix when a nicer public wrapper is generated.

Getting Started

Step 1 - Download the Steamworks SDK

Download the C++ SDK from Valve:

https://partner.steamgames.com/downloads/list

Copy the correct Steam API dynamic library for your platform next to your game or make sure it is on your library path:

• Windows 64-bit: steam_api64.dll
• Windows 32-bit: steam_api.dll
• macOS: libsteam_api.dylib
• Linux: libsteam_api.so

Step 2 - Add steam_appid.txt

Put a steam_appid.txt file in the directory you run from. It should contain your Steam app ID number without spaces.

Step 3 - Run the Smoke Tests

nim r tests/test.nim
nim r tests/test2.nim

tests/test.nim is the older human-readable test. tests/test2.nim is a broad smoke test that touches many more Steamworks surfaces when the current account and app setup allow it.

Supported Steam Interfaces

The table below uses the Steamworks SDK interface names. "Full support" means the interface methods present in steam_api.json are generated into Nim. A warning means the binding is generated, but useful runtime behavior depends on app configuration, connected hardware, callback plumbing, or a dedicated server environment. Status uses ✅ for full generated support, ⚠️ for generated support with runtime or integration caveats, and ❌ for interfaces that are not currently supported. No SDK 1.64 interface in steam_api.json is intentionally omitted.