> For the complete documentation index, see [llms.txt](https://docs.odyssey.stream/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.odyssey.stream/instant-multiplayer/quickstart.md).

# Quickstart

**Instant Multiplayer** allows you to easily turn any unreal project into a multiplayer experience.&#x20;

* A multiplayer server will be automatically built and managed by Odyssey's backend.
* You can enable **Spatial voice & video** for your users to see and hear one another.
* You can use **avatars** if you want a high-fidelity, networked, customizable player pawn.

{% hint style="info" %}
Currently Instant Multiplayer only supports UE version 5.2.1
{% endhint %}

## Enable Instant Multiplayer

1. [Add the Odyssey plugin](/guides/add-the-odyssey-plugin.md)
2. Enable multiplayer in **Project Settings -> Odyssey -> Multiplayer**

<figure><img src="/files/AfebxAUeR8u2RCHR8Xpz" alt=""><figcaption></figcaption></figure>

## Select player type

Decide whether you want to use your own player pawn, or ready-to-use avatars for your multiplayer experience.

1. Select your choice in **Project Settings -> Odyssey -> Player Type**.&#x20;
2. Follow the Odyssey Validator prompts to let it autofix your project and gamemode settings.

## Add Odyssey Multiplayer Player Spawn

Using regular `Player Start` actors in a multiplayer scenario can lead to game breaking issues. Use the `Odyssey Multiplayer Player Spawn` instead to ensure correct networked player spawn behavior.

1. Find the Odyssey Multiplayer Player Spawn in the Place Actors tab.<br>

   <figure><img src="/files/cQTcEmduEFRYKii8nAdG" alt=""><figcaption></figcaption></figure>
2. Drag this volume to your level at a place where you want your users to start their experience.

## Build and deploy

To deploy an Instant Multiplayer build, you don't package your build as normal. Instead you upload your full project and let Odyssey's backend compile your client and server targets.

1. Go to the **Odyssey toolbar -> Zip Odyssey Multiplayer.**&#x20;

<figure><img src="/files/ZipwT0JVgGaYYUjEbNdB" alt=""><figcaption></figcaption></figure>

2. Select the output directory and wait for the archive process to finish.
3. Upload the generated zip file using the standard web uploader. When prompted for the build type, choose \`Multiplayer\` to ensure your project builds properly.

<figure><img src="/files/3ICJYchCOK8dsDZ8a8LY" alt=""><figcaption></figcaption></figure>

4. After uploading, our backend will build your client and server targets. This will take a bit of time, roughly 30 minutes for small projects, to an hour for large projects.

{% hint style="info" %}
After uploading your project, and while our backend builds it, it is safe to leave your dashboard or enter other spaces.
{% endhint %}

5. :tada: Once your build is complete and shows `successful` deployment you can make a space, share the link, and have a multiplayer experience!&#x20;

{% hint style="success" %}
Your server will automatically start when the first user enters, and spin down when the last user leaves.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.odyssey.stream/instant-multiplayer/quickstart.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
