This is a documentation for Board Game Arena: play board games online !
Game sounds: sounds directory: Difference between revisions
(Created page with "{{Studio_Framework_Navigation}} __TOC__ == Game sounds == You must upload in sounds directory all sounds that you will use in your game interface. === Sounds format constraints === The sound should exist both with the mp3 and ogg format/extension. === Sounds loading === '''Be careful''': by default, ALL sounds of your sounds root directory are loaded on a player's browser when he loads the game. For this reason, don't publish sounds that are not useful in your sou...") |
|||
| Line 5: | Line 5: | ||
== Game sounds == | == Game sounds == | ||
You must upload in sounds directory all sounds that you will use in your game interface. | You must upload in a `sounds` directory all sounds that you will use in your game interface. | ||
=== Sounds format constraints === | === Sounds format constraints === | ||
| Line 13: | Line 13: | ||
=== Sounds loading === | === Sounds loading === | ||
'''Be careful''': by default, ALL sounds of your sounds root directory are loaded on a player's browser when he loads the game. For this reason, don't publish sounds that are not useful in your sounds folder, or it will slow down the game load. You can put them in a subdirectory of sounds, that won't be preloaded by default. | '''Be careful''': by default, ALL sounds of your sounds root directory are loaded on a player's browser when he loads the game. For this reason, don't publish sounds that are not useful in your sounds folder, or it will slow down the game load. You can put them in a subdirectory of sounds, that won't be preloaded by default, for example sounds used only if an expansion is activated. | ||
Note that you can tune the way sounds are loaded with Javascript method "preloadSounds"/"dontPreloadSounds" (see https://en.doc.boardgamearena.com/Game_interface_logic:_Game.js#Sounds). | Note that you can tune the way sounds are loaded with Javascript method "preloadSounds"/"dontPreloadSounds" (see https://en.doc.boardgamearena.com/Game_interface_logic:_Game.js#Sounds). You can for example preloadSounds in a sub-folder if an expansion is activated and use it. | ||
[[Category:Studio]] | [[Category:Studio]] | ||
Revision as of 12:26, 18 March 2026
Game sounds
You must upload in a `sounds` directory all sounds that you will use in your game interface.
Sounds format constraints
The sound should exist both with the mp3 and ogg format/extension.
Sounds loading
Be careful: by default, ALL sounds of your sounds root directory are loaded on a player's browser when he loads the game. For this reason, don't publish sounds that are not useful in your sounds folder, or it will slow down the game load. You can put them in a subdirectory of sounds, that won't be preloaded by default, for example sounds used only if an expansion is activated.
Note that you can tune the way sounds are loaded with Javascript method "preloadSounds"/"dontPreloadSounds" (see https://en.doc.boardgamearena.com/Game_interface_logic:_Game.js#Sounds). You can for example preloadSounds in a sub-folder if an expansion is activated and use it.