Start Here
- Getting Started with Jax
-
Everything you need to know to install Jax and create your first application.
Digging Deeper
- Custom Shaders
-
This guide shows how to add and use your own shaders to add advanced custom visual effects.
- Plugins
-
Jax can do a lot, but there will inevitably be new, exciting techniques and smarter approaches. This guide shows you how to fill in the gaps by installing reusable chunks of code from other developers, as well as how to make your own contributions available to the rest of the Jax community.
- Materials
- Work in progress
-
This guide demonstrates how to create, use and dynamically alter Materials in Jax.
- Lighting
- Work in progress
-
This guide shows how to make the most of lighting support in Jax, and outlines potential caveats. It will also discuss how to prevent certain objects from being lit at all, and in what circumstances you'd want to do this.
- Matrices
- Work in progress
-
This guide explains all of the various matrices and "spaces", and how they relate to one another. It will help you understand the difference between world space, camera space and object space; and how a 3D object goes from a set of vertices in object space to a translated, rotated and scaled image on your computer screen.
- Testing Jax Applications
- Work in progress
-
This is a comprehensive guide to testing a Jax application. It covers everything from "What is a test?" to the testing APIs.
API Documentation
Feedback
You're encouraged to help improve the quality of this guide.
If you see any typos or factual errors you are confident to patch, please clone Jax, correct the issue and send a pull request. Your commits will be reviewed, and then merged into master.
Also, any kind of discussion regarding Jax documentation is very welcome in the forums.