dev.edgebase.unity 0.2.3

<p align="center"> <a href="https://github.com/edge-base/edgebase"> <img src="https://raw.githubusercontent.com/edge-base/edgebase/main/docs/static/img/logo-icon.svg" alt="EdgeBase Logo" width="72" /> </a> </p>

EdgeBase.Unity

Client SDK for Unity.

EdgeBase.Unity brings EdgeBase auth, database, realtime, rooms, storage, functions, analytics, and push to Unity projects. It is designed for client-side app code, not trusted server or admin tasks.

EdgeBase is the open-source edge-native BaaS that runs on Edge, Docker, and Node.js.

This package is one part of the wider EdgeBase platform. For the full platform, CLI, Admin Dashboard, server runtime, docs, and all public SDKs, see the main repository: edge-base/edgebase.

Requirements

• Unity 2021.3 LTS or newer
• .NET Standard 2.1
• IL2CPP and Mono

Documentation Map

Use this README for the fast overview, then jump into the docs when you need depth:

• SDK Overview Install commands and the full package matrix
• Quickstart Project creation and local development
• Authentication Email/password, OAuth, MFA, sessions, and captcha
• Database Client SDK Query and mutation patterns for client-side data access
• Database Subscriptions Live change listeners and realtime database patterns
• Room Client SDK Presence, room state, signals, and media flows
• Functions Client SDK Calling EdgeBase functions from client code
• Analytics Client SDK Client-side event tracking
• Push Client SDK Push registration and message handling

For AI Coding Assistants

This package includes an llms.txt file for AI-assisted development.

You can find it:

• in this repository: llms.txt
• in the packed NuGet artifact alongside the package contents

Use it when you want an agent or code assistant to:

• keep client-only code in Unity and server-only code in EdgeBase.Admin
• use Db(namespace, instanceId?) with positional instance ids
• remember that Room(namespaceName, roomId, ...) is the Unity room entry point
• avoid copying browser assumptions into Unity code

Installation

If you are working inside this repository, reference the project directly:

<ItemGroup>
  <ProjectReference Include="..\packages\sdk\csharp\packages\unity\EdgeBase.Unity.csproj" />
</ItemGroup>

The NuGet package id declared by the project is dev.edgebase.unity.

If you are importing the SDK into a Unity project directly, place the package source or compiled assembly under your Assets/Plugins path as appropriate.

Quick Start

using EdgeBase;

var client = new EdgeBase.EdgeBase("https://your-project.edgebase.fun");

var user = await client.Auth.SignInAsync("june@example.com", "pass1234");
var posts = await client.Db("app")
    .Table("posts")
    .Where("published", "==", true)
    .GetListAsync();

await client.Storage.Bucket("avatars").UploadAsync(
    "user123.png",
    System.IO.File.ReadAllBytes("avatar.png"),
    "image/png"
);

var room = client.Room("game", "lobby-1");
Console.WriteLine(user["accessToken"]);
Console.WriteLine(posts.Total);

Core API

Once you create a client, these are the main surfaces you will use:

• new EdgeBase.EdgeBase(baseUrl) Main Unity client entry point
• client.Auth Sign up, sign in, sign out, OAuth, MFA, and auth state
• client.Db(namespace, instanceId?) Query tables and mutate records
• client.Storage Upload files and resolve URLs
• client.Push Register device tokens and listen for push messages
• client.Functions Call app functions from client code
• client.Analytics Track client analytics
• client.Room(namespaceName, roomId, ...) Join realtime rooms for presence and state flows
• client.SetContext(...), client.GetContext(), client.SetLocale(...), client.GetLocale() Request context and locale helpers
• client.Destroy() Close network resources when the client is no longer needed

Choose The Right Package

License

MIT