Shaderdoc
Le projet ShaderDoc vise à fournir une source indépendante de documentation pour le format Shadersmod / Optifine / Iris Shader Pack. Bien qu'il ne documente pas complètement le format, il cherche à fournir un niveau de détail élevé dans les domaines qu'il documente.
Il y a deux objectifs de ce projet:
- Fournir une documentation de haute qualité pour les développeurs de packs shader cherchant à développer des packs de shader pour l'iris.
- Fournir une description relativement sans ambiguïté des éléments critiques mais complexes du format de shader qui ne sont autrement que brièvement (ou incorrectement!) Décrits dans la documentation officielle optifine, afin de faciliter la mise en œuvre de ces éléments chez Iris sans enfreindre le droit d'auteur.
Rassembler des informations pour ShaderDoc
Il existe plusieurs façons de recueillir des informations afin d'ajouter de nouvelles documents à ShaderDoc:
- En utilisant la documentation optifine comme référence. Veuillez noter que la documentation officielle optifine pour les shaders n'est pas autorisée, ce qui en fait tous les droits réservés. Cela signifie qu'il est interdit de copier directement le texte de la documentation optifine à ShaderDoc. Cependant, il est autorisé à lire la documentation optifine, puis à l'utiliser pour écrire une description d'un sujet dans vos propres mots. Notez que la documentation optifine n'est pas nécessairement une source de vérité - il existe de nombreux endroits où il est incorrect. Utilisez avec une certaine prudence.
- Autre documentation tierce. Les développeurs de pack Shader ont également créé leurs propres ressources pour documenter le format Shaders. Des règles et directives similaires pour travailler avec la documentation optifine s'appliquent.
- Expérience en travaillant avec le format du pack Shader. Travailler avec le format de pack Shader sous Optifine est un moyen décent de recueillir des connaissances générales sur le format.
- Ingénierie inverse. Bien que quelque peu risqué, cette méthode peut être le moyen le plus précis de trouver ou de confirmer des informations. Le code source de Shadersmod v2.7.0 pour Minecraft 1.12 est disponible ici: http://www.karyonix.net/shadersmod/files/smc-2.7.0-mc1.12-src.7z. La décompilation de l'optifine doit être évitée dans la mesure du possible.
Contribuant à Shaderdoc
Si vous souhaitez contribuer à ShaderDoc, n'hésitez pas à ouvrir une demande de traction. Notez que PRS peut prendre beaucoup de temps pour être fusionné, car ils ne sont fusionnés qu'une fois qu'ils ont été entièrement vérifiés, et chaque fois que j'ai le temps de les regarder.
Licence
LGPLV3 ou plus tard
