Manual

OpenAL

Table of Contents

1. Introduction
2. Installing OpenAL
3. Command-line options that control the sound outupt

1. Introduction

OpenAL is an open-source cross-platform library to play 3D sound. It is the default sound backend used by Castle Game Engine to play all the sounds.

If you want to learn how to play sounds using Castle Game Engine, see the manual about sound. This pages only lists some OpenAL-specific information.

2. Installing OpenAL

Windows: OpenAL libraries (DLL files) are automatically places alongside the compiled application by our build tool. You don’t need to do anything, just compile and run your application using Castle Game Engine editor or build tool.
Linux: Install a package like libopenal1. There is no need to install the package libopenal-dev present on some Linux distributions (it contains C headers and symlinks that we don’t need).
FreeBSD: Install by pkg_add -r openal.
macOS: You have OpenAL already installed, it is provided by Apple.

3. Command-line options that control the sound outupt

--no-sound: Don’t output any sound (even if OpenAL is available on this system).
--audio-device DEVICE-NAME: Use given DEVICE-NAME for sound output.

To list the available OpenAL devices use the --help command-line option. The --audio-device description will show a list of devices detected.

Particular applications may also expose this choice using a nice GUI, e.g. The Castle has a simple menu to choose the device. In Castle Model Viewer you can choose it using "File -> Preferences -> Sound Device" menu item.

To improve this documentation just edit this page and create a pull request to cge-www repository.

Previous: Sound

Next: FMOD

Manual