Skip to content

Commit

Permalink
documentation: updated project information
Browse files Browse the repository at this point in the history
  • Loading branch information
SNMetamorph committed Oct 1, 2023
1 parent 0f3c8aa commit 9ef1fad
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 26 deletions.
25 changes: 14 additions & 11 deletions documentation/docs/eng/intro.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
sidebar_position: 1
description: Modern SDK for the Xash3D FWGS engine, with cross-platform support and improved graphics/physics, while retaining all the features and approaches to work inherent in GoldSrc and Xash3D. Based on XashXT, and therefore has all the functionality inherent in XashXT and Spirit Of Half-Life.
description: Modern Half-Life 1 SDK for the Xash3D FWGS engine, supports cross-platform and have improved graphics & physics, and a lot of new features, while retaining all the features and approaches to work inherent in GoldSrc and Xash3D.
---

# Introduction

![Header](/img/intro/header.png)

### About project
A modern SDK for the Xash3D FWGS engine, to work on modern platforms with cross-platform support and improved graphics/physics, while retaining all the features and approaches to work inherent in GoldSrc and Xash3D.
Based on XashXT, and therefore has all the functionality inherent in XashXT and Spirit Of Half-Life. Suitable for creating both singleplayer and multiplayer mods.
Modern Half-Life 1 SDK for the Xash3D FWGS engine, supports cross-platform and have improved graphics & physics, and a lot of new features, while retaining all the features and approaches to work inherent in GoldSrc and Xash3D.
Based on XashXT, and therefore inherits all the functionality from XashXT and Spirit Of Half-Life. Suitable for creating both singleplayer and multiplayer mods.

### Current functionality
- Compatibility with most of GoldSrc mods
Expand All @@ -20,7 +20,7 @@ Based on XashXT, and therefore has all the functionality inherent in XashXT and
- Extended maximum map size limit (65535x65535x65535 units)
- Automatic exposure correction (eye adaptation effect)
- Support for decals on studiomodels
- Extended model limits (no more need to split into a bunch of `.smd` files)
- Extended model limits (no more need to split into a bunch of smd-files)
- Dynamic lighting with shadows
- Rigid body physics (using PhysX engine)
- Normal mapping support
Expand All @@ -34,19 +34,21 @@ Based on XashXT, and therefore has all the functionality inherent in XashXT and
- Mirrors
- Monitors
- Portals, with the ability to move entities through them
- Own set of utilities for development (compilers of maps, models, model viewer)
- Bunch of utilities for mod development (asset compilers, model/sprite viewers)

### Future plans
- Support for physically based rendering (PBR)
- Support for physically based rendering (PBR), but preserving possibility to switch back to classic lighting model
- Implement GPU-based light baking utility
- Real-time screen space reflections
- Major rendering optimizations
- Updating PhysX SDK to modern version
- Forward+ rendering implementation
- Major rendering optimizations (depth pre-pass, flexible culling system, etc.)
- Total rework of material system
- Implement in-game material editor
- Implement particle engine
- Implement ragdoll physics
- Implement vehicles
- Improvement of NPC's AI
- Adding support for OpenAL Soft / Steam Audio
- Porting to Android
- Bringing the Android port to a working state

### Developers and contributors
- **SNMetamorph** - Lead developer
Expand All @@ -60,6 +62,7 @@ Based on XashXT, and therefore has all the functionality inherent in XashXT and
- **ThomasvonWinkler** - Testing
- **KorteZZ** - Testing

If you wish, you can also take part in the development of PrimeXT: we need testers and programmers with knowledge of C++.
If you wish, you can also take part in the development of PrimeXT - any contribution will be important for us. More details
you can find out about contributing in development on the project [Discord server](https://discord.gg/BxQUMUescJ).

![Footer](/img/intro/footer.png)
6 changes: 3 additions & 3 deletions documentation/docs/rus/entities/ambient_music.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# ambient_music
Позволяет воспроизводить звуковые файлы на карте. Звук проигрывается фоном, и никак не зависит от положения игрока на карте. Идеально подходит для воспроизведения фоновой музыки.
Поддерживаются файлы форматов **`.mp3`**, **`.wma`**, **`.ogg`**, **`.xm`**, **`.it`**, **`.s3m`**
Позволяет воспроизводить звуковые файлы на карте. Звук проигрывается фоном, и никак не зависит от положения игрока на карте. Идеально подходит для воспроизведения фоновой музыки.
Поддерживаемые форматы файлов: `.mp3`, `.wav`

## Настройки
- **`Name`** - Имя энтити
- **`File name`** - Путь до аудио-файла (например `media/Half-Life1.mp3`)
- **`File name`** - Путь до аудио-файла (например, `media/Half-Life1.mp3`)

## Спавнфлаги
- **`Start On`** - Воспроизведение будет запущено с момента появления энтити
Expand Down
27 changes: 15 additions & 12 deletions documentation/docs/rus/intro.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
sidebar_position: 1
description: Современный SDK для движка Xash3D FWGS, с поддержкой кроссплатформенности и улучшенной графикой/физикой, при этом сохраняя все присущие GoldSrc и Xash3D возможности и подходы к работе. Базируется на XashXT, и поэтому имеет в себе весь функционал, присущий XashXT и Spirit Of Half-Life. Подходит для создания как синглплеерных, так и мультиплеерных модов.
description: Современный Half-Life 1 SDK для движка Xash3D FWGS, адаптированный под множество современных платформ, имеет улучшенную графику и физику, сохраняя при этом все присущие GoldSrc и Xash3D возможности и подходы к работе.
---

# Введение

![Header](/img/intro/header.png)

### О проекте
Современный SDK для движка Xash3D FWGS, для работы на современных платформах с поддержкой кроссплатформенности и улучшенной графикой/физикой, при этом сохраняя все присущие GoldSrc и Xash3D возможности и подходы к работе.
Базируется на XashXT, и поэтому имеет в себе весь функционал, присущий XashXT и Spirit Of Half-Life. Подходит для создания как синглплеерных, так и мультиплеерных модов.
Современный Half-Life 1 SDK для движка Xash3D FWGS, адаптированный под множество современных платформ, имеет улучшенную графику и физику, сохраняя при этом все присущие GoldSrc и Xash3D возможности и подходы к работе.
Базируется на XashXT, поэтому наследует весь функционал из XashXT и Spirit Of Half-Life. Подходит для создания как синглплеерных, так и мультиплеерных модов.

### Функционал на данный момент
- Совместимость с большинством модификаций оригинального GoldSrc
Expand All @@ -20,9 +20,9 @@ description: Современный SDK для движка Xash3D FWGS, с по
- Расширенный лимит на размер карты (65535x65535x65535 юнитов)
- Автоматическая коррекция экспозиции (эффект адаптации глаз)
- Поддержка декалей на моделях
- Расширенные лимиты моделей (больше не нужно разбивать на кучу `.smd` файлов)
- Расширенные лимиты моделей (больше не нужно разбивать на кучу smd-файлов)
- Динамическое освещение с поддержкой теней
- Физика твёрдых тел (с использованием движка PhysX)
- Физика твёрдых тел (используется движок PhysX)
- Нормал-маппинг
- Параллакс-маппинг
- Отражения с использованием кубических карт
Expand All @@ -34,19 +34,21 @@ description: Современный SDK для движка Xash3D FWGS, с по
- Зеркала
- Мониторы
- Порталы, с возможностью перемещения энтитей через них
- Собственный набор утилит для разработки (компиляторы карт, моделей, просмотрщик моделей)
- Собственный набор утилит для разработки (компиляторы ассетов, просмотрщик моделей/спрайтов)

### Планы на будущее
- Поддержка физически корректного рендеринга (PBR)
- Поддержка физически корректного рендеринга (PBR) с возможностью переключиться на старую модель освещения при необходимости
- Создание утилиты для предрасчёта освещения на GPU
- Реализация Forward+ рендеринга
- Реалтайм отражения в экранном пространстве (Screen Space Reflections)
- Масштабная оптимизация рендеринга
- Обновление PhysX SDK до современной версии
- Масштабная оптимизация рендеринга (depth pre-pass, более гибкая система куллинга и т.д.)
- Полная переработка системы материалов
- Создание внутриигрового редактора материалов
- Реализация движка партиклей
- Реализация поддержки ragdoll-физики
- Реализация транспорта
- Улучшение интеллекта NPC
- Добавление поддержки OpenAL Soft / Steam Audio
- Портирование на Android
- Доведение порта под Android до работоспособного состояния

### Разработчики и соучастники
- **SNMetamorph** - Ведущий разработчик
Expand All @@ -60,6 +62,7 @@ description: Современный SDK для движка Xash3D FWGS, с по
- **ThomasvonWinkler** - Тестирование
- **KorteZZ** - Тестирование

При желании вы также можете принять участие в разработке PrimeXT: нам нужны тестировщики и программисты с знанием C++.
При желании вы также можете принять участие в разработке PrimeXT - для нас важен любой вклад. Подробнее
про соучастие в разработке вы можете узнать на [Discord сервере проекта](https://discord.gg/BxQUMUescJ).

![Footer](/img/intro/footer.png)

0 comments on commit 9ef1fad

Please sign in to comment.