v1.1.6-beta

GITBOOK-12: No subject

YandexGamesSDK-Unity v1.1.0-beta

YandexGamesSDK-Unity Release Notes

Version v1.1.0-beta - Initial Release

Overview

This release introduces the YandexGamesSDK-Unity plugin, enabling developers to seamlessly integrate Yandex Games services into Unity WebGL projects. The SDK facilitates interaction with Yandex's game services such as authentication, leaderboards, advertisements, and cloud storage. It also features local server tools for development and testing.

Key Features

• Authentication Module: Implements user authentication, supporting both anonymous and registered players, with mock data options for local development.
• Leaderboard Module: Provides methods for submitting and retrieving leaderboard scores, allowing developers to query player-specific data.
• Advertisement Module: Integrates full-screen ads and rewarded videos, with detailed callback events for user interaction.
• Storage Module: Saves and loads user data using Yandex Cloud Storage, with fallbacks for local storage during localhost development.
• Local Server Development: Enables a local server for development with automatic build and deployment features directly through Unity Editor.

Enhancements

• Yandex Games SDK Dashboard: A Unity Editor window that provides a user-friendly UI for managing SDK settings, including the local server, mock data, and development configurations.
• Local Server Manager: Easily start and stop local server instances from the Unity Dashboard to test features as they would appear in production.

Technical Requirements

• Unity Version: 2020.3 or higher.
• Node.js and npm: Required for running local development servers.
• WebGL Build Target: The plugin is optimized for WebGL builds, supporting only this platform for full feature compatibility.

C# Modules

• AuthModule: Manages user authentication and includes support for testing with mock data.
• LeaderboardModule: Supports submitting player scores and retrieving leaderboard data.
• AdvertisementModule: Handles advertisement functionalities such as fullscreen ads and rewarded videos.
• StorageModule: Manages saving and loading player data through cloud or local storage.
• YandexGamesSDKDashboard: Provides Unity Editor integration for managing SDK settings and controlling server instances.
• LocalServerManager: A utility for starting and stopping local server instances to aid in development.

Getting Started

1. Clone the Repository: Clone the repository and import it into your Unity project.
2. Setup Configuration: Use the YandexGamesSDK Dashboard to create and configure the necessary settings for your project.
3. Build and Run Local Server: Use the "Run Local Server After Build" option to easily start a local server after building your WebGL project for testing.

Known Issues

• Running local servers may require specific configurations of Node.js and npm path variables. Make sure these are set properly in Unity to avoid errors during execution.
• If you encounter issues with port conflicts, adjust the server port in the dashboard settings.

License

This release is covered under the MIT License, which allows modification and distribution for both personal and commercial use, provided that proper credit is given.

---

Note: This is the initial release and we are eager to hear feedback. Please report any issues or suggestions to help improve the SDK.