このプロジェクトについて
# Facepunch.Steamworks
Steamworks APIをモダンで使いやすいラッパーとして実装した、もう一つのC# Steamworks実装です。Steam自体以外のネイティブ依存関係を持たない単一のC# DLLを目指し、Windows、Linux、MacOS、Unity、IL2CPPをサポートします。
## 特徴
- クロスプラットフォーム: Windows、Linux、MacOS
- Unityサポート（IL2CPP含む）
- 非同期コールバック（Steam callresults）とイベント（Steam callbacks）
- 単一のC# DLL、サードパーティ製ネイティブDLL不要
- MITライセンスのオープンソース
- 32ビットOSサポート
## このライブラリの利点
著者は既存のC# Steamworks実装に欠点があると感じていました。真のC#イディオムではない、古い、ネイティブDLLが必要、UnityでスタンドアロンDLLにコンパイルできない、無料でない、または制限的なライセンスがあるなどです。このライブラリは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( "Hello Friend" );
}
```
### アプリ情報
```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( "My New FIle" )
.WithDescription( "This is a description" )
.WithContent( "c:/folder/addon/location" )
.WithTag( "awesome" )
.WithTag( "small" )
.SubmitAsync( iProgressBar );
```
### Steamクラウド
```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インベントリ
```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エラー、ポートブロック）
}
```
## ヘルプと貢献
プルリクエストやバグ報告による貢献を歓迎します。ヘルプや議論は[Steamworksスレッド](http://steamcommunity.com/groups/steamworks/discussions/0/1319961618833314524/)をご覧ください。例やアドバイスがある[wiki](https://wiki.facepunch.com/steamworks/)もあります。
## ライセンス
MIT - 自由に使用できます。
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.