> For the complete documentation index, see [llms.txt](https://unknown-56-works.gitbook.io/luigiscreen/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://unknown-56-works.gitbook.io/luigiscreen/getting-started/quick-start.md).

# Quick Start

This guide assumes Paper, OBS and MediaMTX all run on the same computer. For local files or images, use the shorter [Media sources](/luigiscreen/screens-and-streaming/sources.md) guide instead.

## 1. Generate the MediaMTX setup

Join the server as an operator and run:

```
/screen mediamtx same-pc
```

LuigiScreen creates:

```
plugins/LuigiScreen/mediamtx/SAME_PC/mediamtx.yml
plugins/LuigiScreen/mediamtx/SAME_PC/setup.txt
```

`setup.txt` contains private generated credentials. Do not publish it.

## 2. Install MediaMTX

Download the MediaMTX build for your operating system from the official releases.

Place the generated `mediamtx.yml` beside:

```
mediamtx.exe
```

On Linux, place it beside:

```
mediamtx
```

Start MediaMTX. It should report an RTMP listener on TCP port `55556`.

## 3. Configure OBS

Open:

```
Settings -> Stream
```

Use:

| Setting            | Value                                                         |
| ------------------ | ------------------------------------------------------------- |
| Service            | Custom                                                        |
| Server             | Copy the complete OBS URL shown by LuigiScreen or `setup.txt` |
| Stream key         | Empty                                                         |
| Use authentication | Disabled                                                      |

The generated username and password are already inside the server URL query. Do not enter them again into OBS authentication fields.

## 4. Configure OBS output

Recommended starting values:

| Setting           | Value                         |
| ----------------- | ----------------------------- |
| Resolution        | `896x512` for a 7x4 screen    |
| FPS               | `10`                          |
| Video bitrate     | `1200-2000 Kbps`              |
| Encoder           | Hardware H.264 when available |
| Keyframe interval | `2 seconds`                   |
| B-frames          | `0` if configurable           |

Add a display or window capture source, then click **Start Streaming**.

## 5. Create the Minecraft screen

Build a flat vertical wall at least 7 blocks wide and 4 blocks high.

Look at the upper-left block of the wall from the front and run:

```
/screen create main 7 4
```

LuigiScreen creates the MapEngine display and connects to the RTMP stream.

The MediaMTX wizard sets the default RTMP source. You can also set it explicitly:

```
/screen source main rtmp rtmp://127.0.0.1:55556/screen
```

## 6. Check the status

Run:

```
/screen status main
```

For live statistics:

```
/screen debug
```

If the screen remains offline, use [Common errors](/luigiscreen/support/common-errors.md).

## 7. Optional: open Web Studio

For a larger browser control room, run:

```
/screen web
```

Use the link labeled **LAN** from another PC on the same network, or the **Server PC** link on the server computer. See [Web Studio](/luigiscreen/control-studio/web-studio.md).


---

# 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://unknown-56-works.gitbook.io/luigiscreen/getting-started/quick-start.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.
