# EzAdmin SDK for Unity

Version 2.0.0. Works with Unity 2021.3 or newer and the PlayFab Unity SDK.
Runs on Windows, macOS, Linux, Android (including Meta Quest), iOS, Xbox and PlayStation.

## Set up

1. Import the PlayFab Unity SDK if your project does not have it yet.
2. Import this package.
3. Open **Window > EzAdmin > Setup Wizard** and follow its four steps.

The wizard adds one EzAdmin object to your scene, fills in your EzAdmin address, sets up
sign-in for each platform, and writes a starter script for your own code.

## What is in the SDK

| Part | What it does |
| --- | --- |
| `EzAdminClient` | Connects the game to your EzAdmin: kicks, mutes, freezes, live events, announcements, the Staff Panel |
| `EzAdminAuth` | Signs players in to PlayFab the right way on each platform (Meta Quest, Steam, Xbox, PlayStation, phones, PC) |
| `EzAdminLinkScreen` | The ready-made Link Discord button (on screen) or board (in VR) |
| `EzAdminLink` | Linking from your own UI and keyboard |
| `EzAdminItems`, `EzAdminItemUnlock` | Items players get from their Discord roles |
| `EzAdminAntiCheat` | Anti-cheat: speed hacks, mod loaders, injected code, debuggers, memory editing, rooted devices, hooking tools (Frida, Xposed, LSPosed), app cloners and modified copies, reported to your Discord |
| `EzAdminGame` | Settings and news from the dashboard's Game Control tab, kept on the device between launches |
| `EzSecureInt`, `EzSecureFloat`, `EzSecureLong` | Numbers memory editors cannot find or change |
| `EzAdminProfiles`, `EzAdminProfileView` | Discord names and pictures on your leaderboards |
| `Samples/EzAdminSamples.cs` | Short examples of every part |

## The rule that matters

Code in a player's game can be changed. Anything that pays out, unlocks something or lets
a player talk is decided on a server or in PlayFab CloudScript, never only in the game.
The SDK is built that way: purchase receipts are checked with PlayFab, transfers are
carried out by EzAdmin, and anti-cheat actions are switched on on the dashboard.

## Documentation

The full reference, with examples for every call, is on the EzAdmin website under
Developers. Your dashboard's Game files page always has the newest version of this package.
