Unity、C＃、Steamworks.NET、およびFacepunch.Steamworks

はじめに

ほとんどのゲーム開発者と同様、私は本当に自分のゲームをSteamに載せたいと思っています。



ほとんどのインディーズゲーム開発者と同様に、Steamに参加することの本当の意味を明確にするリソースや知識にアクセスできません。



Steamの機能の詳細なドキュメントにもかかわらず、この巨大なドキュメントリポジトリのどこから始めて、個々のパーツがどのように関連しているかを把握するのが難しいため、この知識のギャップを埋めることは困難です。 さらに、Steamプラットフォームの主な議論は、Steam DirectまたはValve開発者の紹介リンクを介して確認されたプラットフォームでのみ利用可能な、クローズドフォーラムで開催されます。 つまり、初心者にとって、簡単な質問に対する答えを見つけるのは難しい場合があります。



そこで、Steamをゲームで動作させる方法を考え始めたばかりの人々のために、高レベルのレビューを書くことにしました。 特に、ワ​​ークショップ（ワークショップ）、リーダーボード（リーダーボード）、アチーブメント（アチーブメント）などの側面へのアクセスを提供するバルブソフトウェアライブラリであるSteamworks SDKを詳しく見ていきます。



SteamworksはValveによって十分にドキュメント化されていますが、ドキュメントはネイティブC ++ライブラリを使用し、これらのすべての機能がどのように交差するかをすでに知っている人の観点から書かれています。 これがあなたの場合ではない場合、さらに良い！ 以下は、より高いレベルの言語でゲームを作成し、Steamworksとの簡単な統合を提供したい（そして、これは可能です、保証します！）別の人に対する説明です。 より具体的には、この投稿は、何らかの形でC＃を使用し、理想的にはUnityゲームエンジンで作業する人々を対象としています。

Steamworks

Steamworksは2つの部分で構成されています。 まず、これは開発者向けのポータルであり、ゲームのバナーの変更から販売やサポートされているコントローラーのリストの管理まで、Steamでのゲームの存在に関連するすべてを管理するように設計されています。 次に、これはValveが提供するSDKであり、開発者はワークショップ、リーダーボード、サーバー、実績など、Steamの他のすべてとやり取りできます。 このシステムを忘れないでください！ SDK「 Steamのみでコンテンツをダウンロードするために必要です。」 これは、SDKの上記のすべての機能に煩わされることを完全に控え、Steamでゲームをダウンロードする方法のみに集中できることを意味します。 ただし、SDKには他にも多くの便利な機能が用意されているため、設定して機能させましょう。



C ++で作成する場合は、 次の手順に従ってライブラリをゲームに追加するだけです。



しかし、UnityのC＃/開発者であれば、一生懸命働く必要があります。 ネイティブC ++ヘッダー/ソースはUnityと互換性がないため、SDK関数を統合できるラッパーライブラリを使用する必要があります。 このようなラッパーにより、高レベルのC＃関数を使用して低レベルのC ++関数を呼び出すことができます。 過去には、このようなラッパーライブラリはSteamworks.NETでしたが、これはその名前に完全に対応しています。.NETに実装されているSteamworksです。 しかし、これはまさに彼女がしていることであり、それ以上のものではありません。



Steamworks.NETは、Steamworks関数からC＃関数への1対1の変換を提供しますが、動作するためのライブラリとしてSteamworksを完全に理解する必要があります。 簡単な作業で降りたい初心者にとっては、これは多すぎるかもしれません。 もっと複雑なことをしたい場合は、Steamworks.NETの場合、ラッパーの上に独自のラッパーを記述する必要があります。これにより、ラップの意味がなくなります。

Facepunch.Steamworks

これらの制限およびその他の理由により 、Facepunch Studios（RustおよびGarryのModゲームで知られている）は、C＃/ Unity用のより便利なSteamworksライブラリを作成したいと考えていました。



Steamworksで単純な（および複雑な）タスクを実装するために大量のコードを記述する必要がなくなるため、Steamの「作業」に集中できます。 このライブラリはRustで使用されています。つまり、Steamの最大のプレイヤーコミュニティの1つでゲームでテストされています。 複雑なタスクは単純な関数呼び出しに抽象化され、ライブラリ自体は3つのファイルのみで構成されます。つまり、実際にプロジェクトを膨張させることはありません。 私は初心者にとってどれほど有用かを表現することはできません。これは本当の発見です。 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は、Valveが作成したデモゲームであるSpaceWarと一致します。 オープンソースであり、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」ファイルは、「。NET」の対応するバージョンのダウンロードされた.zipファイルのリリースフォルダーからコピーされます。 Unityでは、3.5が適しています。 白紙の状態から始める場合、Facepunchはほとんどの作業を行う小さなテストプロジェクトをgeneしみなく提供します。 それでプロジェクトを開始できます。

団結

すべてのライブラリファイルを適切なディレクトリにコピーすることで、セットアップはほぼ完了です！ 必要なのは、すべてを統合するためのコードを書くことだけです。 テストプロジェクトからテストファイルをコピーし、わかりやすくするために単純に短くします。

 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の基本情報がコンソールに表示されます（動作しない場合は、ログインしているかどうかを確認してください蒸気）。

Facepunch.Steamworksのある生活

特徴

FPライブラリは標準のSteamworks SDKのほぼすべての部分を処理およびラップするため、一度設定すると、より深いSteam機能へのアクセスは非常に簡単になります。 しかし、問題はまだ残っています。これらの部分は何ですか？ 以下に、FPライブラリで作業できる内容の短いリストを示します。



1.サーバー-プレーヤーのクライアントを使用してサーバーを作成するか、他の場所で「ヘッドレス」サーバーを起動します。 ネットワーク要件が高いpingに敏感なゲームに使用（Dota 2、Overwatchなど）



2.ロビーは、SteamIDまたは他のユーザー情報を交換するために使用されるプレーヤーのための「会議場所」です。



3.友達-あなたとあなたの仲間のSteamプレイヤープレイヤー。



4.ワークショップ-Steamワークショップとの間でコンテンツをアップロード/ダウンロードします。



5.リーダーボード-ゲームのグローバルリーダーボードを作成して保存します。



6.アチーブメント-アチーブメントの作成と配信。



7.ネットワーク-P2Pデータをクライアントに送信します。



8. Steamクラウド-データをSteamクラウドに保存します！ ゲームの保存に非常に便利です。



9.音声-ゲーム内チャットのためのSteam音声APIとの相互作用。



10.統計-特定のプレイヤーのSteam側の統計を設定します。



必要な関数の使用方法を学習する最良の方法は、 Facepunch.Steamworks テストプロジェクト （これはUnityテストプロジェクトではありません ）に実際の例があるかどうかを確認し、ゲームでの実装をシミュレートすることです。



ほとんどの機能はFPライブラリwikiに文書化されていますが、実際には、いくつかのクラスに十分な説明があります。 サンプルが見つからない場合は、ライブラリコードを調べて、関数が実装されているかどうかを確認してください。 そうでない場合は、実装をどこまで進めることができるかを確認するか、単にエラーメッセージをライブラリに送信します。 通常、Facepunch開発者は非常に反応がよく、何かに取り組んでいるかどうかを教えてくれます。また、自分で何かを実装することに決めた場合、コミュニティを支援することもできます。

サブスクライバーとコールバック

FPライブラリ（またはネイティブAPI）を使用する場合、 Client.Instance.SteamId



などの通常の呼び出しを使用するのは必ずしも簡単ではないことに気付くでしょう。 理由は、Steamworks SDK（およびFPライブラリ）が非同期関数を積極的に使用しているため、Steamとの重要な相互作用を実行する必要があるたびにゲームが「フリーズ」しないようにするためです。 非同期呼び出しがなければ、コードが実行される前にメインのSteamサーバーの応答を待たなければならず、それは明らかにゲーム中のエラーと迷惑の原因になります。 したがって、ライブラリを使用するには、 委任とコールバックの概念に慣れる必要があります 。 初心者にとっては、これは複雑に思えるかもしれませんが、基本的な考え方を理解すれば、これらの概念は簡単に理解できます。 例を挙げましょう。



FPライブラリを使用してゲーム内のすべてのロビーのリストを取得する必要がある場合は、次のように記述します。

 client.LobbyList.Refresh();
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここでは戻り値または割り当ては実行されないことに注意してください。 しかし、この場合、要求されたものをどのように取得しますか？ Steamworksで関数を呼び出した後、Steamバックエンドは必要なものをすべて準備し、「コールバック」経由でデータを送信します。 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 Webサイトのいくつかのセクションを読むことをお勧めします 。

進む

これからは、あなたがやりたいことは何でもできます！ Valveは要件を設定していませんが、すでにプラットフォームにアクセスしている場合は、Valveが提供する方法でプラットフォームとそのコミュニティに連絡することに主に関心があることは明らかです。 Steam Directに登録したら、AppIDを置き換え、テストAppIDに実装したすべてのSteam機能を転送するだけです。



この記事がSteamを使い始めたい人にとって役立つことを願っています。GithubでFacepunch.Steamworksについて学ぶことを強くお勧めします。 さらに準備ができたら、控えめな貢献をしてみてください。たとえば、ドキュメントのギャップを埋めたり、リクエストを送信したりします。 この記事について質問がある場合は、Twitter（ @kkukshtel）で私に連絡してください。 Twitter @isotacticsgameで私のゲームに関するニュースを読んだり、ニュースレターを購読したりしていただければ幸いです。 同様のトピックについてもっと知りたい場合は、この記事が最初に公開されたブログを最近作成しました 。