Kanda Foundation 0.8.0
Loading...
Searching...
No Matches
Getting Started

This guide will help you get started with the basics of setting up and configuring your project using the Kanda SDK Foundation package.

Basic Project Configuration

1. Set up hosting services

The primary backend for the Kanda SDK is hosted with Kanda Cloud. This comes preconfigured for the Kanda "public cloud", but can also be configured for dedicated "private cloud" instances. For more information on how to interact with Kanda Cloud, see the Kanda Cloud Client guide.

Currently, we support multiplayer sessions using Unity Gaming Services. For more information, see the UGS Setup Guide. Refer to the AppLifecycleService source code for more details on how Unity Services are configured at runtime.

2. Edit Project Settings

Project settings can be set in Edit > Project Settings > Kanda SDK. Configure the necessary settings such as scene names, connection config, and other relevant settings.

3. Include Content Scenes in Build

Ensure that all content scenes you plan to load are included in the Build Settings. Go to File > Build Settings and add the necessary scenes to the build.

Understand Application Lifecycle

The Kanda SDK utilizes standard scenes to manage the application lifecycle. The lifecycle is divided into two main scenes:

  • Lobby Scene: The starting point for clients to view and create sessions, and select content to play.
  • Session Scene: The primary scene for training simulations, containing essential elements like the player rig, UI, and services. Servers start directly in the Session scene, awaiting client connections, while clients transition from the Lobby.

Understanding these scenes and their roles is important for developing application behaviors with this package. The AppLifecycleService facilitates transitions between these scenes, managing scene loading and the initialization of required services.

For more detailed information, see the Application Lifecycle guide.

Developer Tools

The Kanda SDK provides several tools to help you write maintainable, high-quality code. These tools are designed to address common issues in enterprise application development.

  • Logging: A custom logging implementation, KandaLog, for standardized and context-rich log messages.
  • Settings: Structured settings management tools help control application behavior without modifying code.
  • Services: The Service Locator framework helps manage dependencies effectively, promoting modular and testable code.

For comprehensive information on these tools and best practices for using them, refer to the Tools page.