diff --git a/readme.en.md b/readme.en.md index 755026d..fcffa67 100644 --- a/readme.en.md +++ b/readme.en.md @@ -1,3 +1,63 @@ # Repository for Half-Life PBR materials -TBD \ No newline at end of file +## If you just want to try the materials + +1. Use the command line to clone the repository into a convenient directory by running: + * `git clone https://rtxash.omgwtf.ru/Half-Life-RTX/Half-Life-PBR.git` + +2. Do a mount (no rights required in Windows) or symbolic links for the already prepared PBRs. For example: + + * for Windows + * `mklink /J "D:\hl1dev\xash3d-fwgs\valve\pbr" "D:\hl1dev\Half-Life-PBR\valve\pbr"` + * for Linux + * `ln -s ~/hl1dev/Half-Life-PBR/valve/pbr ~/hl1dev/xash3d-fwgs/valve/pbr` + +3. That's it, the textures will now be automatically loaded into the game in ray tracing mode. + +## If you would like to join the remastering of materials + +1. At this point you should know [the basics of Git.](https://githowto.com/ru) Later there may be a special service where you can upload textures and fix materials without technical knowledge of Git. + +2. Ask the provod/w23 for an invitation. + +3. After registering, fork Half-Life-PBR to your account (top right "Fork" button). + +4. Clone the repositories into a convenient directory: + + * `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. We make mount points (no rights required in Windows) or symbolic links for PBR's already made. For example: + + * for Windows + * `mklink /J "D:\hl1dev\xash3d-fwgs\valve\pbr" "D:\hl1dev\Half-Life-PBR\valve\pbr"` + * for Linux + * `ln -s ~/hl1dev/Half-Life-PBR/valve/pbr ~/hl1dev/xash3d-fwgs/valve/pbr` + +6. Find the desired textures for remastering, for example you can find out the names of the textures under the sight through the `ui_infotool` command (you can assign to the `u` key through `bind u "toggle ui_infotool"`). + +7. From `Half-Life-prepared-original-textures` copy to pbr the texture blanks we need, observing the same folder structure and file names. + +8. Modify these textures according to the manuals (to be added later). + +9. Uncomment the lines of linked materials in the texture material file to enable the new textures. + +10. Look at the result in the game. Render supports reloading materials on the fly through the console command `vk_rtx_reload_materials` (`bind m vk_rtx_reload_materials`), but if you want to change the same texture you need to temporarily add to the material line `"force_reload" "1"` (at the moment render can not determine itself changed texture or not). + +11. When the material is ready, commit the change to your fork and put a pull-request in the main repository. If you did everything correctly, your changes will go into the main repository. Afterwards, you can reset your repository to the current main repository stage: + + ```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 + ``` + +## Working with materials + +Several articles will be prepared for remastering materials (work with neural networks, Materialize, etc.). + +The format of materials is described [here](https://github.com/w23/xash3d-fwgs/wiki/English:-PBR-material-format). + +In the future, all documentation related to remastering will be duplicated in the wiki of this repository. diff --git a/readme.ru.md b/readme.ru.md index 06bf7db..18b16c3 100644 --- a/readme.ru.md +++ b/readme.ru.md @@ -1,10 +1,24 @@ # Repository for Half-Life PBR materials -## Общий подход разработки +## Если вы хотите просто попробовать материалы -1. Вы должны знать [основы Git.](https://githowto.com/ru) Возможно позже будет специальный сервис где вы сможете загрузить текстуры и поправить материалы без технических знаний по Git. +1. Через командную строку склонируйте репозиторий в удобную директорию выполнив в ней: + * `git clone https://rtxash.omgwtf.ru/Half-Life-RTX/Half-Life-PBR.git` -2. Попросите регистрацию у Провода. +2. Сделайте монтирование (не требуется прав в Windows) или символьные ссылки для уже готовых 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` + +3. Всё, теперь текстуры будут автоматически подгружены в игре в лучевом режиме. + +## Если вы хотите присоединиться к ремастерингу материалов + +1. На текущий момент вы должны знать [основы Git.](https://githowto.com/ru) Позже возможно появится специальный сервис где вы сможете загрузить текстуры и поправить материалы без технических знаний по Git. + +2. Попросите приглашение у Провода. 3. После регистрации форкните Half-Life-PBR на свою учётную запись (справа сверху кнопка "Форкнуть"). @@ -15,8 +29,10 @@ 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` + * для 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"`). @@ -28,20 +44,20 @@ 10. Смотрим на результат в игре. Рендер поддерживает перезагрузку материалов на лету через консольную команду `vk_rtx_reload_materials` (`bind m vk_rtx_reload_materials`), однако если вы хотите менять одну и ту же текстуру вам потребуется временно добавить в материал строку `"force_reload" "1"` (на данный момент рендер не может сам определить изменялась текстура или нет). -11. Когда материал готов коммитим в свой форк изменение и выставляем пулл реквест в основной репозиторий. Если вы всё сделали правильно ваши изменения уйдут в основной репозиторий. После вы можете сбросить состояние своего репозитория до актуального основного так: +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 -``` + ```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-материалов) (немного устарел). +Формат материалов описан [здесь](https://github.com/w23/xash3d-fwgs/wiki/Русский:-Формат-PBR-материалов). В дальнейшем вся связанная с ремастерингом документация продублируется в вики этого хранилища.