Friends
List your user friends, open chats, send invites and much more!

Like what your seeing?

Consider supporting us as a GitHub Sponsor and get instant access to all our Unity assets, exclusive tools and assets, escalated support and issue tracking and our gratitude. These articles are made possible by our GitHub Sponsors ... become a sponsor today!

Introduction

The Friends API provides access to all of the user data related features of Steam and is not restricted to users that are the local user's "friends".
Using the Friends API you can list users, gather data on them, read the rich presence data from them and set the local user's data.
By in large the UserData object provides a simpler method for working with the Friends API however we also have a Unity centric Friends API wrapper.

User Data

User Data
Heathen KB
Read Me!
Heathen's UserData is a simple struct and can be used implicitly as a CSteamID or ulong value and provides a lot of quality of life features dealing with Steam User Data such as accessing the local user, getting display or nick names, getting avatar images, setting rich presence data, inviting to game or lobby and so much more.

Lists

uGUI Tools
Heathen KB
You can list friends, contacts, groups and other collections of Steam users and user groups using the Friends API or our uGUI Tools for Steam.
Its possible to filter these lists by the type of friend on query from Steam and then in your game's logic you can further filter these lists based on users in game, or not in game, online or offline, etc.

Groups

Steam Groups aka Clans
Heathen KB
Also know as Clans; Steam's concept of a group or clan or guild is simply a collect of "friends" that is Steam Users. We have split the Groups / Clans system our from Friends in its own set of APIs and tools.

Friend Chat

It is possible to chat with specific friends in game though this is not typical. To get started you would need to enable the Listen for Friend Messages feature in the Friend API. Once this is enabled the EventGameConnectedFriendChatMsg event will be raised when receiving a message from a friend. You can also Send Messages to friends either via the User Data object or the Friend API.