Sound Bakery  v0.1.0
Open-source audio middleware for games
Loading...
Searching...
No Matches
Sound Bakery

Sound Bakery

Windows MacOS Linux License C++
Standard
Version
windows macos linux License: MIT GitHub license WIP
Why?GoalGetting StartedContributing

Sound Bakery is a free and open-source event-based audio middleware tool. The tool comes packaged with an authoring application and C/C++ API for integration with game engines. It supports the entire audio pipeline, from asset management, sound selection, and packaging to playback and debugging.

Why Choose Sound Bakery?

From Blender and Krita to Godot, more and more developers are choosing open-source alternatives for their projects. Sound Bakery is the open choice for game audio.

The options for audio developers have always been restricted. The choice has been between expensive tools, engine tools, or free software that lacks essential features. That is not the case with Sound Bakery - it is fully featured from an authoring application to a robust API for integration.

Effective Modern Open
Sound Bakery provides a powerful authoring application and clean API that is as powerful as any commercial tool. It is built with multithreading and performance in mind. Instead of building atop decades-old codebases, Sound Bakery can start anew and use modern language features, libraries and development techniques. Tired of spending thousands on your middleware tool just for it to ask for more? Sound Bakery is yours to use and modify - free of charge.

Goal

Sound Bakery aims to be a competitive option to Wwise and FMOD that is more collaborative and open. Imagine owning your audio engine and being able to customise its look, tools, behaviour, and more. Imagine receiving features and fixes from top studios, all collectively improving the tools of the industry.

Check out the roadmap for where Sound Bakery is going!

Getting Started

Looking to get started instantly? Check out the releases page for prebuilt binaries and source code.

Prerequisites

Ensure the following are installed:

  • A C++ compiler (e.g., GCC, Clang, MSVC)
  • CMake (version 3.10 or higher)
  • Git

Installation

Clone the repository and build the project:

git clone https://github.com/KarateKidzz/sound-bakery.git
cd sound-bakery
mkdir build
cd build
cmake ..
make

Usage

Here's a simple example to get started with Sound Bakery:

#include "sound_chef.h"
int main() {
sc_system* system = NULL;
sc_system_create(&system);
sc_system_init(system);
sc_sound* sound = NULL;
sc_system_create_sound(system, "some_sound.wav", SC_SOUND_MODE_DEFAULT, &sound);
sc_sound_instance* instance = NULL;
sc_system_play_sound(system, sound, &instance, NULL, SC_FALSE);
return 0;
}
A wrapper library for miniaudio that emulates functionality of FMOD.
sc_result SC_API sc_system_create(sc_system **outSystem)
Creates a new System object.
Definition sound_chef.c:214
sc_result SC_API sc_system_init(sc_system *system)
Initialises the system.
Definition sound_chef.c:261
sc_result SC_API sc_system_play_sound(sc_system *system, sc_sound *sound, sc_sound_instance **instance, sc_node_group *parent, sc_bool paused)
Plays a sound and returns the playing instance.
Definition sound_chef.c:357
Definition sound_chef_common.h:161
Object that manages the node graph, sounds, output etc.
Definition sound_chef_common.h:198

Documentation

For documentation and guides, visit soundbakery.jameskelly.audio.

Contributing

Contributions from the community are welcome! Whether fixing bugs, adding new features, or improving documentation, all help is valuable.

How to Contribute

  1. Fork the repository.
  2. Create a new branch for the feature or bug fix.
  3. Commit changes and push the branch to the fork.
  4. Create a pull request with a detailed description of the changes.

For more details, check out our contributing guidelines.

License

Sound Bakery is licensed under the MIT License. See the LICENSE file for more information.

Acknowledgements

A big thank you to the creators of miniaudio, concurrencpp, ImGui, rttr, tracy, and spdlog for their incredible libraries and to all our contributors who make Sound Bakery possible.