Metaplay Docs

Appearance

Hello World Sample

A minimal starter project that scaffolds a new Metaplay-powered game.

Hello World is the minimal Metaplay SDK integration that sets up the fundamental patterns of client-server communication. It features a simple click counter game where pressing a button increments a server-validated counter, showing how actions flow from client to server and back.

Hello World screenshot

The project is designed as a clean starting point for new projects. It contains only the essential code needed to establish a connection, handle basic game logic, and manage the application lifecycle without any distracting complexity. We use it to initialize new projects when running the metaplay init project command.

What is in the Hello World sample? ​

Have a look at the Integrate the Metaplay SDK guide to see how the Hello World sample is used to initialize a new project.

  • PlayerModel (Assets/SharedCode/Player/PlayerModel.cs) - Core game state and logic
  • PlayerActions (Assets/SharedCode/Player/PlayerActions.cs) - Action definitions for client-server communication
  • GameManager (Assets/Code/GameManager.cs) - Unity-side game logic and UI integration
  • ApplicationStateManager (Assets/Code/ApplicationStateManager.cs) - Connection and lifecycle management
  • PlayerActor (Backend/Server/Player/PlayerActor.cs) - Server-side player entity

The project structure is intentionally minimal to make it easy to understand each component's role.

How to Explore? ​

Start by running the Hello World sample in offline mode to see the immediate client-server interaction:

  1. Open HelloWorldScene in Unity
  2. Set environment to 'offline' in the Metaplay Environment Configs
  3. Press Play and click the button in-game to see the counter increment

That's it!

Metaplay dropdown menu

Environment configs

Usage in your own project ​

Hello World is designed to be the starting point for your own game. Start expanding the player model with your own game state and add actions to implement your game logic.

For a more complete walkthrough of how to implement a new game, see the Wordle Tutorial.

Setup Instructions ​

  1. Install the Metaplay CLI
  2. Run metaplay init project to add the SDK and the Hello World sample to your project

or

  1. Extract the Hello World sample from the Metaplay SDK package available in the developer portal downloads archive