Skip to content

MaxenceMaire/audionimbus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

224 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AudioNimbus

Crates.io Documentation License

A Rust wrapper around Steam Audio that provides spatial audio capabilities for games and VR applications. It simulates realistic sound propagation, including physics-based occlusion, reflections, reverb, HRTF, and more.

Features

  • Sound propagation: Models how sound is affected as it travels through its environment. Includes effects like distance attenuation and interaction with physical obstacles of varying materials.
  • Reflections & reverb: Simulates how sound waves reflect off surrounding geometry to create realistic acoustics.
  • Head-Related Transfer Function (HRTF): Simulates how the listener's head and ears shape incoming sound to convey direction and distance.
  • Ambisonics & surround sound: Encodes spatial information across multiple audio channels to reproduce directional sound fields.

AudioNimbus can integrate with FMOD Studio and Wwise.

For a demonstration of AudioNimbus' capabilities, watch the walkthrough video.

Get Started

Add audionimbus to your dependencies:

[dependencies]
audionimbus = { version = "0.13.0", features = ["auto-install"] }

The auto-install feature automatically downloads and installs Steam Audio for you.

For more information, refer to the detailed installation guide.

To get started integrating audionimbus into your project, check out the example or run the demo.

Documentation

Documentation is available at docs.rs.

Project Structure

AudioNimbus consists of two crates:

  • audionimbus: A high-level, safe wrapper around Steam Audio. You typically only need to use this crate.
  • audionimbus-sys: Automatically generated raw bindings to the Steam Audio C API. Used internally by audionimbus. You typically don't need to interact directly with this crate.

License

This repository is dual-licensed under the MIT License and the Apache-2.0 License. You may choose either license when using the software.

About

Steam Audio in Rust

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages