-
Notifications
You must be signed in to change notification settings - Fork 2
Руководство пользования
Исполняемый файл приложения находится в поставляемом архиве. Запуск приложения осуществляется двойным щелчком по файлу с именем 'xrSDK.Editor.DialogEditor.App.exe'. При этом будет показано главное окно приложения.
Для начала работы с редактором необходимо выбрать директорию, в которой находится распакованная папка 'gamedata', содержащая в себе файлы диалогов. Чтобы это сделать требуется выбрать пункт меню 'File' в верхнем левом углу главного окна и в выпадающем списке выбрать пункт 'Open Game directory'. Или же нажать комбинацию клавиш на клавиатуре 'Ctrl + O'. После этого на экране должно быть отображено окно выбора директории. Далее необходимо указать директорию, в которой находится папка 'gamedata'.
Важно, чтобы была указана не сама папка 'gamedata', а именно содержащая её директория. Если была выбрана папка 'gamedata', то редактор автоматически установит родительскую директорию в качестве игровой.
После выбора директории, в иерархическом списке в левой части главного окна должны быть отображены все найденные файлы диалогов.
В случае, если файлы диалогов не были найдены, будет показано сообщение с предложением вручную указать пути к нужным директориям. Тогда следуйте инструкциям, которые указанны в сообщении.
Чтобы начать работу с диалогом необходимо выбрать и раскрыть нужный файл диалогов в иерархическом списке в левой части главного окна и выбрать требуемый диалог из раскрытого списка нажатием левой кнопкой мыши. Для того чтобы раскрыть список диалогов требуется нажать на стрелочку, которая находится слева от имени файла диалога или произвести двойной щелчок по нужному файлу диалогов. При выборе диалога в правой части главного окна будут отображены список фраз и свойств выбранного диалога.
Чтобы добавить диалог необходимо выбрать файл диалога в иерархическом списке в левой части экрана нажав по нему левой кнопкой мыши. После выбора файла необходимо нажать левой кнопкой мыши. В результате должно отобразиться контекстное меню, в котором необходимо выбоать пункт 'Add Dialogue'. При выборе данного пункта, в центре главного окна отобразится поле для ввода имени создаваемого диалога. Требуется ввести имя диалога и нажать кнопку 'ОК' для добавления или кнопку 'Cancel' для отмены. В случае успешного добавления, диалог с указанным именем будет добавлен в конец списка диалогов выбранного файла.
Если поле для ввода не было показано, то проверьте выделен ли файл диалога. Файлы диалога обычно имеют окончание '.xml' и являются корневыми элементами иерархического списка.
Чтобы удалить диалог требуется выбрать его в иерархическом списке в левой части главного окна, нажать правую кнопку мыши и в появившемся контекстном меню выбрать пункт 'Remove dialog'. После этого выбранный диалог должен исчезнуть из списка.
Если удаления не произошло, то проверьте выделен ли нужный диалог в списке.
Чтобы сохранить все внесенные изменения необходимо нажать в левом верхнем углу пункт меню 'File' и в выпадающем списка выбрать пункт 'Save All'. Или же нажать комбинацию клавиш на клавиатуре 'Ctrl + S'. В случае успешного сохранения файлов в в правой нижней части окна появится соответствующее уведомление.
Если сохранение файлов завершилось некорректно попробуйте проверить для файлов диалогов флаги 'Толко для чтения' или права доступа пользователя. Подробнее о том как это сделать смотрите в руководстве пользования Вашей операционной системы.
Чтобы выбрать фразу необходимо нажать левой кнопкой мыши по прямоугольнику на главной сцене в центре главного окна или в списке фраз в правой части окна. Тогда в нижнем списке в правой части главного окна будут отображены свойства выбранной фразы.
Чтобы добавить фразу необходимо нажать правой кнопкой мыши по главной сцене в центре главного окна или по списку фраз в правой части окна и в появившемся контекстном меню выбрать пункт 'Add Phrase'. После этого в центре окна будет отображено поле для ввода локализованной строки или идентификатора. Требуется ввести в верхнее поле текст новой фразы или идентификатор существующей фразы в нижнем поле и нажать кнопку 'OK'. После этого на сцену будет добавлена новая фраза.
Для удаления фразы необходимо выбрать одну или несколько фраз нажав на них левой кнопкой мыши с зажатой клавишей Ctrl. Далее требуется нажать правую кнопку мыши по главной сцене и выбрать в появившемся контекстном меню пункт 'Remove Phrase'.
Чтобы изменить текст фразы необходимо произвести двойной щелчок левой кнопкой мыши по полю для ввода во фразе. Тогда будет открыто новое окно, в котором требуется ввести новую фразу и нажать кнопку 'OK'.
Чтобы соединить две фразы необходимо нажать левой кнопкой мыши на выход фразы в виде белого кружочка, который проименован словом 'Next' и удерживая кнопку переместить указатель мыши на вход другой фразы в виде белого кружочка, который проименован словом 'Previous' и отпустить кнопку мыши.
Чтобы удалить одно или несколько соединений необходимо нажать правой кнопкой мыши по главной сцене и удерживая кнопку мыши провести указатель так, чтобы появившаяся пунктирная белая линия пересекала нужные соединения. Когда линиия пересечет соединение, то оно изменит свой цвет на красный. Когда нужные соединения будут помечены красным цветом, то необходимо отпустить правую кнопку мыши и выбранные соединения будут удалены со сцены.
Чтобы запустить автоматическую расстановку фраз, требуется нажать правой кнопкой мыши по главной сцене и в появившемся контекстном меню выбрать пункт 'Start Auto Layout'. Чтобы завершить автоматическую расстановку требуется выбрать в появившемся контекстном меню пункт 'Stop Auto Layout'.
Работа со свойствами осуществляется в нижнем списке в правой части главного окна.
Чтобы добавить фразу необходимо нажать правой кнопкой мыши по списку свойств и в появивщемся контекстном меню выбрать пункт 'Add Property'. После этого в появившемся окне необходимо выбрать в выпадающем списке нужное имя свойства и ввести значения этого свойства в соответствующее поле для ввода и нажать кнопку 'Add'. В результате в список свойств будет добавлен новый элемент.
Для удаления свойства необходимо нажать левой кнопкой мыши по нужному элементу в списке свойств, нажать правую кнопку мыши и в появившемся контекстном меню выбрать пункт 'Remove Property'. После этого выбранное свойство будет удалено из списка.
Чтобы изменить значение свойства необходимо произвести двойной щелчок левой кнопкой мыши по тексту в колонке 'Value' нужного свойства в правом нижнем списке. После этого, значение выбранного свойства станет доступным для редактирования.
Чтобы открыть предварительный просмотр диалога, необходимо выбрать в иерархическом списке в левой части главного окна нужный диалог и выбрать в главном меню программы, которое расположено в верхней части, пункт 'Preview'. Тогда будет открыто окно предварительного просмотра диалога, которое имитирует диалоговое окно оригинальной трилогии игр S.T.A.L.K.E.R.
Приложение требует наличия settings.json файла в корневой папке, в противном случае, работа приложения невозможна. Чтобы открыть окно настроек приложения необходимо нажать на пункт меню 'Settings' в верхней части главного окна. После этого в центре экрана будет отображено окно с настройками приложения. Доступно 4 группы настроек: приложение, локализация диалогов и диалоги. Изменение настроек приложение возможно через ручное редактирование settings.json либо через панель настроек в самом приложении.
При редактировании настроек через редактор, возможно два режима применения:
- При нажатии кнопки 'OK' - настройки применятся для текущей сессии и при перезапуске будут утеряны;
- При нажатии кнопки 'Apply' - настройки применятся перманентно, редактор перезапишет файл settings.json.
Настройки приложения осуществляются в окне настроек во вкладке меню 'Application'. Путь к корневой папке с игрой настраивается полем 'Game Directory'. Все остальные пути прописаны как относительные к этой папке. Корневую папку игры можно выбрать в самом редакторе. При изменении папки, приложение заново считает файлы диалогов и локализации. Поле 'Save Nodes Position' - указывает, нужно ли сохранять позиции нод между перезапусками приложения. 'Nodes Position FilePath' - путь к папке, где будут хранится файлы с позициями нод. Если он не задан, то файлы сохраняются в корневой папке приложения.
Настройка локализации диалогов осуществляются в окне настроек во вкладке меню 'Localization'.
- 'Search Pattern' - паттерн, по которому редактор будет искать файлы локализации диалогов.
- 'Languages Root Folder' - путь к папке с локализацией, относительный к 'Game Directory' (обычно это путь к папке 'text').
- 'Language' - имя текущей локализации.
Настройки диалогов осуществляются в окне настроек во вкладке меню 'Dialogues'.
- 'Search Pattern' - паттерн, по которому редактор будет искать файлы диалогов.
- 'Relative Path' - путь к папке с диалогами, относительный к 'Game Directory'.
- 'Available Tags' - список доступных тегов, которые могут быть заданы как свойства или атрибуты для фраз и диалогов.
- Поддерживается локализация фраз;
- Поддерживается управления связью между фразами;
- Поддерживается добавление аттрибутов и свойств к диалогам и фразам;
- Поддерживается считывание локализации фразы по уникальному id фразы в диалоге: <dialog_id>_<phrase_id> и по значению элемента "text" фразы;
- Поддерживается автоматическая расстановка фраз;
- Автоматическое обновление приложения;
- Встроенная проверка орфографии;
- Возможность предварительного просмотра диалога.
- Приложение требует запуск с правами администратора для корректной обработки различных директорий, к которым может не быть доступа в случае с обычными правами.
- Запись позиции ноды происходит спустя 5 секунд после конца ее перемещения. Это значит, что приложение сохранит в память позициию ноды лишь спустя 5 секунд после остановки изменения координат фразы.
- Сохранение всех файлов происходит после нажатия Save All кнопки в меню. Сохранение происходит не моментально, все зависит от кол-ва измененных файлов/секций. Отображение на файле может занять до 20 секунд.
- Авторасстановка фраз осуществляется используя физико-основанный подход. Подробнее можно прочесть здесь: https://github.com/Wouterdek/NodeNetwork/blob/master/NodeNetworkToolkit/Layout/ForceDirected/ForceDirectedLayouter.cs
- Авторасстановка асинхронна. Это означает, что приложение будет автоматически изменять позиции нод, пока явно не будет произведена остановка. (Существует баг, когда несоединенные между собой фразы, при старте авторасстановки, разлетаются на бесконечное расстояние. Будет пофикшено в будущем.)
- Авторасстановка доступна через контекстное меню области нод.
- Управление фразами/диалогами/атрибутами/свойствами так же реализовано через контекстное меню выделенного объекта.
- Приложение поддерживает глобальный логгер ошибочных ситуаций. Папка с логами расположена в корневой папке приложения.
Программное обеспечение разработано командой разработчиков модификации Ray of Hope.
- Collector - Collector#0001 (Discord)
- XDenizX
- -StalkMen-
- guy who bought the world
- Vast
- Belinskiy
- XpycTee
- 1 ГБ оперативной памяти, не ниже;
- 4 ГБ свободного места на HDD или SSD накопителе, не ниже;
- Установленный .NET Core Runtime версии 6.0 или выше;
- Клавиатура;
- Манипулятор/мышь;
- Интернет-соединение со скоростью не ниже 128 Кб/сек. (необходимо для автообновления);
- Приложение тестировалось на операционной системе Windown версии 10. Работа на операционных системах других версий не гарантируется.
- Официальный Discord сервер сообщества Ray of Hope - https://discordapp.com/invite/rffsfku
- Официальная группа в социальной сети 'ВКонтакте' - https://vk.com/roh_online
ДАННОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНО ВЫРАЖЕННЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ ГАРАНТИИ ТОВАРНОЙ ПРИГОДНОСТИ, СООТВЕТСТВИЯ ПО ЕГО КОНКРЕТНОМУ НАЗНАЧЕНИЮ И ОТСУТСТВИЯ НАРУШЕНИЙ, НО НЕ ОГРАНИЧИВАЯСЬ ИМИ. НИ В КАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ПО КАКИМ-ЛИБО ИСКАМ, ЗА УЩЕРБ ИЛИ ПО ИНЫМ ТРЕБОВАНИЯМ, В ТОМ ЧИСЛЕ, ПРИ ДЕЙСТВИИ КОНТРАКТА, ДЕЛИКТЕ ИЛИ ИНОЙ СИТУАЦИИ, ВОЗНИКШИМ ИЗ-ЗА ИСПОЛЬЗОВАНИЯ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ИЛИ ИНЫХ ДЕЙСТВИЙ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.