Unity, C#, Steamworks.NET и Facepunch.Steamworks
Введение
Как и большинству разработчиков игр, мне очень хочется выложить мою игру в Steam.
Как и большинству инди-разработчиков игр, мне не хватает доступа к ресурсам/знаниям, которые дали бы мне чётко понять, что же действительно значит «быть в Steam».
Сложно заполнить этот пробел в знаниях, потому что, несмотря на подробную документацию возможностей Steam, трудно понять, с чего начать в этом огромном хранилище документов и как связаны между собой его отдельные части. Кроме того, основные обсуждения платформы Steam проходят в закрытом форуме, доступном только для подтверждённых платформой через Steam Direct или реферальную ссылку Valve разработчиков. То есть для начинающих поиск ответов на простые вопросы может оказаться сложной задачей.
Поэтому я решил написать высокоуровневый обзор для людей, которые только начинают разбираться в том, как заставить Steam работать с их играми. В частности, я подробно рассмотрю Steamworks SDK, программную библиотеку Valve, предоставляющую доступ к таким аспектам, как мастерская (Workshop), таблицы лидеров (Leaderboards), достижения (Achievements) и так далее.
Steamworks хорошо задокументирована компанией Valve, но документация написана с точки зрения человека, использующего нативную библиотеку C++ и уже имеющего представление о том, как все эти функции пересекаются. Если это не ваш случай, то так даже лучше! Ниже представлено объяснение для другого человека, который пишет игру на языке более высокого уровня и просто хочет обеспечить простую интеграцию со Steamworks (а это возможно, я гарантирую!). Конкретнее, этот пост предназначен для людей, использующих в той или иной форме C#, а в идеале — работающих в игровом движке Unity.
Steamworks
Steamworks состоит из двух частей. Во-первых, это портал для разработчиков, предназначенный для управления всем, что связано с существованием игры в Steam, от изменения баннеров игры до управления продажами и списка поддерживаемых контроллеров. Во-вторых, это SDK, предоставляемый Valve для того, чтобы разработчик мог взаимодействовать со всем остальным в Steam, в том числе с мастерской, таблицами лидеров, серверами, достижениями и т.д. Не забывайте об этой системе! SDK "обязателен только для загрузки контента в Steam". Это означает, что можно полностью воздержаться от возни со всеми вышеперечисленными возможностями SDK и сосредоточиться только на том, как загрузить игру в Steam. Однако SDK предоставляет множество других полезных функций, так что давайте настроим его и заставим работать!
Если вы пишете на C++, то можете просто добавить библиотеку к вашей игре, следуя этим инструкциям.
Но если вы разработчик на C#/в Unity, то придётся немного потрудиться. Нативные C++ заголовки/исходники несовместимы с Unity, нужно использовать библиотеку-обёртку, позволяющую интегрировать функции SDK. Такая обёртка позволит нам использовать высокоуровневые функции C# для вызова низкоуровневых функций C++. В прошлом такой библиотекой-обёрткой была Steamworks.NET, которая полностью соответствует своему названию: это Steamworks, реализованный на .NET. Однако это именно то, что она и делает, и ничего больше.
Steamworks.NET обеспечивает взаимно однозначное преобразование функций Steamworks в функции C#, но это значит, что для работы вам потребуется полное понимание Steamworks как библиотеки. Для новичков, желающих отделаться простой работой, этого может оказаться слишком много. Если вы хотите сделать что-то посложнее, для Steamworks.NET придётся написать собственную обёртку поверх её обёртки, что лишает смысла саму идею обёртывания.
Facepunch.Steamworks
Из-за этих ограничений и по другим причинам, Facepunch Studios (известная по играм Rust и Garry's Mod) захотела написать более удобную библиотеку Steamworks для C#/Unity.
Она избавляет от необходимости писать кучу кода для реализации простых (и сложных) задач в Steamworks, позволяя сосредоточиться на самой «работе» со Steam. Библиотека используется в Rust, то есть её работа тестируется на игре с одним из самых больших сообществ игроков в Steam. Сложные задачи абстрагируются в простые вызовы функций, сама библиотека состоит всего из трёх файлов, то есть не особо раздувает проект. Не могу выразить, насколько она полезна для новичков, это настоящая находка. Создатель Steamworks.NET даже сказал, что Facepunch.Steamworks — это "именно то, что во что я хотел превратить Steamworks.NET дальше" и что "для большинства разработчиков она должна стать выбором по умолчанию". Steamworks.NET по-прежнему доступна для тех, кто хочет реализовать собственную версию Facepunch.Steamworks, но, по-моему, что хорошо для Rust, то достаточно хорошо и для меня. Как же работает библиотека и что в ней особенного? Давайте начнём разбираться.
Начало работы
Во-первых, можно подумать, что для начала работы с Steamworks нужно быть подтверждённым разработчиком Steamworks, но на самом деле, использовать SDK можно сразу, не проходя процесс регистрации. Valve предоставила разработчикам тестовый «AppID» 480, для которого можно программировать.
AppID
AppID — это уникальный идентификатор игры в Steam (и в Steamworks). Его вы получаете в сразу после регистрации игры. Он «занимает» вам место в Steam/Steamworks и позволяет полностью распоряжаться всем, связанным с этим AppID. AppID 480 соответствует «SpaceWar», демонстрационной игре, созданной Valve. Она имеет открытые исходники и показывает некоторые из возможностей Steamworks (обязательно изучите её!).
Уникальный AppID — это удобно и очевидно необходимо для вашей игры на определённом этапе, тестовый же AppID (480) позволяет вам работать со службами Steam как будто ваша игра уже готова. Когда вы получите реальный AppID, то подставьте его, а пока вполне подойдёт 480. То есть не стоит создавать сервер с названием «Сервер с названием моей игры, ожидающей регистрации в качестве торговой марки».
Скачивание и импорт Facepunch.Steamworks
Итак, давайте скачаем библиотеку Facepunch.Steamworks (далее я буду называть её FP), уже зная, что мы сможем протестировать её с AppID 480. Зайдите в раздел релизов на странице Github (библиотека имеет полностью открытый исходный код и лицензию MIT) и скачайте последний релиз. Распакуйте файл .zip, чтобы получить несколько папок. В README всё подробно расписано, но, в сущности, достаточно просто скопировать небольшой набор этих файлов в ваш проект Unity (подробности зависят от платформы). Файлы Facepunch.Steamworks — это сама библиотека, файлы steam_api и специфичные для платформы файлы, содержащие сам Steamworks SDK. После импорта папка Unity должна выглядеть примерно так (в случае Windows x86/x64):
Unity Project Folder
|— Assets
|— Plugins
|— Facepunch.Steamworks
|— Facepunch.Steamworks.dll
|— Facepunch.Steamworks.pdb
|— Facepunch.Steamworks.xml
|— steam_api.dll (Windows x86)
|— steam_api64.dll (Windows x64)
|— steam_appid.txtФайл «steam_appid.txt» — это текстовый файл, в котором есть только ваш AppID, поэтому мы будем использовать текстовый файл с «480» (без кавычек). Файлы ".dll", ".pdb" и ".xml" скопированы из папки Release скачанного файла .zip соответствующей версии ".NET". Для Unity подойдёт 3.5. Если вы начинаете с «чистого листа», Facepunch великодушно предоставляет небольшой тестовый проект, который делает бо́льшую часть работы за вас. С него можно начать ваш проект.
Unity
Скопировав все файлы библиотеки в соответствующие каталоги, вы практически закончили настройку! Единственное, что нам нужно — написать немного кода, чтобы всё интегрировать. Я скопирую тестовый файл из тестового проекта и просто сокращу его для понятности.
using System;
using UnityEngine;
using System.Collections;
using System.Linq;
using Facepunch.Steamworks;
public class SteamTest : MonoBehaviour
{
void Start ()
{
// Не уничтожать при загрузке новых сцен
DontDestroyOnLoad( gameObject );
// Настройка для Unity
// Это ОЧЕНЬ важно - нужно вызывать это прежде всего остального
Facepunch.Steamworks.Config.ForUnity( Application.platform.ToString() );
// Создаём клиент steam с помощью тестового AppID (или вашего AppID)
new Facepunch.Steamworks.Client( 480 );
// Проверяем, всё ли запущено правильно
if ( Client.Instance == null )
{
Debug.LogError( "Error starting Steam!" );
return;
}
// Печатаем базовую информацию
Debug.Log("My Steam ID: " + Client.Instance.SteamId);
Debug.Log("My Steam Username: " + Client.Instance.Username );
Debug.Log("My Friend Count: " + Client.Instance.Friends.AllFriends.Count() );
}
private void OnDestroy()
{
if ( Client.Instance != null )
{
// Надлежащим образом избавляемся от клиента, если этот объект уничтожен
Client.Instance.Dispose();
}
}
void Update()
{
if ( Client.Instance != null )
{
// Это необходимо вызывать Update для правильной работы библиотеки
Client.Instance.Update();
}
}
}И… на этом всё! Если прикрепить этот скрипт к «GameObject» в сцене и перейти в игровой режим, то вы увидите, что в Steam вы играете в «Spacewar», а в консоли выводится базовая информация Steam о вас (если не получилось, проверьте, выполнен ли вход в Steam).
Жизнь с Facepunch.Steamworks
Возможности
После настройки доступ к более глубоким функциям Steam становится довольно простым, потому что библиотека FP обрабатывает и обёртывает почти все части стандартного Steamworks SDK. Однако по-прежнему стоит вопрос: какие же это части? Вот небольшой список с описаниями того, с чем можно работать (в библиотеке FP):
1. Серверы — создание серверов с помощью клиента игрока или запуск «безголового» сервера в любом другом месте. Используется для чувствительных к пингу игр, имеющих высокие требования к сети (таких как Dota 2, Overwatch и т.д.)
2. Лобби — это «места встреч» игроков, используемые для обмена SteamID или другой информацией пользователей.
3. Друзья — вы и ваши друзья-игроки в Steam.
4. Мастерская — загрузка/скачивание контента в мастерскую Steam Workshop и из неё.
5. Таблицы лидеров — создание и хранение глобальных таблиц лидеров для игры.
6. Достижения — создание и выдача достижений.
7. Сеть — отправка P2P-данных клиентам.
8. Steam Cloud — сохранение данных в облако Steam Cloud! Очень полезно для сохранений игр.
9. Голос — взаимодействие с голосовым API Steam для внутриигрового чата.
10. Статистика — задание статистики на стороне Steam для заданного игрока.
Наилучший способ научиться использованию нужных функций — посмотреть, есть ли её рабочий пример в тестовом проекте Facepunch.Steamworks (ПРИМЕЧАНИЕ: это не тестовый проект Unity), и смоделировать её реализацию в своей игре.
Большинство из возможностей задокументировано в wiki библиотеки FP, но на самом деле достаточное описание есть у нескольких классов. Если вы не можете найти пример, изучите код библиотеки и посмотрите, реализована ли функция вообще. Если нет, то посмотрите, насколько далеко вы можете зайти в её реализации со своей стороны или просто отправьте сообщение об ошибке в библиотеку. Обычно разработчики Facepunch очень отзывчивы, они могут вам рассказать, работают ли они над чем-то или нет, и даже могут посодействовать вам в помощи сообществу, если вы решите реализовать что-то самостоятельно.
Подписчики и обратные вызовы
При работе с библиотекой FP (или даже с нативным API), вы заметите, что не всегда просто работать с обычным вызовом чего-то вроде Client.Instance.SteamId. Причина в том, что Steamworks SDK (а значит, и библиотека FP) активно использует асинхронные функции, чтобы игра не «подвисала» каждый раз, когда нужно выполнить нетривиальное взаимодействие со Steam. Без асинхронных вызовов вам пришлось бы ждать ответа основного сервера Steam, прежде чем выполнился бы ваш код, что очевидно стало бы источником ошибок и раздражения в процессе игры. Поэтому для использования библиотеки вам нужно привыкнуть к концепции делегирования и обратных вызовов. Для начинающего это может казаться сложным, но эти концепции легко понять, если уяснить основную идею. Я приведу пример.
Если вам нужно получить список всех лобби в игре с помощью библиотеки FP, то вы напишете следующее:
client.LobbyList.Refresh();Заметьте, что здесь не выполняется возврат или присваивание. Но в таком случае как нам получить то, что мы запрашиваем? После вызова функции в Steamworks бэкенд Steam подготавливает всё необходимое, а затем отправляет вам данные через «обратный вызов» (callback). Steam почти буквально «вызывает вас», чтобы сообщить: «Эй, твои данные готовы!».
Для получения вызова нам нужно «поднять трубку», или, как это обычно называется, «подписаться» на обратный вызов. Это реализуется определением функции, получаемой передаваемые обратным вызовом данные. Иногда он не передаёт данных, тогда обратный вызов используется в основном как «обработчик» или как способ сообщить, что можно продолжать. Когда вы находитесь внутри обработчика обратного вызова, можно безопасно продолжать работу. Вот пример:
void Start()
{
// Подписываемся на соответствующее событие, определяя функцию, которую нужно вызвать, когда Steam вызывает OnLobbyJoined.
client.Lobby.OnLobbyJoined += OnLobbyJoinedCallback;
// Вызываем функцию
Native.Lobby.Join(LobbyID);
}
void OnLobbyJoinedCallback(bool success)
{
// Если мы внутри, то обратный вызов успешно выполнен!
// Мы можем проверить состояние обратного вызова, проверив булеву переменную "success", которое Steam передаёт со значением true или false
if(success)
{
// Если ошибок нет, то можно безопасно вызывать здесь фукнции, требующие особых условий
// Например, можно вывести id владельца лобби
Debug.Log(client.Lobby.Owner);
}
}Понимание этого паттерна будет очень полезно при использовании библиотеки. Также очень полезно разобраться в том, что же в действительности делает Steamworks, так что стоит изучить его документацию. Если вы хотите более подробно изучить принцип работы, рекомендую прочитать документацию Valve по этой теме, а также некоторые разделы веб-сайта Steamworks.NET.
Двигаемся дальше
С этого момента вы можете делать всё, что угодно! Valve не ставит никаких требований, но если уж вы попали на платформу, то очевидно, что вам в первую очередь интересно связаться с ней и с её сообществом теми способами, которые предоставила Valve. После регистрации в Steam Direct вам достаточно просто заменить AppID и перенести все функции Steam, которые вы реализовали для тестового AppID.
Надеюсь, эта статья окажется полезной для тех, кто хочет начать работу со Steam, и я крайне рекомендую всем изучить Facepunch.Steamworks в Github. Если вы готовы к большему, попробуйте внести свой скромный вклад, например, заполняя пробелы в документации или отправляя запросы. Если у вас появились вопросы о статье, можете связаться со мной в Твиттере: @kkukshtel. Я буду рад, если вы будете читать новости о моей игре в Твиттере @isotacticsgame или подпишетесь на новостную рассылку. Если вы хотите почитать ещё по схожим темам, недавно я создал свой блог, в котором изначально была опубликована эта статья.
Автор: PatientZero
