Getting started

This is the shortest path from zero to a game that is live on mugon.net. Each step links to the page that explains it in full.

1. Install the CLICopy Anchor Link

macOS and Linux:

curl -fsSL https://mugon.net/install.sh | sh

Windows (PowerShell):

irm https://mugon.net/install.ps1 | iex

Check that it worked with mugon --version. More in installing the CLI.

2. Create your game and an API keyCopy Anchor Link

The CLI authenticates with an API key that belongs to one game, so the game has to exist first. On mugon.net, open Game Management:

1. Create a new game. Its name is your project ID from now on: the CLI and the platform identify the game by it, so pick something lowercase with only letters, digits and dashes (for example my-first-game). Creating games needs the game creator role on your account.
2. Open the game, go to the Api Keys tab and create a key. Give it the roles it needs to upload versions (for example contributor; you can only hand out roles whose permissions you have yourself). Copy the key right away: it is shown only once.

3. Log inCopy Anchor Link

mugon login

Enter the project ID (the game name) and the API key when prompted. The CLI checks the key against the platform and stores it in ~/.mugon/config.toml.

4. Create a projectCopy Anchor Link

In an empty folder:

mugon init

Enter your project name, which has to match the game name from step 2, and pick a template:

This writes a mugon.toml and a starter project. If the template has an install command (typescript and bevy do), run it once with mugon run install.

5. Run it locallyCopy Anchor Link

mugon dev

The CLI builds your game and starts a local copy of the platform around it. Open the printed address (http://localhost:3000) and choose Start as host in one tab and Start as client in another to try the multiplayer flow. Your game is rebuilt whenever you change a file. More in working with the CLI.

6. PublishCopy Anchor Link

mugon publish

The CLI builds your game, checks that it is ready for the platform, and uploads it as a new version. You'll find it under the game's Versions tab in Game Management.

What nextCopy Anchor Link

• What each CLI command does and what goes into mugon.toml.
• How a game runs on the platform and what your game has to do in return.
• Your SDK: Bevy or JavaScript.