Quick Start | YOM Docs

Get a game streaming on YOM in two steps: upload your binary, then embed an iframe.

Step 1: Deploy Your Stream

Compile your game to Linux x86_64. Any engine works — Unreal Engine, Unity, Godot, or custom.
Log in to app.yom.net/streams.
Create a new stream:
- Stream Name: a unique identifier (e.g., my-game-demo)
- Build Target: choose your target environment (e.g., Development)
- Upload Binaries: drag and drop your compiled game files
- Choose Network: select your preferred network (e.g., Test Net)
Review your configuration and click Pay + Deploy.
Wait for both server and client files to finish uploading. Do not refresh or leave the page during upload.

Once deployed, you’ll receive a Game ID and Stream ID.

Step 2: Embed the Stream

Add this iframe to your webpage:

<iframe
  src="https://player.yom.net?gameId=YOUR_GAME_ID&streamId=YOUR_STREAM_ID&origin=https://yoursite.com"
  width="1280"
  height="720"
  frameborder="0"
  allowfullscreen
  allow="autoplay *; microphone *; clipboard-write *; pointer-lock"
  style="border: none;">
</iframe>

Replace YOUR_GAME_ID, YOUR_STREAM_ID, and https://yoursite.com with your actual values.

That’s it. Players visit your page, click play, and the game streams directly to their browser.

Optional iframe parameters

Append these to the iframe src URL as query parameters:

Parameter	Values	Description
`guestName`	string	Pre-fill the player name
`requestMic`	`true`/`false`	Request microphone access
`forceMic`	`true`/`false`	Require microphone to proceed
`fullscreen`	`none`/`window`/`native`	Fullscreen mode (`window` works on iOS)
`autoInitiate`	`true`/`false`	Skip the play button, start immediately
`requiresName`	`true`/`false`	Require player name input (default: true)
`lang`	ISO-639-1 code	Language code (e.g., `eng`)
`publisher`	string	Publisher name for analytics
`coppa`	`0`/`1`	COPPA compliance flag
`genre`	string	Game genre for ad targeting

Security: CSP headers

If your site uses Content Security Policy headers, allow the YOM player origin:

Content-Security-Policy: frame-src 'self' https://player.yom.net;

Or via a meta tag:

<meta http-equiv="Content-Security-Policy" content="frame-src 'self' https://player.yom.net;">

Troubleshooting

If you encounter issues:

Check your browser console for error messages.
Verify your gameId and streamId are correct.
Ensure your CSP headers allow frame-src https://player.yom.net.
Confirm your game binary was compiled for Linux x86_64.

What’s Next?

Web Integration — Add custom UI, multi-stream pages, and web-to-game communication using the YOM embed script.
UE5 SDK — Add responsive HUDs, bidirectional events, multiplayer, and Web3 features (optional).

For assistance, contact us at info@yom.net.