Please write down what changed in these shaders
Good version notes tell what has been changed in this version with respect to the previous one
Document your changes to
Please verify the following important points
Sharing shaders is cool. However, be aware that Matchbox shaders get used commercially, for creating commercial work for our clients. The last thing you want is burden your client with license claims of any sort.
This means that the license of your shader code should allow commercial usage and allow derivative works if you ported it over.
For maximum flexibility we suggest you use the MIT license for your own shaders.
So, your shader must:
- Allow commercial usage
- Be an allowed derivative work (if you ported it to the Matchbox runtime from code elsewhere)
- Contain a reference to your e-mail address so that people can contact you.
- Include a reference to the license it uses.
Note that we do not assume any responsibility for having your shaders license-cleared and we might remove them given any claims of IP ownership or disputes.
Do you confirm that all of the above conditions are met, and that you assume all responsibility for having cleared your shader?
Sharing your shader
So, you've made a Matchbox shader! That is awesome. You should share it with others. And maybe others will even fix your bugs. Here's how you can make it available.
Step 1: Organize your shader files and metadata
Please read our tips on how to package your shader.
Step 2: Upload your shader files
Shader files meaning .xml, .glsl, .glsl.png, .glsl.p, .lx and .mx files. Please do not drop directories/folders. You can upload multiple shaders at a time, as many as you like.
If you upload .mx/.lx files we are not going to offer the source of the shaders for download, only the compiled version - so your IP is protected.
Upload shader files one by one
Drop all of the .xml, .glsl, .glsl.png, .glsl.p and .mx files here
If you upload a .mx file alongside your shader we are only going to allow the .mx file to be downloaded. Note that we require the icon and the XML file of your shader to be uploaded unencrypted alongside the .mx file offered for download. Uploads consisting solely of .mx files are considered invalid and will be removed from the repository.
Add a service hook if you use GitHub
If you manage your shader development with source control (as you should be), and you have the repo for your shaders open-source on GitHub (and you should have), it's even easier for you. Go to your repository settings on GitHub and add https://logik-matchbook.org/github-hook as a web hook.
Once you do that, every time you modify a shader-related file we will automatically check out your repository and pull in all the shaders contained within it, so you don't have to do anything at all.