README.rus.md

IX-Ray Engine 1.6

Стабильный репозиторий модернизированного игрового движка X-Ray 1.6

English | Русский

Обзор

IX-Ray - это форк движка X-Ray 1.6, который направлен на улучшение игрового процесса и упрощение разработки модификаций

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

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

Последнюю версию движка можно скачать на странице релизов

Возможности

• Поддержка архитектур: x64
• Система сборки CMake
• Поддерживаемые рендеры: DirectX 9.0c, DirectX 11
• Улучшенная производительность и повышенный FPS
• Загрузка уровней ускорена в 3-4 раза
• Расширены возможности для модмейкеров
• Исправление оригинальных ошибок
• Поддержка инструментов отладки: ASAN, RenderDoc и LuaPanda
• Поддержка DLTX и XMLOverride
• Поддержка внутриигровых инструментов отладки
• Поддержка системы TTF шрифтов
• Расширены возможности рендеринга
• Поддержка формата сжатия BC7
• Поддержка технологий NVIDIA DLSS и AMD FidelityFX Super Resolution 2 (FSR2)
• Расширены возможности геймплея
• Расширены возможности UI
• Расширены возможности Lua

Минимальные системные требования

• ОС: Windows 7 SP1 с установленным Platform Update или новее
• ЦПУ: Поддержка SSE2 или более новых инструкций
• ОЗУ: 4 Гб
• ГПУ: Поддержка Shader Model 3.0 или новее
• ГПУ VRAM: 512 Мб
• DirectX: 9.0с или новее

Требования

Для запуска:

• OpenAL Driver
• Visual C++ Redistributable
• DirectX End-User Runtime
• Установите оригинальную игру (Steam\GOG)
• Удалите в основной папке игры: bin, gamedata (при наличии)
• Распакуйте архив в основную папку игры с заменой файлов

Для сборки:

• Visual Studio 2022 Community Edition
  • MFC
  • Windows SDK 10.0.19041.0+
• Git
• CMake

Для разработки:

• Visual Studio 2022 Community Edition
• Git
• CMake with CMake GUI

Сборка

Проект может быть собран различными способами. Выберите наиболее удобный из них и следуйте инструкциям

Сначала скачать репозиторий:

# С GitHub
git clone https://github.com/ixray-team/ixray-1.6-stcop.git
# Или с GitLab
git clone https://gitlab.com/ixray-team/ixray/ixray-1.6-stcop.git

Генерация решения Visual Studio

Чтобы сгенерировать решение с настройками по умолчанию с помощью консоли, выполнить следующие действия:

cmake -B build

Для сборки проекта после генерации решения:

• Открыть сгенерированное решение в Visual Sudio
• Выбрать необходимую конфигурацию сборки
• Собрать решение

CMake GUI с Visual Studio

Чтобы сгенерировать папку build и решение:

• Открыть CMake GUI
• Нажать кнопку Browse Source... и открыть папку с проектом
• Выбрать необходимый пресет из выпадающего списка
• Нажать кнопку Configure и затем кнопку Generate

Чтобы собрать проект после генерации решения:

• Открыть сгенерированное решение в Visual Sudio
• Выбрать необходимую конфигурацию сборки
• Собрать решение

CMake с консолью

Чтобы собрать из консоли, выполните следующие действия

• Выбрать один из пресетов из списка и сконфигурировать проект:

  • Engine-x86
  • Engine-x64
  • Server-x86
  • Server-x64
  • Utilities-x86
  • Utilities-x64
  • Plugins-3ds-Max-x64
  • Plugins-Lightwave-x64
  • Compressor-x86
  • Compressor-x64

  cmake --preset <preset-name>
  # Например:
  # cmake --preset Engine-x64

• Выбрать конфигурацию сборки из списка и собрать проект:

  • Debug
  • RelWithDebInfo
  • Release

  cmake --build --preset <preset-name-configuration>
  # Например:
  # cmake --build --preset Engine-x64-Debug

• Запустить скрипт для получения модифицированных файлов и упакованных ассетов

  .\util\generate-patch.bat build\x64\Compressor-Windows\bin\Release\xrCompress.exe

Список изменений

Все значимые изменения в этом репозитории задокументированы в этом файле

Лицензия

Содержимое этого репозитория лицензировано на условиях пользовательской некоммерческой MIT-подобной лицензии, если не указано иное. Подробности смотрите в этом файле

Поддержка

Проект разрабатывается при поддержке этих инструментов

PVS-Studio - статический анализатор для C, C++, C# и Java кода