Об этом проекте
# Facepunch.Steamworks
Ещё одна реализация Steamworks на C#, созданная как современная и простая в использовании обёртка над Steamworks API. Цель — одна C# DLL без нативных зависимостей, кроме самого Steam, с поддержкой Windows, Linux и MacOS, включая Unity и IL2CPP.
## Возможности
- Кроссплатформенность: Windows, Linux, MacOS
- Поддержка Unity, включая IL2CPP
- Асинхронные колбэки (Steam callresults) и события (Steam callbacks)
- Одна C# DLL, без сторонних нативных DLL
- Открытый исходный код под лицензией MIT
- Поддержка 32-битных операционных систем
## Почему эта библиотека
Автор счёл существующие C# реализации Steamworks недостаточными: они не были по-настоящему идиоматичными для C#, устарели, требовали нативные DLL, не могли быть скомпилированы в отдельную DLL в Unity, не были бесплатными или имели ограничительные лицензии. Эта библиотека стремится обернуть Steamworks API так, чтобы его было проще использовать.
## Примеры использования
### Получение информации о пользователе
```csharp
SteamClient.SteamId // Ваш SteamId
SteamClient.Name // Ваше имя
```
### Список друзей
```csharp
foreach ( var friend in SteamFriends.GetFriends() )
{
Console.WriteLine( $"{friend.Id}: {friend.Name}" );
Console.WriteLine( $"{friend.IsOnline} / {friend.SteamLevel}" );
friend.SendMessage( "Привет, друг" );
}
```
### Информация о приложении
```csharp
Console.WriteLine( SteamApps.GameLanguage );
var installDir = SteamApps.AppInstallDir( 4000 );
var fileinfo = await SteamApps.GetFileDetailsAsync( "hl2.exe" );
```
### Аватары
```csharp
var image = await SteamFriends.GetLargeAvatarAsync( steamid );
if ( !image.HasValue ) return DefaultImage;
return MakeTextureFromRGBA( image.Value.Data, image.Value.Width, image.Value.Height );
```
### Список серверов
```csharp
using ( var list = new ServerList.Internet() )
{
list.AddFilter( "map", "de_dust" );
await list.RunQueryAsync();
foreach ( var server in list.Responsive )
{
Console.WriteLine( $"{server.Address} {server.Name}" );
}
}
```
### Достижения
Список и разблокировка достижений:
```csharp
foreach ( var a in SteamUserStats.Achievements )
{
Console.WriteLine( $"{a.Name} ({a.State})" );
}
var ach = new Achievement( "GM_PLAYED_WITH_GARRY" );
ach.Trigger();
```
### Голос
```csharp
SteamUser.VoiceRecord = KeyDown( "V" );
if ( SteamUser.HasVoiceData )
{
var bytesrwritten = SteamUser.ReadVoiceData( stream );
}
```
### Аутентификация
Аутентификация клиента и сервера:
```csharp
var ticket = SteamUser.GetAuthSessionTicket();
SteamServer.OnValidateAuthTicketResponse += ( steamid, ownerid, rsponse ) =>
{
if ( rsponse == AuthResponse.OK )
TellUserTheyCanBeOnServer( steamid );
else
KickUser( steamid );
};
if ( !SteamServer.BeginAuthSession( ticketData, clientSteamId ) )
{
KickUser( clientSteamId );
}
ticket.Cancel();
```
### Утилиты
```csharp
SteamUtils.SecondsSinceAppActive;
SteamUtils.SecondsSinceComputerActive;
SteamUtils.IpCountry;
SteamUtils.UsingBatteryPower;
SteamUtils.CurrentBatteryPower;
SteamUtils.AppId;
SteamUtils.IsOverlayEnabled;
SteamUtils.IsSteamRunningInVR;
SteamUtils.IsSteamInBigPictureMode;
```
### Мастерская
Загрузка, запрос и публикация элементов мастерской:
```csharp
SteamUGC.Download( 1717844711 );
var itemInfo = await Ugc.Item.Get( 1720164672 );
var q = Ugc.Query.All
.WithTag( "Fun" )
.WithTag( "Movie" )
.MatchAllTags();
var result = await q.GetPageAsync( 1 );
var q = Ugc.UserQuery.All.CreatedByFriends();
var q = Ugc.UserQuery.All.FromSelf();
var result = await Ugc.Editor.NewCommunityFile
.WithTitle( "Мой новый файл" )
.WithDescription( "Это описание" )
.WithContent( "c:/folder/addon/location" )
.WithTag( "awesome" )
.WithTag( "small" )
.SubmitAsync( iProgressBar );
```
### Steam Cloud
```csharp
SteamRemoteStorage.FileWrite( "file.txt", fileContents );
var fileContents = SteamRemoteStorage.FileRead( "file.txt" );
foreach ( var file in SteamRemoteStorage.Files )
{
Console.WriteLine( $"{file} ({SteamRemoteStorage.FileSize(file)} {SteamRemoteStorage.FileTime( file )})" );
}
```
### Steam Inventory
```csharp
foreach ( InventoryDef def in SteamInventory.Definitions )
{
Console.WriteLine( $"{def.Name}" );
}
var defs = await SteamInventory.GetDefinitionsWithPricesAsync();
var result = await SteamInventory.GetItems();
using ( result )
{
var items = result?.GetItems( bWithProperties );
foreach ( InventoryItem item in items )
{
Console.WriteLine( $"{item.Id} / {item.Quantity} / {item.Def.Name} " );
}
}
```
## Начало работы
### Инициализация клиента
```csharp
using Steamworks;
try
{
SteamClient.Init( 4000 );
}
catch ( System.Exception e )
{
// Не удалось инициализировать по какой-то причине (Steam закрыт и т.д.)
}
// Когда закончите:
SteamClient.Shutdown();
```
### Инициализация сервера
```csharp
var serverInit = new SteamServerInit( "gmod", "Garry Mode" )
{
GamePort = 28015,
Secure = true,
QueryPort = 28016
};
try
{
Steamworks.SteamServer.Init( 4000, serverInit );
}
catch ( System.Exception )
{
// Не удалось инициализировать по какой-то причине (ошибки DLL, заблокированные порты)
}
```
## Помощь и вклад
Вклад приветствуется через pull request и отчёты об ошибках. Для помощи и обсуждения посетите [тему Steamworks](http://steamcommunity.com/groups/steamworks/discussions/0/1319961618833314524/). Также есть [вики](https://wiki.facepunch.com/steamworks/) с примерами и советами.
## Лицензия
MIT — делайте что хотите.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.