Shaderdoc
O projeto ShaderDoc procura fornecer uma fonte independente de documentação para o formato ShadersMod / Optifine / Iris Shader Pack. Embora não documente completamente o formato, ele procura fornecer um alto nível de detalhe nas áreas que ele documenta.
Existem dois propósitos deste projeto:
- Fornecendo documentação de alta qualidade para os desenvolvedores de shader Pack buscando desenvolver pacotes de shader para íris.
- Fornecendo uma descrição relativamente inequívoca de elementos críticos, porém complexos, do formato do shader que, de outra forma, são apenas brevemente (ou incorretamente!) Descritos na documentação oficial da optifina, a fim de facilitar a implementação desses elementos na íris sem infringir os direitos autorais.
Reunindo informações para shaderdoc
Existem algumas maneiras de coletar informações para adicionar nova documentação ao ShaderDoc:
- Usando a documentação da optifina como referência. Observe que a documentação oficial da optifina para shaders não é licenciada, tornando todos os direitos reservados. Isso significa que é proibido copiar diretamente o texto da documentação da optifina para o ShaderDoc. No entanto, é permitido ler a documentação da optifina e usá -la para escrever uma descrição de um tópico em suas próprias palavras. Observe que a documentação da optifina não é necessariamente uma fonte de verdade - há muitos lugares onde está incorreto. Use com alguma cautela.
- Outra documentação de terceiros. Os desenvolvedores de shader Pack também criaram seus próprios recursos para documentar o formato Shaders. Regras e diretrizes semelhantes para trabalhar com a documentação da optifina se aplicam.
- Experiência em trabalhar com o formato do shader pack. Trabalhar com o formato de pacote de shader em Optifine é uma maneira decente de reunir conhecimento geral sobre o formato.
- Engenharia reversa. Embora um tanto arriscado, esse método pode ser a maneira mais precisa de encontrar ou confirmar informações. O código-fonte do ShadersMod v2.7.0 para Minecraft 1.12 está disponível aqui: http://www.karyonix.net/shadersmod/files/smc-2.7.0-mc1.12-src.7z. A optifina de descompilação deve ser evitada sempre que possível.
Contribuindo para o shaderdoc
Se você deseja contribuir com o ShaderDoc, sinta -se à vontade para abrir uma solicitação de tração. Observe que os PRs podem levar muito tempo para serem mesclados, pois são mesclados apenas depois de serem totalmente verificados e sempre que tenho tempo para realmente olhá -los.
Licença
LGPLV3 ou mais tarde
