Skip to content

README_RU.md

Latest commit

 

History

History
48 lines (35 loc) · 3.84 KB

README_RU.md

File metadata and controls

48 lines (35 loc) · 3.84 KB

Commandlet Runner

English | Русский | Назад к UE Forge

Обнаружение и запуск командлетов Unreal Engine с автогенерацией информации об использовании.

comandlet_runner_ru.png

Возможности

  • Сканирование исходников — обходит Source/ движка и проекта в поиске подклассов UCommandlet, находит их по паттернам наследования в .h / .cpp
  • Извлечение описаний — берёт описания из комментариев над объявлением класса, свойства HelpDescription в конструкторах и строк HelpUsage
  • Обнаружение параметров — генерирует подсказки по использованию из паттернов FParse::Param, FParse::Value и FParse::Bool в исходниках командлета
  • Избранное — пометка командлетов звёздочкой для быстрого доступа, сохраняется в commandlet_favorites.json
  • Заметки — текстовые заметки к каждому командлету с отложенным автосохранением в commandlet_notes.json
  • Живая консоль — вывод командлета в реальном времени с подсветкой уровней логирования
  • Интеграция с движком — использует тот же механизм обнаружения движков, что и Plugin Builder, запускает командлеты через UE4Editor-Cmd.exe / UnrealEditor-Cmd.exe

Запуск

python -m ue_forge.commandlet_runner
# или в хосте:
python -m ue_forge   # → "Командлеты" в сайдбаре
  1. Выберите .uproject (или перетащите)
  2. Укажите версию движка
  3. Просмотрите найденные командлеты — поиск для фильтрации, звёздочка для избранного
  4. Выберите командлет для просмотра описания, параметров и usage
  5. Настройте аргументы и нажмите Run
  6. Следите за выводом в консоли

Как работает обнаружение

Сканер обходит директории Source/ в установке движка и выбранном проекте, ища файлы с объявлениями подклассов UCommandlet. Для каждого найденного:

  1. Имя класса извлекается из паттерна наследования (class XCommandlet : public UCommandlet)
  2. В .h и .cpp ищутся блоки комментариев непосредственно над объявлением класса
  3. Тела конструкторов сканируются на присвоения HelpDescription, HelpUsage, HelpWebLink, IsServer, IsClient, IsEditor, LogToConsole
  4. Весь .cpp сканируется на вызовы FParse::Param("ParamName"), FParse::Value("Key", ...), FParse::Bool("Flag") для построения списка параметров

Файлы данных

Файл Расположение Описание
commandlet_favorites.json Директория конфига Список помеченных звёздочкой командлетов
commandlet_notes.json Директория конфига Словарь имя командлета → текст заметки