Skip to content

About

WIP

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

414 Commits

Folders and files

Repository files navigation

PRUnitySDK

Фреймворк для игр на Unity. Он задаёт точку входа, порядок инициализации, жизненный цикл компонентов, модель данных и способ, которым игра его расширяет.

  • игра запускается из bootstrap-сцены; порядок инициализации задают MethodHookAttribute и этапы, а не ваш Start;
  • компоненты наследуют PRMonoBehaviour и получают PRUpdate, паузу, игровое время и готовность через ReadySignal; обычный MonoBehaviour всего этого не получает;
  • поведение расширяется подключением к ядру, а не правкой ядра: хуки урона, провайдеры с автопоиском по атрибутам, фабрики окон, трекеры сущностей;
  • данные игры описаны его моделью: каталоги, определения предметов, награды, проекты.

Warning

Проект находится в активной разработке. Публичные API, структура каталогов и процесс инициализации могут изменяться. Перед обновлением фиксируйте используемый commit.

Возможности

Система Назначение
PRUnitySDK Центральная точка доступа к настройкам, менеджерам, трекерам и сервисам
Bootstrap Единая точка запуска и последовательная инициализация фреймворка
PRMonoBehaviour Базовый Unity-компонент с PR lifecycle, поддержкой паузы и физическими callback'ами
EventBus Глобальная типизированная шина событий с защитой от повторной подписки
PauseManager Раздельное управление общей, логической, музыкальной и другими видами паузы
PRTime / PRTimeScale Игровое и реальное время с учётом логической паузы и пользовательских time scale
PRCoroutineBase Обёртки над Unity-корутинами с единым запуском и остановкой
BackgroundTasks Работа по расписанию вне сцены и наблюдение за значениями, которые сами о себе не сообщают
HookSystem Последовательная обработка изменяемых и отменяемых событий
FlagsSystem Совместное управление состояниями объекта из нескольких источников
Entity / Items / Wallet / Reward Базовые модели сущностей, предметов, ресурсов и наград
GameRules Глобальные ограничения характеристик поверх персональных модификаторов
Conditions Настраиваемые правила «когда это разрешено»: ассетом или прямо в инспекторе
GameDataStorage Сохранение прогресса и состояния объектов сцены между запусками
Statistics Числа об игроке за всё время: заходы, время в игре, полученные ресурсы
Purchase / Metrics / RemoteFlags / Review / ServerTime Контракты площадки: интеграция подставляет свою реализацию, без неё работает локальная
ModuleSystem Модули и интеграции, которые вырезаются из сборки
Reflection Реестр типов, которые SDK находит по контракту, вместо перебора сборки при запуске
State / Damage / GameSessions Переиспользуемые игровые модули
Quality / Localization / Logging Качество предметов, переводы и структурированное логирование

Карта фреймворка

Как части связаны между собой. Стрелка — «зависит от».

graph TD
    Boot["Bootstrap<br/>единственная точка входа"]
    Facade["PRUnitySDK<br/>facade, ServiceResolver"]
    Hooks["HookSystem<br/>MethodHook и стадии"]

    Load["LoadingScreen, Scene<br/>экран загрузки, SceneChanger,<br/>ScreenFade"]
    Refl["Reflection<br/>реестр типов по контракту"]
    ModSys["ModuleSystem<br/>окно «Модули», вырезание<br/>из сборки"]

    Boot --> Facade
    Boot --> Load
    Facade --> Hooks
    Facade --> Refl

    subgraph BASE["Базис"]
        Models["Models<br/>Enumeration, ProjectData"]
        Utils["#Utils, #Extensions, Debug"]
        Attrs["@Attributes"]
    end

    subgraph LIFE["Жизненный цикл и время"]
        Mono["PRMonoBehaviour"]
        Pause["PauseSystem"]
        Time["PRTime, PRTimeScale"]
        Coro["Coroutines, Yields"]
        Bg["BackgroundTasks"]
    end

    subgraph DATA["Данные"]
        Storage["GameDataStorage<br/>ProjectData, ObjectState"]
        Db["#Database<br/>PRSDKDatabase, PRSDKSettings"]
        Paths["ResourcePaths"]
        Stats["Statistics<br/>заходы, время в игре"]
    end

    subgraph PLAT["Контракты площадки"]
        Contracts["Purchase, Metrics, RemoteFlags,<br/>Review, ServerTime, Rating,<br/>DeviceInfo"]
    end

    subgraph WORLD["Модель мира"]
        Entity["@Entity<br/>EntityBase, Metadata,<br/>Stats, Player, Sides"]
        Items["Items"]
        Wallet["Wallet"]
        Reward["Reward"]
        Rules["GameRules"]
        Props["PropertyContainer"]
        Flags["FlagsSystem"]
        Cond["@Conditions<br/>ICondition, ConditionBase"]
    end

    subgraph RUNTIME["Рантайм-инфраструктура"]
        Managers["@Managers<br/>PRManagerContainer"]
        Trackers["Trackers<br/>Entities, Players, Cameras, Windows"]
        Factories["Factories, ObjectPool"]
        Bus["@Events<br/>EventBus"]
        Bots["Bots"]
        Input["Input<br/>InputTranslator, PlayerInputState"]
    end

    subgraph UIL["Интерфейс"]
        Wnd["#UI<br/>MonoWindow, Notifiers,<br/>PRWindowsContainer"]
    end

    subgraph MODS["Модули"]
        Damage["@DamageSystem"]
        HitBox["HitBox"]
        Cam["Camera"]
        Tr["Translate"]
        Tween["DOTweenEffects"]
        Sessions["GameSessions"]
    end

    Integr["#Integrations<br/>YG2, GamePush, VK,<br/>Pikabu, Steam"]

    Editor["Core/Editor<br/>окна Database и PRUnitySDKDebug"]

    Facade --> Contracts
    Integr --> Contracts
    Integr --> Hooks
    Stats --> Storage
    Stats --> Bg
    Bg --> Refl

    Mono --> Pause
    Mono --> Time
    Mono --> Bus
    Bg --> Mono

    Entity --> Models
    Entity --> Mono
    Entity --> Factories
    Entity --> Rules
    Entity --> Input
    Items --> Models
    Items --> Tr
    Props --> Models
    Flags --> Models
    Rules --> Models
    Reward --> Items
    Wallet --> Models
    Cond --> Items
    Cond --> Wallet

    Managers --> Storage
    Managers --> Items
    Trackers --> Entity
    Trackers --> Wnd
    Bus --> Items
    Bots --> Bus

    Wnd --> Mono
    Wnd --> Pause
    Cam --> Trackers
    Damage --> Entity
    Damage --> Hooks
    Damage --> Items
    HitBox --> Damage
    Tween --> Time
    Sessions --> Entity
    Sessions --> Bus

    Editor --> Entity
    Editor --> Db
    Editor --> Wnd
    Editor --> Bg
    Editor --> ModSys
    ModSys -.->|вырезает| MODS
    ModSys -.->|вырезает| Integr
Loading

Пунктир — не зависимость: окно «Модули» убирает модуль или интеграцию из компиляции, ядро не трогает.

Игра к фреймворку не подмешивается: зависимость всегда направлена от игры к нему. Как именно к нему подключаться — в разделе «Какой механизм расширения выбрать».

Слои

Папка Что в ней
Assets/PRUnitySDK сам фреймворк, этот репозиторий: общее для любой игры
проектный слой, рядом в Assets механики ваших игр поверх фреймворка; в этот репозиторий не входит
папка данных игры её проект PRSDKProject: ссылки на базу и настройки, сцена игры и второстепенные сцены (уровни) для списка сборки, сами база и настройки, копии настроек площадок
Assets/PRUnityData указатель на активный проект и сгенерированный реестр типов; сюда же SDK кладёт данные нового проекта, если папка не задана

Каждая игра — свой проект SDK. Какая из них собирается сейчас, указывает PRSDKActiveProject в PRUnityData/Resources/PRUnitySDK — окно PRUnitySDK/Project. Указатель — выбор конкретной машины, держите его вне git.

Опыт и уровни (XPManager, фоновое начисление, бустеры опыта) в публичный SDK не входят — это проектный слой.

Требования

  • Unity 2023.2 или новее (TextMeshPro из com.unity.ugui 2.0);
  • Newtonsoft Json for Unity;
  • DOTween для tween-расширений и модуля DOTweenEffects.

Интеграциям площадок нужны свои плагины — см. «Интеграции площадок».

Интеграции площадок

Интеграция подставляет реализации контрактов ядра — сохранения, устройства, времени, флагов, оценки, метрики — на SDK своей площадки. Без интеграции работают локальные реализации, поэтому игра запускается и в редакторе, и в сборке без площадки.

Каждая интеграция — отдельный модуль в #Integrations/<Имя>.Integration. Включается и выключается в окне PRUnitySDK → Модули, вкладка «Интеграции»: отключённая вырезается из компиляции символом PRSDK_DISABLE_<ID>.

Интеграция Сборка Что подставляет Что нужно поставить
YG2 — Яндекс Игры и другие площадки плагина WebGL сохранение, устройство, время площадки, флаги, оценку, рейтинг, метрику, язык, имя игрока YG2 Plugin
GamePush WebGL те же контракты на плагине GamePush, кроме рейтинга плагин GamePush
VK — ВКонтакте и Одноклассники WebGL сохранение, устройство, имя, язык, пауза при сворачивании ничего: VK Bridge подключает шаблон WebGL модуля
Pikabu — Пикабу Игры WebGL сохранение, устройство, имя, язык, пауза на скрытой вкладке ничего: SDK Пикабу подключает шаблон WebGL модуля
Steam Windows, Linux, macOS сохранение в Steam Cloud, имя и язык игрока; без запущенного Steam — локальные Steamworks.NET

Реклама, покупки, достижения и лидерборды площадок в публичный SDK не входят: они завязаны на модули проектного слоя и подключаются там.

Площадки внутри YG2 Plugin

YG2 Plugin — не только Яндекс Игры. Площадка в нём — отдельный модуль (в его дефайне есть слово Platform): он скачивается в окне плагина и выбирается полем Platform в разделе Basic Settings его настроек. Код игры при этом обращается к тому же API YG2. Каталог модулей плагина (v2.0092, сентябрь 2026) предлагает площадки и мобильную рекламу:

Модуль YG2 Что это
YandexGames Яндекс Игры — площадка по умолчанию
CrazyGames веб-портал CrazyGames
GamePix веб-портал GamePix
GameDistribution GameDistribution — раздача игры на сайты-партнёры
GameMonetize GameMonetize — раздача игры на сайты-партнёры
Y8 веб-портал Y8
WelwiseGames площадка Welwise Games
EmptyWebGL WebGL-сборка без SDK площадки
YandexMobileAds реклама Яндекса в мобильной сборке
Appodeal мобильная реклама через медиацию Appodeal

Актуальный список — в окне модулей YG2 Plugin: площадки добавляются с версиями плагина.

Note

YG2.Integration собрана и проверена на модуле YandexGames. На других площадках YG2 работает тот же код, но часть возможностей у площадки может отсутствовать — например, валюта Yan в покупках, Метрика или флаги. Перед выпуском на новой площадке сверьте с документацией её модуля, какие функции YG2 она поддерживает.

Установка

Репозиторий пока не оформлен как UPM-пакет: в корне отсутствует package.json. Размещайте содержимое репозитория внутри Assets/PRUnitySDK.

Через Git submodule:

git submodule add https://github.com/prethink/PRUnitySDK.git Assets/PRUnitySDK
git submodule update --init --recursive

Либо скачайте репозиторий и скопируйте его содержимое в:

Assets/PRUnitySDK

После импорта убедитесь, что Unity завершил компиляцию без ошибок и установлены перечисленные выше зависимости.

Быстрый старт

1. Подготовьте bootstrap-сцену

  1. Создайте отдельную сцену и добавьте её первой в File → Build Settings.
  2. Поместите в неё GameObject с компонентом Bootstrap.
  3. Добавьте основную игровую сцену следующей, с build index 1.

После инициализации Bootstrap открывает Settings.Bootstrap.GameSceneIndex (по умолчанию 1). В Unity Editor класс PlayFromBootstrap сначала запускает сцену с индексом 0. Если включён Start From Editor Scene, после сборки SDK открывается сцена, которая была активной в редакторе перед Play. В билде всегда используется Game Scene Index.

Important

Если проект использует другую схему загрузки сцен, измените обработчик Bootstrap.OnInitialized() или переопределите bootstrap-процесс через OverrideBootstrapAttribute.

Что ещё настраивается при запуске — экран загрузки, затемнение на переходах (ScreenFade), сборка SDK порциями, индекс игровой сцены и диагностика загрузки, — описано в Core/BOOTSTRAP.md.

2. Проверьте, что SDK запустился

Минимальный сценарий, после которого ясно, что фреймворк установлен и работает:

  1. Unity собрал проект без ошибок в Console, в главном меню появился пункт PRUnitySDK.
  2. В игровую сцену (build index 1) добавьте объект с таким компонентом:
using UnityEngine;

public class SdkSmokeCheck : MonoBehaviour
{
    private void Awake()
    {
        PRUnitySDK.ReadySignal.SubscribeOnReady(() =>
            Debug.Log($"PRUnitySDK готов: {PRUnitySDK.IsInitialized}"));
    }
}
  1. Откройте игровую сцену и нажмите Play. PlayFromBootstrap сам начнёт с bootstrap-сцены, затем откроется игровая.
  2. В Console должна появиться строка PRUnitySDK готов: True.

Если строки нет:

  • bootstrap-сцена не стоит первой в Build Settings или на ней нет компонента Bootstrap;
  • игровая сцена не под индексом 1 — проверьте Game Scene Index в настройках запуска;
  • в Console есть ошибки сборки SDK — первая из них и есть причина.

Компонент проверки потом удалите.

3. Используйте PR lifecycle

using UnityEngine;

public class RotatingObject : PRMonoBehaviour
{
    [SerializeField] private float speed = 90f;

    protected override void PRUpdate()
    {
        transform.Rotate(Vector3.up, speed * PRTime.Instance.GameDeltaTime);
    }
}

PRUpdate, PRLateUpdate и PRFixedUpdate не выполняются во время логической паузы. Для временных расчётов используйте PRTime, если система должна следовать правилам паузы фреймворка.

Физические callback'и объявлены в базовом классе, поэтому Unity вызывает их у любого наследника. Ненужные отключаются на уровне типа:

[DisableMethods("OnTriggerStay", "OnCollisionStay")]
public class Pickup : PRMonoBehaviour { }

Атрибут действует только на физические callback'и и OnPauseStateChanged, имена задаются строками, а у наследника список заменяется целиком, а не дополняется — подробности в PRMonoBehaviour. Там же чек-лист «метод не вызывается — что проверить».

4. Подпишитесь на глобальное событие

Событие описывается интерфейсом:

public interface ICoinsChanged : IGlobalSubscriber
{
    void OnCoinsChanged(int value);
}

Подписчик реализует интерфейс и регистрируется в EventBus:

public class CoinsView : MonoBehaviour, ICoinsChanged
{
    private void OnEnable() => EventBus.Subscribe(this);
    private void OnDisable() => EventBus.Unsubscribe(this);

    public void OnCoinsChanged(int value)
    {
        Debug.Log($"Coins: {value}");
    }
}

Вызов события:

EventBus.RaiseEvent<ICoinsChanged>(listener => listener.OnCoinsChanged(10));

Компоненты, наследуемые от PRMonoBehaviour, автоматически регистрируются в EventBus при стандартной инициализации и снимаются с регистрации при уничтожении.

5. Управляйте логической паузой

PRUnitySDK.PauseManager.SetLogicPaused(true, this);
PRUnitySDK.PauseManager.SetLogicPaused(false, this);

Состояние доступно через:

bool isPaused = PRUnitySDK.PauseManager.IsLogicPaused;

6. Запустите PR-корутину

var delay = new WaitGameSecondsCoroutine(
    callback: () => Debug.Log("Completed"),
    duration: 2f,
    instance: this);

delay.Execute();

Если MonoBehaviour не передан, корутина запускается на глобальном PRMonoBehaviourHost. Для повторного запуска одного объекта корутины используйте StopAndExecute(), а для остановки — Stop().

Инициализация

Основная последовательность запуска:

  1. Bootstrap.Awake() вызывает PRUnitySDK.InitializeSDK().
  2. Инициализируются правила, конвертеры, singleton-сервисы и фабрики.
  3. Через method hooks подключаются дополнительные модули.
  4. Инициализируются контейнеры менеджеров и окон.
  5. Устанавливается PRUnitySDK.IsInitialized.
  6. Публикуется ISDKEvents.OnInitialized() и устанавливается ReadySignal.

Повторный параллельный запуск блокируется флагом PRUnitySDK.IsStartInitialize. Готовность можно проверить через PRUnitySDK.IsInitialized или PRUnitySDK.ReadySignal.

Какой механизм расширения выбрать

Во фреймворке восемь способов вклиниться в чужое поведение или работать рядом с ним. Они не взаимозаменяемы: каждый решает свою задачу. Выбор определяется одним вопросом — что вам нужно сделать с чужим кодом.

Нужно Механизм Где описан
Выполнить свой код в определённый момент MethodHookAttribute Attributes
Узнать, что что-то уже произошло EventBus EventBus
Изменить или запретить действие до того, как оно случилось HookSystem HookSystem
Согласовать решение, на которое влияют несколько компонентов FlagsSystem FlagsSystem
Собрать данные из всех модулей в один список InvokePartialAttribute Attributes
Подменить стандартную реализацию сервиса OverridePropertyAttribute Attributes
Выполнять работу по расписанию вне сцены BackgroundTask BackgroundTasks
Узнать об изменении значения, которое само о себе не сообщает WatcherTask<T> BackgroundTasks

Как отличить друг от друга

MethodHook — «выполни это на такой-то стадии». Инициализация модуля, регистрация фабрик, клонирование данных. Порядок задаёт число, результат не собирается.

[MethodHook(MethodHookStage.SDK, order: 20)]
private static void InitializeInventory() { }

EventBus — «сообщи, что уже случилось». Отправитель не ждёт ответа и не знает подписчиков. Обновить UI, проиграть звук, записать метрику.

public class CoinsView : MonoBehaviour, IResourceValueChangedEvent { }

HookSystem — «дай вмешаться до того, как случится». В отличие от EventBus, обработчик получает изменяемый контекст: может уменьшить урон, заменить награду или отменить действие. Обработчики идут цепочкой в порядке Order.

public class DamageDefenseComponent : PRMonoBehaviour, IHookListener<DamageHookEvent> { }

FlagsSystem — «можно ли сейчас?». Когда на один вопрос («можно ли прыгать») влияют несколько независимых источников — оглушение, катсцена, туториал. Каждый добавляет своё влияние, система сводит их к ответу.

flagResolver.Add(PlayerFlags.CanJump, this, false);

InvokePartial — «соберите со всех». Каждый модуль возвращает свой кусок, вызывающий получает объединённый результат.

IEnumerable<Modifier> modifiers = this.CollectPartialResult<Modifier>(context);

OverrideProperty — «замени реализацию». Интеграция подставляет свой сервис вместо стандартного до применения fallback, например серверное время платформы вместо локального или облачное хранилище вместо PlayerPrefs.

[OverrideProperty(typeof(IServerTime), order: -100)]
private static void UsePlatformServerTime() => ServerTime = new PlatformServerTime();

BackgroundTask — «делай это раз в N секунд». Работа без владельца на сцене, которая должна пережить её смену: автосохранение, офлайн-доход, отложенная аналитика. Задача сама переживает паузу так, как ей нужно, и умеет пропускать запуск, пока условия не готовы.

[AutoBackgroundTask]
public class PlaytimeTrackerTask : BackgroundTask
{
    public override Enumeration Key => BackgroundTaskKeyEnumerations.PlaytimeTracker;
    public override float RepeatSeconds => 60f;

    protected override void OnExecute() { }
}

WatcherTask<T> — «сообщи, когда значение изменится». В отличие от EventBus, источник ничего не отправляет: смену суток, состояние сети или баланс на сервере можно узнать только опросом. Наблюдатель опрашивает по расписанию и поднимает событие только в момент изменения.

Частые ошибки выбора

  • EventBus там, где нужен HookSystem. Событие уведомляет уже после того, как решение принято, и повлиять на него нельзя.
  • HookSystem там, где хватило бы EventBus. Перехват делает поток неочевидным: обработчик может незаметно отменить действие.
  • Свой флаг вместо FlagsSystem. Булево поле «нельзя прыгать» ломается при двух источниках запрета: снявший один разрешает, хотя второй ещё против.
  • MethodHook для реакции на игровое событие. Хуки стадий вызываются там, где код явно их запускает; для игровых событий есть EventBus.
  • partial void как точка расширения. У partial-метода ровно одна реализация на класс; вторая часть получит ошибку компиляции CS0757. Если участников может быть несколько, используйте MethodHook или InvokePartial.
  • Своя корутина вместо BackgroundTask. Корутина требует объекта-хозяина, теряется при смене сцены и не даёт ни счётчиков, ни защиты от череды ошибок.
  • Опрос в Update вместо WatcherTask<T>. Проверять раз в кадр то, что меняется раз в минуту, — лишняя работа; наблюдатель опрашивает по расписанию и сообщает только об изменении.

Расширение без вклинивания

Отдельно стоят механизмы, которые не перехватывают чужое поведение, а дополняют данные. Им не нужен ни один из восьми способов выше:

Что добавить Как
Поле в сохранение partial class ProjectData + [MethodHook(Cloning)]
Новое окно partial class MonoWindowKeyEnumerations + partial class PRWindowsContainer
Фоновая задача наследник BackgroundTask + [AutoBackgroundTask] + ключ partial-частью BackgroundTaskKeyEnumerations
Путь к ресурсам модуля partial class ResourcePaths
Новый ключ, тип, слой наследник EnumerationProviderBase или partial-часть существующего

Правило простое: общие файлы фреймворка править не нужно — почти всё расширяется partial-частью рядом с модулем.

Структура репозитория

PRUnitySDK/
├── Core/                       # Ядро, сервисы, базовые модели и инструменты
├── Core.Data/                  # Данные ядра отдельно от логики: GameRules, данные сущностей
├── Modules/                    # Опциональные игровые модули
├── Examples/                   # Примеры использования
├── Resources/                  # Runtime-ресурсы фреймворка (данные игры — в PRUnityData)
├── Utils/                      # Дополнительные утилиты
├── Plugins/                    # Сторонние плагины (SerializedCollections)
└── #Integrations/*.Integration/ # Интеграции площадок: YG2, GamePush, VK, Pikabu, Steam

Дополнительная документация

Ядро и точки расширения

  • SDK — facade, инициализация и service resolver
  • ResourcePaths — канонические пути к runtime-ресурсам и правила расширения
  • Окна Database и Settings — секции с описанием и сбросом, поиск, заполнение каталогов, валидация definitions и наборы состава базы для разных игр; база своих окон — ExtendedEditorWindow
  • Attributes — method hooks, переопределение сервисов и расширение Inspector
  • Actions — переиспользуемые действия с единым контрактом проверки и выполнения
  • Conditions — переиспользуемые правила «когда это разрешено». Действие совершает поступок, условие только спрашивает. Оттуда же берут подпись для игрока: чего не хватает, чтобы условие выполнилось
  • EventBus — типизированная шина уведомлений о произошедшем
  • HookSystem — перехват действий с возможностью изменить или запретить их
  • FlagsSystem — согласование независимых решений компонентов без прямых зависимостей

Жизненный цикл и время

  • PRMonoBehaviour — базовый компонент с lifecycle-хуками, учитывающими логическую паузу
  • Coroutines — обёртки над корутинами с запуском, перезапуском и остановкой
  • Yields — CustomYieldInstruction, останавливающие корутины на логической паузе
  • PauseSystem — раздельные причины паузы и мониторы аниматоров и физических тел
  • PRTime — источник времени: реальное, игровое и учёт паузы
  • PRTimeScale — слои скорости времени, модификаторы с владельцами и драйверы для анимации и физики
  • BackgroundTasks — фоновые задачи по расписанию и наблюдение за значениями; рабочий пример

Менеджеры

  • Обзор менеджеров — доступ, жизненный цикл, порядок и расширение контейнера
  • GameManager — загрузка и сохранение ProjectData/GameSettings, autosave и готовность данных
  • ProjectPropertiesManager — свойства long, float, DateTime, string и bool
  • ResourceManager — игровые ресурсы, баланс, списание и события изменений
  • OpenedItemsManager — открытые предметы и количество в ProjectData
  • SelectedItemsManager — что из имеющегося надето у каждого локального игрока
  • ReservedItemsManager — предметы, которые выдаются не покупкой: награды, подарки, кейсы
  • PRManagerContainer — hook-порядок создания runtime-менеджеров
  • SoundManager — музыка, UI-звуки, позиционные эффекты и наборы AudioSet
  • CursorManager — запросы Show/Hide курсора с приоритетом последнего обращения
  • Statistics — числа об игроке за всё время: заходы, время в игре, полученные ресурсы

Модели, сервисы и утилиты

  • Entity — сущности игрового мира: идентификаторы, описание, реестр и пул
  • Свой-чужой — стороны сущностей и матрица «кто кого бьёт»
  • EntityStats — характеристики сущности: базовые значения, персональные модификаторы и расчёт итоговых
  • Ввод — состояние ввода игрока или бота и его маршрутизация по InputGuid
  • Фабрики MonoBehaviour — обычные prefab, singleton-компоненты, MonoWindow и Notifier
  • Trackers — игроки, сущности, камеры и UI-реестры
  • MonoWindow — модальные runtime-окна, фабрики и параметры открытия
  • UIButtonDefinition — описание экранной кнопки: иконка, подпись, действие, условие показа
  • Звук нажатия — один общий щелчок на всё, что нажимают в интерфейсе
  • Reward — модели наград, экземплярный сервис выдачи и проектные обработчики
  • Purchase — контракт покупок за реальные деньги IPurchaseService
  • Metrics — отправка событий метрики через адаптер площадки
  • RemoteFlags — значения, которые площадка меняет без пересборки: A/B-тесты, цены
  • Review — оценка игры на площадке (IReviewService)
  • Wallet — баланс, начисление и списание валюты поверх ResourceManager
  • Enumeration — расширяемый строковый идентификатор вместо enum
  • Services — NameService и сервис имени текущего игрока
  • Локализация — переводы в базе, ассетах и на префабах, живой перевод чисел, сбор и обмен через CSV
  • Utils — мелкие помощники: логирование, ресурсы, работа с материалами
  • GameDataStorage — storage-контракты и универсальный ProjectDataMap
  • Состояние объекта сцены — SaveableObjectState: объект появляется таким, каким его оставили
  • Extensions — extension-методы общего назначения для Unity и типов SDK
  • Quality — качество предметов: уровни редкости и их отображение
  • Utils — вспомогательные классы: время, отложенные вызовы, имена
  • Proxies — переадресация Unity-callback'ов с дочерних объектов родительским компонентам
  • Property modifiers — динамические характеристики, персональные модификаторы и GameRules
  • GameRules — глобальные границы характеристик, применяемые последними
  • Reflection — список типов, которые SDK находит по контракту, вместо перебора сборки при запуске

Модули

  • Modules — оглавление модулей публичного SDK
  • ModuleSystem — модули и интеграции, которые вырезаются из сборки, окно PRUnitySDK → Модули
  • DamageSystem — создание, модификация и применение урона через хуки; правила урона игры (DamageRules) из настроек проекта, со сцены и из кода
  • GameSessions — сессия карты и раунды с режимами и правилами; одиночная игра и локальный мультиплеер
  • HitBox — связь физических коллайдеров с DamageSystem
  • DOTweenEffects — связь DOTween с логической паузой и PRTimeScale

Интеграции площадок описаны отдельным разделом — «Интеграции площадок».

Текущие ограничения

  • Фреймворк распространяется как Unity Assets, а не как UPM-пакет.
  • Автоматический installer пока не создаёт настройки, слои, теги и prefab'ы.
  • Bootstrap по умолчанию предполагает сцены с индексами 0 и 1.
  • Часть каталогов и API всё ещё находится в процессе переноса и рефакторинга.
  • Не все модули имеют отдельную документацию и тестовое покрытие.
  • Версии нет: понять, на какой сборке фреймворка сделана игра, пока негде.
  • Имя PRUnitySDK зашито в пути Resources, пункты меню и сериализованные ассеты, поэтому переименование требует миграции.

Репозиторий

github.com/prethink/PRUnitySDK

About

WIP

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages