Nil

A work-in-progress custom game engine built with WGPU

Git Repo bug_report Bug Tracker
people Contributing
Interested in working with this project or volunteering to help? Get started here!
email Contact Me
Have any questions or concerns? Don't hesitate to reach out!
source

Open Source

Browse the source code, suggest changes, or develop it yourself!

Git Repo chevron_right

NIL

After installing Rust, the project can be started with either make or cargo run.

Using make fps should display an FPS indicator, which can be useful for performance monitoring.

Assets

Files inside assets/ are iterated through recursively to generate the set of items used in the game. A file such as assets/nil/blocks/nullium.yml can be referenced in the codebase with the identifier "nil/blocks/nullium".

YAML format

Each YAML file must specify a default texture key, referencing a PNG texture, and a model key, referencing an OBJ model file.

Additional conditions can be added to these files to swap models or textures when the object is in a particular state.

model: nil/blocks/block
texture: nil/blocks/nullium

OBJ format

OBJ files can be exported from Blender. All vertex positions should be within the range of [-0.5..0.5].

Texture format

Emissive pixels

In this project, "emissive pixels" are defined as pixels which are not subject to any lighting effects (they do not actually emit any light). An emissive pixel can be created by setting its alpha channel to exactly 254.