About

Lazuli is an engine for 3d graphics.

How-to

Create a new project

To create a new project using this engine, run make new-project from the root directory with the project name as the second argument. For example:

make new-project My-awesome-project

The project will be created in the same parent directory that this repository resides in. For example:

home
├── Lazuli
└── My-awesome-project

Contributing

Running a test scene

To start the engine locally, run make run from the root directory. The scene that will be used is defined in the entrypoint file.

Coding standards

Rust

Tests

Test files should start with a _test suffix, follow by the module they test. For example: feature_test.rs.

Files with mocks should start with a _mock suffix, like feature_mock.rs.

Shaders

Local variables names use the snake_case convention. Variable qualifiers ('in', 'out', 'uniform' etc.) use the camelCase convention.

Scripts

Variables should be screaming snake_case, like

MY_VARIABLE_NAME="awesome"