Sounds

Odyc.js uses PFXR, a lightweight JavaScript library made specifically for generating procedural sound effects. It allows you to create, customize, and play very compact audio assets.

Defining a sound in a template

A sound can be associated with a game element using the sound key. It will automatically be played when the player interacts with that element.

templates: {
  E: {
    sprite: 3,
    sound: "HIT"
  }
}

Accepted formats

The sound key accepts several formats:

A preset name

sound: 'FALL'

Here’s a list of available presets. Click a name to hear an example. Each click generates a random variation.

Be careful with RANDOM — turn your volume down before clicking.

An array [preset, seed]

If you want the sound to always be the same, you can specify a number (seed):

sound: ['LASER', 12345]

You can use the Sound tool in the playground to find the perfect sound.

A PFXR URL

You can create a custom sound using the Pfxr interface and paste the generated URL:

sound: 'https://achtaitaipai.github.io/pfxr/?fx=1,0.3,...'

A configuration object

For full control, use an object describing the sound parameters:

sound: {
  waveForm: 2,
  frequency: 440,
  sustainTime: 0.2,
  decayTime: 0.5
}

You can find the complete list of parameters here.

🔊 Global volume

The overall sound volume can be adjusted via the volume key in the initial game configuration:

createGame({
	volume: 0.8
})

Default value: 0.5