# Конфигурация

Конфигурация движка хранится в нескольких скриптовых ассетах, расположенных в папке Assets/NaninovelData/Resources/Naninovel/Configuration. Они автоматически генерируются при первом открытии соответствующих меню конфигурации в редакторе Unity.

Используйте Naninovel -> Configuration или Edit -> Project Settings -> Naninovel для доступа к меню конфигурации.

Обратите внимание, что все меню конфигурации поддерживают функцию пресетов Unity. Это может помочь в создании нескольких пресетов конфигурации при подготовке сборок для различных целевых платформ (например, мобильных, standalone, консольных и т.д.).

Можно изменять объекты конфигурации во время выполнения, добавлять новые пользовательские конфигурации и изменить способ доступа к объектам во время выполнения (например, считывать конфигурацию из JSON файлы, хранящихся на удаленном устройстве); см. руководство по пользовательским настройкам для получения дополнительной информации.

ПРИМЕЧАНИЕ

Данная информация о конфигурации актуальна для Naninovel v1. 10.

# Аудио

Свойство Значение по умолчанию Описание
Audio Loader Audio- (Addressable, Project) Отвечает за конфигурацию загрузчика ресурсов, используемого при работе с аудиоресурсами (BGM и SFX).
Voice Loader Voice- (Addressable, Project) Отвечает за конфигурацию загрузчика ресурсов, используемого при работе с аудиоресурсами голосовой озвучки.
Default Master Volume 1 Уровень звукового мастер-канала при первом запуске игры.
Default Bgm Volume 1 Уровень канала BGM при первом запуске игры.
Default Sfx Volume 1 Уровень канала SFX при первом запуске игры.
Default Voice Volume 1 Уровень канала голосовой озвучки при первом запуске игры.
Enable Auto Voicing False При включении параметра каждая команда PrintText будет пытаться проиграть голосовой клип из VoiceResourcesPrefix/ScriptName/LineIndex.ActionIndex.
Voice Overlap Policy Prevent Overlap Диктует принципы обработки одновременно воспроизводящихся голосов:
• Allow Overlap – одновременно звучащие голоса будут воспроизводиться без ограничений.
• Prevent Overlap — предотвращает одновременное воспроизведение путем остановки воспроизводимого в данный момент голосового клипа перед воспроизведением нового.
• Prevent Character Overlap – предотвращает одновременное воспроизведение голосовых клипов для персонажа; голоса разных персонажей (автоматическое озвучивание) и любое количество команд @voice могут быть воспроизведены одновременно.
Custom Audio Mixer Null Аудиомикшер для контроля аудиогрупп. По умолчанию использует стандартный, если никакого иного не предоставлено.
Master Volume Handle Name Master Volume Имя обработчика микшера (предоставленный параметр) для управления уровнем мастер-канала.
Bgm Group Path Master/BGM Путь к группе микшера для управления уровнем BGM канала.
Bgm Volume Handle Name BGM Volume Имя обработчика микшера (предоставленный параметр) для управления уровнем BGM канала.
Sfx Group Path Master/SFX Путь к группе микшера для управления уровнем SFX канала.
Sfx Volume Handle Name SFX Volume Имя обработчика микшера (предоставленный параметр) для управления уровнем SFX канала.
Voice Group Path Master/Voice Путь к группе микшера для управления уровнем канала голосовой озвучки.
Voice Volume Handle Name Voice Volume Имя обработчика микшера (предоставленный параметр) для управления уровнем канала озвучки.

# Фоны

Свойство Значение по умолчанию Описание
Default Metadata Object Ref Метаданные, используемые по умолчанию при создании фоновых акторов, и пользовательские метаданные для созданного актора с неуказанным ID.
Metadata Object Ref Метаданные, используемые при создании фоновых акторов с конкретным ID.
Scene Origin (0.5, 0.0) Исходная точка, используемая для отсчета при позиционировании актеров в сцене.
Z Offset 100 Начальное смещение по оси Z (глубина) акторов относительно камеры, установленное при создании акторов.
Z Step 0.1 Расстояние по оси Z, установленное между акторами при их создании; используется для предотвращения проблем наложения.
Default Easing Linear Функция смягчения, используемая по умолчанию для всех анимаций модификации актора (изменение внешности, положения, оттенка и пр.).
Auto Show On Modify True Следует ли автоматически выводить (показывать) актора при выполнении команд модификации.

# Камера

Свойство Значение по умолчанию Описание
Reference Resolution (1920, 1080) Эталонное разрешение используется для оценки правильных размеров рендеринга, чтобы спрайтовые ассеты (например, фоны и персонажи) были правильно расположены на сцене. Как правило, должно быть установлено в значение, равное разрешению фоновых текстур, которые вы используете в игре.
Auto Correct Ortho Size True Следует ли автоматически корректировать ортогональный размер кадра на основе текущего соотношения сторон дисплея, чтобы обеспечить правильное расположение фонов и персонажей.
Default Ortho Size 5.35 Ортогональный размер, устанавливаемый по умолчанию при отключенной автоматической коррекции.
Initial Position (0.0, 0.0, -10.0) Исходное положение камеры в пространстве.
Orthographic True Должна ли камера по умолчанию рендерить в ортогональном (включен) или перспективном (отключен) режиме. Не имеет эффекта, когда назначается пользовательский префаб камеры.
Custom Camera Prefab Null Префаб с компонентом камеры, используемой для рендеринга. Будет использоваться стандартный, если иного не указано. Если вы хотите настроить некоторые свойства камеры (цвет фона, FOV, HDR и т.д.) или добавить сценарии постобработки, создайте префаб с необходимой настройкой камеры и назначьте данный префаб этому полю.
Use UI Camera True Следует ли визуализировать пользовательский интерфейс в отдельной камере. Это позволит использовать раздельные конфигурации для основной камеры и камеры UI и предотвратить влияние эффектов постобработки (изображения) на пользовательский интерфейс за счет незначительных ресурсных расходов на рендеринг.
Custom UI Camera Prefab Null Префаб с компонентом камеры, используемой для рендеринга пользовательского интерфейса. Будет использоваться стандартный, если иного не указано. Не имеет никакого эффекта, если параметр UseUICamera отключен.
Default Easing Linear Функция смягчения, используемая по умолчанию для всех модификаций камеры (изменение масштаба, положение, поворот и пр.).
Thumbnail Resolution (240, 140) Разрешение, в котором будут захвачены миниатюры для превью в слотах сохранения.
Hide UI In Thumbnails False Игнорировать ли слой интерфейса при захвате миниатюр.

# Персонажи

Свойство Значение по умолчанию Описание
Auto Arrange On Add True Следует ли равномерно распределять персонажей по оси X при добавлении нового персонажа без заданной позиции.
Default Metadata Object Ref Метаданные, используемые по умолчанию при создании акторов персонажей; пользовательские метаданные для созданного актора без указанного ID.
Metadata Object Ref Метаданные, используемые при создании акторов персонажей с определенными ID.
Avatar Loader Character Avatars- (Addressable, Project) Конфигурация загрузчика ресурсов, используемого для ресурсов текстур аватаров персонажей.
Scene Origin (0.5, 0.0) Исходная точка отсчета при позиционировании акторов в сцене.
Z Offset 50 Начальное смещение по оси Z (глубина) акторов относительно камеры, установленное при создании акторов.
Z Step 0.1 Расстояние по оси Z, установленное между акторами при их создании; используется для предотвращения проблем наложения.
Default Easing Smooth Step Функция смягчения, используемая по умолчанию для всех анимаций модификации актора (изменение внешности, положения, оттенка и пр.).
Auto Show On Modify True Следует ли автоматически выводить (показывать) актора при выполнении команд модификации.

# Обработчики вариантов выбора

Свойство Значение по умолчанию Описание
Default Handler Id Button List ID обработчика выбора, используемое по умолчанию.
Default Metadata Object Ref Метаданные, используемые по умолчанию при создании акторов обработчиков; пользовательские метаданные для созданного актора без указанного ID.
Metadata Object Ref Метаданные, используемые при создании акторов обработчиков с определенными ID.
Default Easing Linear Функция смягчения, используемая по умолчанию для всех анимаций модификации актора (изменение внешности, положения, оттенка и пр.).
Auto Show On Modify True Следует ли автоматически выводить (показывать) актора при выполнении команд модификации.

# Пользовательские переменные

Свойство Значение по умолчанию Описание
Predefined Variables Object Ref Список переменных для инициализации по умолчанию. Глобальные переменные (имена которых начинаются с G_ или g_) инициализируются при первом запуске приложения, а другие – при каждом сбросе состояния.

# Движок

Свойство Значение по умолчанию Описание
Generated Data Path Naninovel Data Относительный (к каталогу данных приложения) путь для хранения автоматически сгенерированных ассетов.
Override Objects Layer False Следует ли назначать определенный слой всем объектам движка. Камера движка будет использовать слой для обрезной маски. Используйте это, чтобы изолировать объекты Naninovel от визуализации другими камерами.
Objects Layer 0 Если включен параметр Override Objects Layer, указанный слой будет присвоен всем объектам движка.
Async Exception Log Type Error Тип лога для исключений, связанных с UniTask.
Initialize On Application Load True Следует ли автоматически инициализировать движок при запуске приложения.
Show Initialization UI True Показывать ли UI загрузки во время инициализации движка.
Custom Initialization UI Null UI для отображения во время инициализации движка (если он включен). Будет использован стандартный, если иного не указано.
Show Title UI True Следует ли автоматически отображать UI титульного экрана (главное меню) после инициализации движка. Вы можете изменить пользовательский интерфейс титульного экрана с помощью функции настройки пользовательского интерфейса (см. онлайн-руководство для получения дополнительной информации).
Enable Development Console True Нужно ли включать консоль разработки.
Toggle Console Key Back Quote Клавиша, используемая для доступа к консоли разработки. Вы также можете включать консоль с помощью нескольких (3 или более) касаний при использовании сенсорных экранов.

# Ввод

Свойство Значение по умолчанию Описание
Spawn Event System True Следует ли создавать систему событий при инициализации.
Custom Event System Null Префаб с компонентом EventSystem, который будет создаваться для обработки входящих данных. Будет создан стандартный, если иного не указано.
Spawn Input Module True Следует ли создавать модуль ввода при инициализации.
Custom Input Module Null Префаб с компонентом InputModule, который будет создаваться для ввода данных. Будет создан стандартный, если иного не указано.
Touch Frequency Limit 0.1 Ограничивает частоту регистрируемых вводных команд, в секундах.
Process Legacy Bindings True Следует ли обрабатывать устаревшие вводные привязки. Отключите его, если вы используете новую систему ввода Unity и не хотите, чтобы устаревшие привязки работали в дополнение к действиям ввода.
Bindings Object Ref Привязки для обработки вводных данных.

# Локализация

Свойство Значение по умолчанию Описание
Loader Localization- (Addressable, Project) Конфигурация загрузчика ресурсов, используемого для ресурсов локализации.
Source Locale En Локаль исходных ресурсов проекта (языка, на котором были созданы ресурсы проекта).
Default Locale Null Локаль, используемая по умолчанию при первом запуске игры. Будет использована Source Locale, если иная не указана.

# Управляемый текст

Свойство Значение по умолчанию Описание
Loader Text- (Addressable, Project) Конфигурация загрузчика ресурсов, используемого для управляемых текстовых документов.

# Видеоролики

Свойство Значение по умолчанию Описание
Loader Movies- (Addressable, Project) Конфигурация загрузчика ресурсов, используемого для ресурсов видеороликов.
Skip On Input True Следует ли пропускать воспроизведение ролика при нажатии пользователем клавиши команды cancel.
Skip Frames True Можно ли пропускать кадры, чтобы догнать текущее время.
Fade Duration 1 Время в секундах для плавного появления/затухания перед началом/окончанием воспроизведения ролика.
Custom Fade Texture Null Текстура для появления/затухания. Будет использована простая черная, если иная не задана.
Play Intro Movie False Следует ли автоматически воспроизводить интро-ролик после инициализации движка и перед отображением главного меню.
Intro Movie Name Null Путь к ресурсу интро-ролика.

# Провайдер ресурсов

Свойство Значение по умолчанию Описание
Resource Policy Static Диктует политику загрузки и выгрузки ресурсов во время выполнения скрипта:
• Статическая — все ресурсы, необходимые для выполнения сценария, предварительно загружаются при запуске воспроизведения (маскируются загрузочным экраном) и выгружаются только после завершения воспроизведения сценария. Эта политика используется по умолчанию и рекомендуется для большинства случаев.
• Динамическая — во время выполнения сценария предварительно загружаются только ресурсы, необходимые для выполнения следующих команд количеством, указанным в Dynamic Policy Steps, а все неиспользуемые ресурсы немедленно выгружаются. Используйте этот режим при работе с платформами со строгими ограничениями памяти и невозможностью правильно организовать сценарии Naninovel. При загрузке ресурсов в фоновом режиме во время игры могут наблюдаться сбои.
Dynamic Policy Steps 25 определяя количество команд скрипта для предварительной загрузки, когда включена динамическая политика ресурсов.
Optimize Loading Priority True Понижает приоритет потока фоновой загрузки Unity, чтобы предотвратить сбои при загрузке ресурсов во время воспроизведения.
Log Resource Loading False Следует ли выводить операции загрузки ресурсов на экране загрузки.
Enable Build Processing True Следует ли регистрировать пользовательский обработчик воспроизведения для обработки ресурсов, назначенных в качестве ресурсов Naninovel.

Предупреждение: чтобы эта настройка вступила в силу, необходимо перезапустить редактор Unity.
Use Addressables True При установке адресируемой системы ассетов включение этого свойства оптимизирует этап обработки ассетов, уменьшая время загрузки.
Auto Build Bundles True Следует ли автоматически создавать адресируемые пакеты ассетов при создании плеера. Не имеет эффекта, когда Use Addressables отключено.
Allow Addressable In Editor False Следует ли использовать адресируемый провайдер в редакторе. Включите его, если вы вручную назначаете ресурсы с помощью адресации, а не назначаете их менеджерам ресурсов Naninovel. Имейте в виду, что включение этого может вызвать проблемы, когда ресурсы как назначаются в диспетчере ресурсов, так и регистрируются с помощью адресации, после чего переименовываются или дублируются.
Extra Labels Null Адресируемый провайдер будет работать только с ассетами, которые имеют назначенные метки в дополнение к метке Naninovel. Может использоваться для фильтрации ассетов, используемых движком, на основе пользовательских критериев (например, HD и SD текстуры).
Local Root Path %DATA%/Resources Корневой путь, используемый для локального провайдера ресурсов. Это может быть абсолютный путь к папке, в которой находятся ресурсы, или относительный путь с одним из доступных источников:
• %DATA% — папка игровых данных на целевом устройстве (UnityEngine.Application.dataPath).
• %PDATA% – каталог постоянных данных на целевом устройстве (UnityEngine.Application.persistentDataPath).
• %STREAM% - папка StreamingAssets (UnityEngine.Application.streamingAssetsPath).
• %SPECIAL{F}% - специальная папка ОС (где F – значение из System.Environment.SpecialFolder).
Project Root Path Naninovel Путь относительно папок Resources, в которых находятся специфические для Naninovel ассеты.
Google Drive Root Path Resources Корневой путь, используемый для провайдера ресурсов Google Drive.
Google Drive Request Limit 2 Максимум допустимых одновременных запросов при обращении к API Google Drive.
Google Drive Caching Policy Smart Политика кэша, используемая при загрузке ресурсов. Smart попытается использовать Changes API, чтобы проверить наличие изменений на диске. PurgeAllOnInit повторно загрузит все ресурсы при инициализации провайдера.

# Плеер сценариев

Свойство Значение по умолчанию Описание
Skip Time Scale 10 Шкала ускорения времени в режиме пропуска (быстрой перемотки вперед).
Min Auto Play Delay 3 Минимум секунд ожидания перед выполнением следующей команды в режиме авточтения.
Show Debug On Init False Нужно ли показывать окно отладки плеера при инициализации движка.

# Сценарии

Свойство Значение по умолчанию Описание
Loader Scripts- (Addressable, Project) Конфигурация загрузчика ресурсов, используемого для ресурсов сценариев Naninovel.
Initialization Script Null Имя сценария, воспроизводимого сразу после инициализации движка.
Title Script Null Имя сценария, воспроизводимого при отображении титульного экрана. Может использоваться для настройки сцены титульного экрана (фон, музыка и т.д.).
Start Game Script Null Имя сценария, воспроизводимого при запуске новой игры. Будет использован первый доступный, если иного не указано.
Auto Add Scripts True Следует ли автоматически добавлять созданные сценарии Naninovel к ресурсам.
Hot Reload Scripts True Следует ли повторно загружать измененные (как с помощью визуального, так и внешнего редакторов) сценарии и применять изменения во время воспроизведения без перезапуска.
Count Total Commands False Следует ли вычислять количество команд, существующих во всех доступных сценариях Naninovel при инициализации сервиса. Если вы не используете свойство TotalCommandsCount диспетчера сценариев и функцию CalculateProgress в выражениях сценариев Naninovel, отключите данное свойство, чтобы сократить время инициализации движка.
Enable Visual Editor True Следует ли открывать визуальный редактор сценариев при выборе файла сценария.
Hide Unused Parameters True Следует ли скрывать неназначенные параметры командных строк, когда строка не под курсором или не выбрана.
Insert Line Key Space Горячая клавиша для отображения окна Insert Line, когда выбран визуальный редактор. Установите значение None, чтобы отключить.
Insert Line Modifier Control Модификатор для Insert Line Key. Установите значение None, чтобы отключить.
Save Script Key S Горячая клавиша для сохранения (сериализации) отредактированного сценария, когда выбран визуальный редактор. Установите значение None, чтобы отключить.
Save Script Modifier Control Модификатор для Save Script Key. Установите значение None, чтобы отключить.
Editor Page Length 1000 Сколько строк сценария должно быть отображено на одной странице визуального редактора.
Editor Custom Style Sheet Null Позволяет изменять стандартный стиль визуального редактора.
Graph Orientation Horizontal Строить график вертикально или же горизонтально.
Graph Auto Align Padding (10.0, 0.0) Добавление отступов для каждого узла при выполнении автоматического выравнивания.
Graph Custom Style Sheet Null Позволяет изменять стандартный стиль графика сценария.
Enable Community Modding False Следует ли разрешить добавление внешних сценариев Naninovel в сборку.
External Loader Scripts- (Local) Конфигурация загрузчика ресурсов, используемого для ресурсов внешних сценариев Naninovel.
Enable Navigator True Следует ли инициализировать навигатор сценариев для просмотра доступных сценариев Naninovel.
Show Navigator On Init False Следует ли показывать навигатор сценариев Naninovel, когда инициализирован менеджер сценариев.
Navigator Sort Order 900 Порядок сортировки UI навигатора сценариев.

# Создание экземпляров

Свойство Значение по умолчанию Описание
Loader Spawn- (Addressable, Project) Конфигурация загрузчика ресурсов, используемого для создаваемых экземпляров ресурсов.

# Состояние

Свойство Значение по умолчанию Описание
Save Folder Name Saves Папка (сохранений), которая будет создана в папке игровых данных.
Default Settings Slot Id Settings Имя файла настроек сохранения.
Default Global Slot Id Global Save Имя файла глобального сохранения.
Save Slot Mask Game Save{0:000} Формат названия слотов сохранения.
Quick Save Slot Mask Game Quick Save{0:000} Формат названия слотов быстрого сохранения.
Save Slot Limit 99 Максимум слотов сохранения.
Quick Save Slot Limit 18 Максимум слотов быстрого сохранения.
Binary Save Files True Следует ли сжимать и хранить сохраненные файлы в виде двоичных файлов (.nson) вместо текстовых файлов (.json). Это значительно уменьшит размер файлов и затруднит их редактирование (чтобы предотвратить читерство), но будет потреблять больше памяти и ресурсов ЦП при сохранении и загрузке.
Load Start Delay 0.3 Ожидание в секундах перед началом операции загрузки; используется для завершения анимации предварительной загрузки до того, как возникнут какие-либо связанные с загрузкой сбои.
Reset On Goto True Следует ли сбрасывать состояние сервисов движка и выгружать (утилизировать) ресурсы при загрузке другого сценария при исполнении команды @goto. Рекомендуется оставить этот параметр включенным, чтобы предотвратить проблемы с утечкой памяти. Если вы решите отключить эту опцию, вы все равно сможете сбрасывать состояние и выгружать ресурсы вручную в любое время с помощью команды @resetState.
Enable State Rollback True Следует ли включить функцию отката, позволяющую игроку перемотать сценарий назад.
State Rollback Steps 1024 Количество снимков состояния, сохраняемых во время выполнения; определяет, как далеко назад может быть выполнен откат (перемотка назад). Увеличение этого значения будет потреблять больше памяти.
Saved Rollback Steps 128 Количество снимков состояния для сериализации (сохранения) в слотах сохранения; определяет, как далеко назад может быть выполнен откат после загрузки сохраненной игры. Увеличение этого значения приведет к увеличению файлов сохранений.
Game State Handler Naninovel.IO Game State Slot Manager, Elringus.Naninovel.Runtime, Version=0.0.0.0, Culture=neutral, Public Key Token=null Реализация, ответственная за де-/сериализацию локального (специфичного для игровой сессии) состояния игры; см. руководство State Management о том, как добавить пользовательские обработчики сериализации.
Global State Handler Naninovel.IO Global State Slot Manager, Elringus.Naninovel.Runtime, Version=0.0.0.0, Culture=neutral, Public Key Token=null Реализация, ответственная за де-/сериализацию глобального состояния игры; см. руководство State Management о том, как добавить пользовательские обработчики сериализации.
Settings State Handler Naninovel.IO Settings Slot Manager, Elringus.Naninovel.Runtime, Version=0.0.0.0, Culture=neutral, Public Key Token=null Реализация, ответственная за де-/сериализацию игровых настроек; см. руководство State Management о том, как добавить пользовательские обработчики сериализации.

# Текстовые принтеры

Свойство Значение по умолчанию Описание
Default Printer Id Dialogue ID текстового принтера, используемого по умолчанию.
Max Reveal Delay 0.06 Ограничение задержки (в секундах) при выводе (печати) текстовых сообщений. Конкретная скорость вывода устанавливается через message speed в настройках игры; это значение определяет доступный диапазон (чем выше значение, тем ниже скорость вывода).
Max Auto Wait Delay 0.02 Ограничение задержки (в секундах) на каждый печатный символ во время ожидания продолжения в режиме авточтения. Конкретная задержка устанавливается с помощью auto delay в настройках игры; это значение определяет доступный диапазон.
Scale Auto Wait True Следует ли масштабировать время ожидания в режиме авточтения по скорости вывода, установленной в командах вывода.
Default Metadata Object Ref Метаданные, используемые по умолчанию при создании акторов текстовых принтеров, и пользовательские метаданные для созданного актора с неуказанным ID.
Metadata Object Ref Метаданные, используемые при создании акторов с указанными ID.
Scene Origin (0.5, 0.0) Исходная точка отсчета при позиционировании акторов в сцене.
Z Offset 100 Начальное смещение по оси Z (глубина) акторов относительно камеры, установленное при создании акторов.
Z Step 0.1 Расстояние по оси Z, установленное между акторами при их создании; используется для предотвращения проблем наложения.
Default Easing Linear Функция смягчения, используемая по умолчанию для всех анимаций модификации актора (изменение внешности, положения, оттенка и пр.).
Auto Show On Modify False Следует ли автоматически выводить (показывать) актора при выполнении команд модификации.

# Пользовательский интерфейс

Свойство Значение по умолчанию Описание
Loader UI- (Addressable, Project) Конфигурация загрузчика ресурсов, используемого для ресурсов UI.
Objects Layer 5 Слой, назначаемый для элементов UI, создаваемых движком. Используется для обрезки при использовании функции UI toogle UI.
Render Mode Screen Space Camera Режим визуализации, применяемый для всех управляемых элементов UI.
Sorting Offset 1 Смещение сортировки, применяемое для всех управляемых элементов UI.

# Разблокируемые ресурсы

Свойство Значение по умолчанию Описание
Loader Unlockables- (Addressable, Project) Конфигурация загрузчика ресурсов, используемого для разблокируемых ресурсов.
Обновлено: September 29, 2020