update readme

This commit is contained in:
NightFox 2022-07-30 16:24:44 +03:00
parent 38fa827aa3
commit 75091c76fd
3 changed files with 52 additions and 51 deletions

3
readme.en.md Normal file
View File

@ -0,0 +1,3 @@
# Repository for Half-Life PBR materials
TBD

View File

@ -1,53 +1,4 @@
# Repository for Half-Life PBR materials # Repository for Half-Life PBR materials
## In English * ## [English](https://rtxash.omgwtf.ru/Half-Life-RTX/Half-Life-PBR/src/branch/master/readme.en.md)
* ## [Русский](https://rtxash.omgwtf.ru/Half-Life-RTX/Half-Life-PBR/src/branch/master/readme.ru.md)
TBD
## На русском
### Общий подход разработки
1. Вы должны знать [основы Git.](https://githowto.com/ru) Возможно позже будет специальный сервис где вы сможете загрузить текстуры и поправить материалы без технических знаний по Git.
2. Попросите регистрацию у Провода.
3. После регистрации форкните Half-Life-PBR на свою учётную запись (справа сверху кнопка "Форкнуть").
4. Склонируйте репозитории в удобную директорию:
* `git clone https://rtxash.omgwtf.ru/Half-Life-RTX/Half-Life-prepared-original-textures.git`
* `git clone https://rtxash.omgwtf.ru/Ваша_учётная_запись/Half-Life-PBR.git`
5. Делаем точки монтирования (не требуется прав) или символьные ссылки для уже готовых pbr. Например:
* для Windows `mklink /J "D:\hl1dev\xash3d-fwgs\valve\pbr" "D:\hl1dev\Half-Life-PBR\valve\pbr"`
* для Linux `ln -s ~/hl1dev/Half-Life-PBR/valve/pbr ~/hl1dev/xash3d-fwgs/valve/pbr`
6. Находим желаемые для ремастеринга текстуры, например можно узнать названия текстур под прицелом через команду ui_infotool (можно назначить на клавишу `u` через `bind u "toggle ui_infotool"`).
7. Из Half-Life-prepared-original-textures копируем в pbr нужные нам заготовки текстур соблюдая ту же структуру папок и именования файлов.
8. Модифицируем эти текстуры согласно руководствам (будут добавлены позже).
9. Раскомментируем строки связанных материалов в файле материалов текстур чтобы задействовать новые текстуры.
10. Смотрим на результат в игре. Рендер поддерживает перезагрузку материалов на лету через консольную команду `vk_rtx_reload_materials` (`bind m vk_rtx_reload_materials`), однако если вы хотите менять одну и ту же текстуру вам потребуется временно добавить в материал строку `"force_reload" "1"` (на данный момент рендер не может сам определить изменялась текстура или нет).
11. Когда материал готов коммитим в свой форк изменение и выставляем пулл реквест в основной репозиторий. Если вы всё сделали правильно ваши изменения уйдут в осноной репозиторий. После вы можете сбросить состояние своего репозитория до актуального основного так:
```bash
git remote add upstream https://rtxash.omgwtf.ru/Half-Life-RTX/Half-Life-PBR
git fetch upstream
git checkout master
git reset --hard upstream/master
git push origin master --force
```
### Работа с материалами
Для ремастеринга материалов будут подготовлены несколько статей (работа с нейросетями, Materialize и т.п.).
Формат материалов описан [здесь](https://github.com/w23/xash3d-fwgs/wiki/Формат-PBR-материалов) (немного устарел).
В дальнейшем вся связанная с ремастерингом документация продублируется в вики этого хранилища.

47
readme.ru.md Normal file
View File

@ -0,0 +1,47 @@
# Repository for Half-Life PBR materials
## Общий подход разработки
1. Вы должны знать [основы Git.](https://githowto.com/ru) Возможно позже будет специальный сервис где вы сможете загрузить текстуры и поправить материалы без технических знаний по Git.
2. Попросите регистрацию у Провода.
3. После регистрации форкните Half-Life-PBR на свою учётную запись (справа сверху кнопка "Форкнуть").
4. Склонируйте репозитории в удобную директорию:
* `git clone https://rtxash.omgwtf.ru/Half-Life-RTX/Half-Life-prepared-original-textures.git`
* `git clone https://rtxash.omgwtf.ru/Ваша_учётная_запись/Half-Life-PBR.git`
5. Делаем точки монтирования (не требуется прав) или символьные ссылки для уже готовых pbr. Например:
* для Windows `mklink /J "D:\hl1dev\xash3d-fwgs\valve\pbr" "D:\hl1dev\Half-Life-PBR\valve\pbr"`
* для Linux `ln -s ~/hl1dev/Half-Life-PBR/valve/pbr ~/hl1dev/xash3d-fwgs/valve/pbr`
6. Находим желаемые для ремастеринга текстуры, например можно узнать названия текстур под прицелом через команду ui_infotool (можно назначить на клавишу `u` через `bind u "toggle ui_infotool"`).
7. Из Half-Life-prepared-original-textures копируем в pbr нужные нам заготовки текстур соблюдая ту же структуру папок и именования файлов.
8. Модифицируем эти текстуры согласно руководствам (будут добавлены позже).
9. Раскомментируем строки связанных материалов в файле материалов текстур чтобы задействовать новые текстуры.
10. Смотрим на результат в игре. Рендер поддерживает перезагрузку материалов на лету через консольную команду `vk_rtx_reload_materials` (`bind m vk_rtx_reload_materials`), однако если вы хотите менять одну и ту же текстуру вам потребуется временно добавить в материал строку `"force_reload" "1"` (на данный момент рендер не может сам определить изменялась текстура или нет).
11. Когда материал готов коммитим в свой форк изменение и выставляем пулл реквест в основной репозиторий. Если вы всё сделали правильно ваши изменения уйдут в осноной репозиторий. После вы можете сбросить состояние своего репозитория до актуального основного так:
```bash
git remote add upstream https://rtxash.omgwtf.ru/Half-Life-RTX/Half-Life-PBR
git fetch upstream
git checkout master
git reset --hard upstream/master
git push origin master --force
```
## Работа с материалами
Для ремастеринга материалов будут подготовлены несколько статей (работа с нейросетями, Materialize и т.п.).
Формат материалов описан [здесь](https://github.com/w23/xash3d-fwgs/wiki/Формат-PBR-материалов) (немного устарел).
В дальнейшем вся связанная с ремастерингом документация продублируется в вики этого хранилища.