Steamworks and Unity – P2P Multiplayer

share_steam_logoSome time ago we talked about how to integrate Steamworks.NET with Unity game. It is a good start, but now let’s go further and talk about multiplayer in Steam. This won’t be a tutorial, but a guide on using Steamworks in your own game. We will be using Steamworks.NET library that is a wrapper to steam_api.dll.

Please note that you need a Steam App ID of your game to get it work. You can get one by getting greenlit or by having your game approved directly by Valve. Still, this is a guide, so if you only want to check if Steam is a convenient platform, just read on…

P2P Multiplayer

One of the greatest features of Steamworks is matchmaking and P2P network communication. You don’t have to worry about servers’ setup – all the things are already there.

You may not be familiar with building a multiplayer game using P2P connection, because the most popular approach involves setting up client and server as a separate entity. In this situation client is the game itself and the server is an application that contains server-side logic, connects all the players together and protects them from cheaters. Since client-server scenario may be good for bigger games, for something relatively small and less competitive consider dropping-off the server part for the favor of two clients speaking with each other. Server-side logic will be included only in a single entity, so you won’t have to worry about writing additional applications to make it work. For that reason we will put P2P Steamworks communication in good use.

Is it really that easy?

Steamworks is trying to be as simple as it can be. You don’t even have to worry about making a connection, all you need is a SteamID (SteamID is a unique steam user identifier. Usually it is a big number wrapped inside a CSteamID object. You can easily get a CSteamID of any user you’re interacting with, for instance through the lobby.) When you have it, all you need is to execute this method:

// class SteamNetworking
public static bool SendP2PPacket(CSteamID steamIDRemote, byte[] pubData, uint cubData, EP2PSend eP2PSendType, int nChannel = 0)

pubData is the data we want to send, cubData is the number of bytes we want to send, eP2PSendType is a method of delivery. Let’s not talk about nChannel, the default value is enough for now.

Here’s an example of how to send a “Hello!” string:

CSteamID receiver = ...;
string hello = "Hello!";

// allocate new bytes array and copy string characters as bytes
byte[] bytes = new byte[hello.Length * sizeof(char)];
System.Buffer.BlockCopy(hello.ToCharArray(), 0, bytes, 0, bytes.Length);

SteamNetworking.SendP2PPacket(receiver, bytes, (uint) bytes.Length, EP2PSend.k_EP2PSendReliable);

There are four of these regarding the delivery method:

  • k_EP2PSendUnreliable – Small packets, may get lost, can arrive out of order, but fast.
  • k_EP2PSendUnreliableNoDelay – As above, but won’t do any connections checks. For this purpose it can be thrown away, but it is the fastest possible method of delivery.
  • k_EP2PSendReliable – Reliable message send. For big packets, will arrive in order.
  • k_EP2PSendReliableWithBuffering – As above but buffers the data before sending. Usually when you’re sending a lot of small packages that is not so important to be delivered immediately. (will be forced to send after 200 ms.)

What about the other side?

If one peer is sending the data, the other one receives it in some way. Of course there are some security precautions. You cannot send the data to any Steamworks’ client that’s out there. Before client can receive your data, he has to accept your P2P session request.

P2P session request is something that occurs when you try to send the first chunk of data to the Steamworks’ client. The process will repeat itself if you haven’t sent any data for a while (usually a couple of minutes.) You should accept only the connections you’re expecting to be made, like from another player in the lobby you’re in.

How to accept the session request? It’s really easy! All you have to do is write a code like this one:

// create a callback field. Having a field will make sure that the callback
// handle won't be eaten by garbage collector.
private Callback<P2PSessionRequest_t> _p2PSessionRequestCallback;

void Start()
{
    // setup the callback method
    _p2PSessionRequestCallback = Callback<P2PSessionRequest_t>.Create(OnP2PSessionRequest);
}

void OnP2PSessionRequest(P2PSessionRequest_t request)
{
    CSteamID clientId = request.m_steamIDRemote;
    if (ExpectingClient(clientId))
    {
        SteamNetworking.AcceptP2PSessionWithUser(clientId);
    } else {
        Debug.LogWarning("Unexpected session request from " + clientId);
    }
}

This way a P2P session will be accepted and you’ll be ready to…

Read the message

All the messages are stored in the Steamworks message queue. To read it you have to tell it you’re ready to get it. Usually a good place to do so is an Update() function. Your application will check for new messages as soon as possible.

void Update() 
{
    uint size;

    // repeat while there's a P2P message available
    // will write its size to size variable
    while (SteamNetworking.IsP2PPacketAvailable(out size))
    {
        // allocate buffer and needed variables
        var buffer = new byte[size];
        uint bytesRead;
        CSteamID remoteId;

        // read the message into the buffer
        if (SteamNetworking.ReadP2PPacket(buffer, size, out bytesRead, out remoteId))
        {
            // convert to string
            char[] chars = new char[bytesRead / sizeof(char)];
            Buffer.BlockCopy(buffer, 0, chars, 0, length);

            string message = new string(chars, 0, chars.Length);
            Debug.Log("Received a message: " + message);
        }
    }
}

That’s it!

Summary

This guide does not cover cleaning up (it’s optional because unused sessions are being cleaned up automatically) and error handling. You can read about them in official Steamworks documentation, but remember that you need to be Steam partner to to have access to it. If you’re not, I hope that after our articles about Steamworks you will take into consideration becoming one.

related
GuideIntermediateTips
Should you install Unity Cache Server on localhost?
Do you already know how to use Unity Cache Server? If you're one of the maniacs trying to optimize...
1
GuideIntermediateTutorial
High Definition Render Pipeline: Lit shader in action Part 2
How to achieve realistic results? In a previous post, I was explaining what Lit shader is...
0
AdvancedGuide
Artificial locomotion in Unity using Machine Learning Part 1
Recently Unity introduced a plugin called ML-Agents, which is meant to integrate Machine Learning...
0
Call The Knights!
We are here for you.
Please contact us with regards to a Unity project below.



The Knights appreciate your decision!
Expect the first news soon!
hire us!