# Welcome

Welcome to the Superwall Unity SDK beta documentation.

> **Warning**

The Unity SDK is in beta. APIs, platform requirements, and package behavior may change before a
stable release.



The Superwall Unity SDK lets Unity mobile games present Superwall paywalls on iOS and Android. It is
a Unity package with a C# API that bridges to the native [Superwall iOS SDK](https://github.com/superwall/Superwall-iOS)
and [Superwall Android SDK](https://github.com/superwall/Superwall-Android).

Quick Links [#quick-links]

## Install the SDK

/docs/unity/quickstart/install

Add the beta package through Unity Package Manager.

## Configure Superwall

/docs/unity/quickstart/configure

Configure the SDK once when your game starts.

## Present Paywalls

/docs/unity/quickstart/present-paywalls

Register placements from C# and unlock game features.

## Game Controller Input

/docs/unity/guides/game-controller-input

Enable controller-aware paywall actions for mobile games.

## SDK Reference

/docs/unity/sdk-reference

Review the beta C# API surface.

## GitHub Repository

https://github.com/superwall/Superwall-Unity

View the Unity package source.



How It Works [#how-it-works]

The package exposes a `Superwall` C# namespace for Unity scripts. At runtime:

1. Your game calls `Superwall.Configure(...)` once with a Superwall Public API Key.
2. The Unity package creates a persistent `SuperwallBridge` GameObject for callbacks.
3. C# calls are forwarded to native iOS or Android bridge code.
4. The native Superwall SDK fetches campaigns, evaluates placements on device, presents the paywall, and returns callbacks to Unity.
5. Your C# `feature` callback runs when the user has access.

On iOS, the package's post-build processor adds `SuperwallKit` to the generated Xcode project through CocoaPods. On Android, the package includes a Gradle `.androidlib` module that pulls the Superwall Android SDK and Google Play Billing dependencies.

Requirements [#requirements]

* Unity 6+ (`6000.4+`)
* iOS 16.0+
* Android `minSdkVersion` 25+
* CocoaPods for iOS builds
* A Superwall project with mobile app credentials and at least one placement

> **Note**

The Unity Editor uses stubbed native calls and logs method names. Test paywall presentation,
purchases, and native callbacks on an iOS or Android build.