К содержимому

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

SUS — набор Unity-пакетов. Начните с бесплатных Core + Router, затем добавьте Kit / Game, когда понадобится библиотека компонентов.

Требования

  • Unity 6000.3+ (UI Toolkit)
  • Git (для UPM git-зависимостей)

Установка бесплатных пакетов (git UPM)

В Packages/manifest.json вашего Unity-проекта:

json
{
  "dependencies": {
    "com.sharq-it.sus.core": "https://github.com/antaresdk/sus-core.git#v1.0.29",
    "com.sharq-it.sus.router": "https://github.com/antaresdk/sus-router.git#v1.0.16"
  }
}

Для воспроизводимых установок лучше тег релиза; #main следит за tip.

Первый экран

  1. Предпочтительно Window → SUS → Setup Project — создаёт sus.config.json и копирует готовый starter (HomeScreen.sharq + уже сгенерированный Generated/HomeScreen.g.cs + entry SusApp). Первая генерация не нужна — компилируется сразу (без chicken-and-egg).
  2. Или полный гайд по интеграции (точка входа, overlay vs world-space, порядок генерации).
  3. Без сгенерированных .g.cs код, который делает Mount экрана, не скомпилируется — а сломанный domain может помешать Sharq перегенерировать себя. Подробности в секции Critical того гайда.

Минимальный .sharq (App.sharq — тип, на который ссылается Mount<App>() ниже):

xml
<!-- App.sharq -->
<template>
  <ui:Label $MainElement :text="Message" class="greeting" />
</template>
<script>
public string Message = "Hello SUS!";
</script>
<style>
.greeting {
  font-size: 24px;
  color: white;
  -unity-text-align: middle-center;
}
</style>

Вёрстка и внешний вид — в <style> (USS). Предпочитайте классы вместо C# element.style.*. Подробнее: формат .sharq · полный гайд.

csharp
public class AppEntry : MonoBehaviour
{
    public UIDocument uiDocument;
    void Start() =>
        Sharq.Core.SusApp.Create(uiDocument)
            .UseTheme(SusTheme.Dark)
            .Mount<App>(); // creates OverlayHost + world panel
}

Дальше

ТемаСсылка
Что такое SUS?Обзор
Подсветка .sharq в VS CodeНастройка редактора
Полный гайд coreGuide
.sharq + <style>Формат · CSS scoping
РеактивностьProp / Computed / Watch
RouterДокументация Router
КомпонентыКаталог
ЦеныKit & Game