Metaplay Docs

Appearance

Connecting to the Game Server

This article will guide you through running a Metaplay server locally and connecting to it.

Dependencies ​

  • Metaplay overview - You should have a general idea of what problems we solve for you in the world of game backends. When in doubt, check out the Introduction to Metaplay page!
  • A Unity project with the Metaplay SDK integrated - To run and connect to the server, you first need to add the SDK to your Unity project, as we did in the previous guide. If you haven't checked it out yet, take a look at Integrate the Metaplay SDK guide.
  • .NET 9 SDK - Ensure you have .NET 9 SDK installed.

Overview ​

If you followed the previous guide, your project now contains a fully-featured game server under the Backend/ directory that you can easily run and connect to on your local machine. Now you're ready to configure your project's identity accordingly and run the server for the first time.

Start the Game Server ​

You can run the game server locally using the CLI:

bash
MyProject$ metaplay dev server

Press q to gracefully stop the server.

Alternatively, you can use your IDE to run the server:

On Windows, using Visual Studio:

  1. Open the server solution in Visual Studio, located under the Backend/ directory and named <project>-Server.sln.
  2. Make sure the Server project is selected as the startup project (in Solution Explorer, right-click on Server, and choose Set as StartUp Project).
  3. Press Ctrl+F5 to start the server.

On macOS, using Visual Studio for Mac:

  1. Open the 'Visual Studio for Mac' installation that came with Unity and check for updates to get the latest version.
  2. Open the server solution in Visual Studio for Mac, located under the Backend/ directory and named <project>-Server.sln.
  3. Make sure the Server project is selected as the startup project.
  4. Run the project by pressing the play button or by selecting Run/Start Debugging.
  5. During your first run, you may get permission popups on newer versions of macOS. Terminal access is required to run the backend.
  6. Press the stop button or press q in the terminal window to stop the backend.

Check it out!

You can now view the LiveOps Dashboard at http://localhost:5550 when the server is running.

Run the Unity Client ​

With the game server running, we can connect the game client to it in Unity. Open the environment configs editor under Metaplay/Environment Configs and set 'Active Environment' to 'localhost'.

Set 'Localhost' as the active environment.

Hitting play will now form a connection to your locally running game server.

Further Reading ​

Great! We've now got a server running. To continue with the basics, you should start understanding how Metaplay’s programming model works so you can prepare yourself and start working on your game. We recommend you stop by Saving Player Data to the Server to get started.

You might also want to take a detour by Working with Runtime Options to learn more about configuring the server for different environments or Introduction to the LiveOps Dashboard to get a primer on one of the most useful features the SDK has to offer.

If you want to deploy your game server to the cloud, see Getting Started with Cloud Deployments.