Шейдердок
Проект Shaderdoc стремится предоставить независимый источник документации для формата Shadersmod / Optifine / Iris Shader. Хотя он не полностью документирует формат, он стремится предоставить высокий уровень детализации в областях, которые он документирует.
Есть две цели этого проекта:
- Предоставление высококачественной документации для разработчиков шейдеров, стремящихся разработать пакеты шейдеров для Iris.
- Предоставляя относительно однозначное описание критических, но сложных элементов формата шейдеров, которые в противном случае являются лишь кратко (или неправильно!), Описаны в официальной документации по оптифинам, чтобы облегчить реализацию этих элементов в IRIS, не нарушая авторские права.
Сбор информации для Shayerdoc
Есть несколько способов сбора информации, чтобы добавить новую документацию в Shaderdoc:
- Использование документации оптифина в качестве ссылки. Обратите внимание, что официальная документация по оптифину для шейдеров нелицензирована, что делает все права защищенными. Это означает, что запрещено непосредственно копировать текст из документации по оптифину в Шейдердок. Тем не менее, разрешено читать документацию по оптифину, а затем использовать ее для написания описания темы своими словами. Обратите внимание, что документация по оптифину не обязательно является источником истины - есть много мест, где она неверна. Используйте с некоторой осторожностью.
- Другая сторонняя документация. Разработчики Shader Pack также создали свои собственные ресурсы для документирования формата шейдеров. Применяются аналогичные правила и руководящие принципы для работы с документацией оптифина.
- Опыт работы с форматом Shader Pack. Работа с форматом Shader Pack в рамках Optifine - это приличный способ собрать общие знания о формате.
- Обратная инженерия. Несмотря на то, что этот метод несколько рискованен, может быть наиболее точным способом найти или подтвердить информацию. Исходный код Shadersmod v2.7.0 для Minecraft 1.12 доступен здесь: http://www.karyonix.net/shadersmod/files/smc-2.7.0-mc1.12-src.7z. Следует избегать разложения оптифина, где это возможно.
Вклад в Шейдердок
Если вы хотите внести свой вклад в Shaderdoc, не стесняйтесь открывать запрос на тягу. Обратите внимание, что PRS может занять много времени, чтобы быть объединенным, так как они объединены только после того, как они были полностью проверены, и всякий раз, когда у меня есть время, чтобы действительно посмотреть на них.
Лицензия
LGPLV3 или позже
