Shaderdoc
Das ShaDerDOC -Projekt soll eine unabhängige Dokumentationsquelle für das Format ShaTersmod / Optifin / Iris Shader Pack bereitstellen. Obwohl es das Format nicht vollständig dokumentiert, soll in den Bereichen, die es dokumentiert, ein hohes Maß an Details bereitstellt.
Es gibt zwei Zwecke dieses Projekts:
- Bereitstellung einer qualitativ hochwertigen Dokumentation für Shader-Pack-Entwickler, die Shader Packs für Iris entwickeln möchten.
- Bereitstellung einer relativ eindeutigen Beschreibung kritischer, aber komplexer Elemente des Shader -Formats, die ansonsten nur kurz (oder falsch!) In der offiziellen Optifin -Dokumentation beschrieben werden, um die Implementierung dieser Elemente in IRIS zu erleichtern, ohne das Urheberrecht zu verletzen.
Sammeln von Informationen für Shaderdoc
Es gibt einige Möglichkeiten, Informationen zu sammeln, um Shaderdoc neue Dokumentation hinzuzufügen:
- Verwenden der Optifin -Dokumentation als Referenz. Bitte beachten Sie, dass die offizielle Optifin -Dokumentation für Shaders nicht lizenziert ist, sodass alle Rechte vorbehalten sind. Dies bedeutet, dass es verboten ist, den Text direkt aus der Optifin -Dokumentation in ShaDerdoc zu kopieren. Es ist jedoch gestattet, die Optifin -Dokumentation zu lesen und dann eine Beschreibung eines Themas in Ihren eigenen Worten zu schreiben. Beachten Sie, dass die Optifin -Dokumentation nicht unbedingt eine Quelle der Wahrheit ist - es gibt viele Orte, an denen sie falsch ist. Verwenden Sie mit einiger Vorsicht.
- Andere Dokumentation von Drittanbietern. Shader Pack -Entwickler haben auch ihre eigenen Ressourcen erstellt, um das Shader -Format zu dokumentieren. Ähnliche Regeln und Richtlinien für die Arbeit mit Optifine -Dokumentation gelten.
- Erfahrung in der Arbeit mit dem Shader Pack -Format. Das Arbeiten mit dem Shader Pack -Format unter Optifine ist eine anständige Möglichkeit, allgemeines Wissen über das Format zu sammeln.
- Reverse Engineering. Obwohl diese Methode etwas riskant ist, kann sie die genaueste Möglichkeit sein, Informationen zu finden oder zu bestätigen. Der Quellcode von Shadersmod v2.7.0 für Minecraft 1.12 ist hier verfügbar: http://www.karyonix.net/shadersmod/files/smc-2.7.0-mc1.12-Src.7z. Das Dekompetenz von Optifin sollte nach Möglichkeit vermieden werden.
Beitrag zu Shaderdoc
Wenn Sie zu Shaderdoc beitragen möchten, können Sie eine Pull -Anfrage öffnen. Beachten Sie, dass PRs möglicherweise lange dauern, bis sie zusammengeführt werden, wenn sie vollständig überprüft wurden und wann immer ich Zeit habe, sie tatsächlich anzusehen.
Lizenz
LGPLV3 oder höher
