Table of Contents

Quick Start

Start by choosing the workflow your project needs, then import only that package and its required dependencies. Use this page to confirm the shared Unity project baseline before continuing with a module-specific guide.

Prerequisites

Requirement Recommended baseline Notes
Unity 2021.3 LTS or later Check each module guide for required SDKs and the exact import-and-compile-tested Unity versions.
Scripting Runtime .NET Standard 2.1 Required by the shared runtime assemblies.
Project Structure Assembly Definitions recommended OSL packages are designed around explicit assembly references.
Package Source Unity Asset Store / imported package Import only the modules you actually need.

Choose the Right Module

Goal Start with
Reproduce random sequences for replay, lockstep-friendly logic, weighted gacha, pity, or deterministic tests Deterministic
Deliver changed runtime files and resume interrupted downloads without adopting a full Addressables workflow EasyPatcher
Integrate Google, Apple, Facebook, Steam, or Discord through one API while enabling only the providers you need SocialLogin
Verify Apple or Google purchases before rewards and recover unresolved Unity IAP receipts after restart IapClient
Validate package API writes with UGS Cloud Code type, range, delta, and operation rules before saving accepted data SecureSave
Check Unity social login results on your own .NET 8 backend Token Verification
Connect multi-provider client sign-in to your own .NET 8 verification backend as one documented workflow Social Login Pro

Installation

  1. Import the required Ongsoo Labs package into your project.
  2. Open Unity and wait until script compilation completes.
  3. Install any Unity Registry or third-party SDK dependencies required by that module.
  4. Resolve Unity package dependency prompts before opening sample scenes or editor tools.
  5. Back up your project before changing scripting define symbols or assembly references.

Assembly Definition (asmdef) Setup

Most OSL modules are split into runtime, editor, sample, and provider-specific assemblies. If your own game code uses an .asmdef, add references only to the assemblies you need.

If your code uses... Reference this kind of assembly
Runtime APIs OSL.<Module>.Runtime or module-specific runtime assemblies
Editor tooling OSL.<Module>.Editor from editor-only assemblies
Shared utilities OSL.Core
Samples Sample assemblies only inside sample scenes or test projects

Recommended workflow:

  1. Select your project's .asmdef file.
  2. Add the required OSL assembly references.
  3. Save the asset and allow Unity to recompile.
  4. Fix missing references before continuing with runtime setup.

Configuration Pattern

Most OSL packages use explicit configuration assets or editor setup windows. The common pattern is:

  1. Create or open the module-specific setup asset/window.
  2. Enter the project IDs, product IDs, provider IDs, URLs, or options required by the module.
  3. Keep test values separate from live project values.
  4. Avoid hardcoding secrets in scenes, prefabs, or public source files.

Verify the Setup

Before testing the actual feature, confirm the project baseline:

  1. Unity finishes compilation with no missing assembly or namespace errors.
  2. The relevant OSL menu item appears under Tools > OSL when the package provides editor tooling.
  3. Any sample scene opens without missing scripts.
  4. Play Mode starts without initialization exceptions.
  5. The Console shows setup messages you can understand and act on.

Common Troubleshooting

Symptom Likely cause Action
Namespace or type not found Missing .asmdef reference Add the module runtime assembly to your project .asmdef.
Editor menu is missing Editor assembly did not compile Check Console errors and confirm editor-only dependencies are installed.
Runtime feature is disabled Required dependency package is missing Install the Unity Registry or third-party SDK package listed in the module guide.
Sample scene has missing scripts Partial import or assembly compile failure Re-import the package and resolve compile errors first.
Works in Editor but fails on device Platform-specific setup is incomplete Recheck the relevant platform settings.

Next Steps

  • Read Core Concepts to understand shared architecture patterns.
  • Continue with the relevant guide under Asset-specific Guides.
  • Use the generated API Reference when you need method signatures, class members, or extension points.
Edit this page