Official Medal Auto-Clipping Plug-In

Before You Start

1. Download the Medal Desktop App.
2. Make an account.
3. Claim Your Game on Medal for Developers. There are no costs to use the portal or the API.

Notes:

• Use of the Medal API is subject to Medal’s Terms of Service: https://medal.tv/terms
• Your public key identifies your game to Medal. It isn’t a secret and is meant to ship in your build. You enter it once in Project Settings → Medal.

What Is Medal?

Medal is a desktop app players use to capture gaming moments with their friends. Players have the desktop app open while they play games and capture gameplay clips or long recordings of their play sessions. Our recorder automatically detects games and classifies content into a player's library.

What Does Medal's Auto-Clipping Plug-In Do?

This plug-in is Medal’s official Unity integration. It connects your game to the Medal desktop recorder and helps you, as a publisher or studio, get higher-quality content from the gamer's playing your game. Based on events you set (e.g., a boss kill, a death), our recorder will automatically clip those events for the player, ensuring they always have high-quality content to share and never miss the epic moment. They don't need to manually press the hotkey to clip or scrub through footage afterwards.

Medal does all the recording; your game sends one call, and Medal saves the clip or screenshot. Your game doesn't encode video, keep a replay buffer, or manage files on disk.

How Customizable Is It For You?

You decide which moments trigger a capture, what each one is called, how long each clip is, and how long Medal waits before saving. The delay lets a clip include what happens right after the event: a kill cam, a score screen, or the end of an animation.

How Customizable Is It For The Player?

Players can customize which of your implemented auto-clip events they want captured in their Medal settings.

Suitable For:

At Medal, we believe (and know from data) that every game is worth clipping, from single-player to multiplayer to indie to AAA. If you think there are moments worth sharing -- whether you are a fighting game, shooter, sports game, platformer, narrative single-player game, MMORPG, MOBA, or co-op -- auto-clipping is suitable for you!

Limitations:

• Windows only, because the Medal recorder runs only on Windows 10 and 11. On other platforms, calls return ConnectionFailed and don’t affect the game.
• Requires Unity 6 (6000.0) or newer, because the API is built on Awaitable, which arrived in Unity 6.

Testing:

• In the Editor and in development builds, calls return InactiveGame until you turn on Medal’s Early Access screen-recording test.
• New events return UnsupportedCategory until they show as Live in the portal and Medal has been restarted.
• The package doesn’t write errors or warnings to the Console. Every outcome is returned in MedalResult.

Included:

• Runtime client in its own assembly (MGI.Medal), with no third-party code or dependencies.
• An optional sample scene and script for testing your setup.
• A README covering setup, usage, and every error code.