Add fix for Safari issue to README

dapetcu21 · Jun 14, 2020 · b87051d · b87051d
1 parent 316b85b
commit b87051d
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -41,6 +41,18 @@ If you need platform-specific overrides for these settings, append one of
 `_macos`, `_windows`, `_linux`, `_android`, `_ios`, `_html5` to the config key
 (eg. `buffer_length_android`).
 
+### Raise the heap size on HTML5
+
+FMOD will hiccup and not play sound on HTML5 (particularily Safari on iOS and macOS)
+if it doesn't have enough memory for your banks and sound buffers, especially if
+loaded with `load_bank_memory()`, which copies them into memory. The exact amount 
+depends from game to game, but for this example to run, it needs a 512MB heap.
+
+```
+[html5]
+heap_size = 512
+```
+
 ### Running in the editor
 
 The game will bundle fine, but in order for FMOD to be available when running

diff --git a/game.project b/game.project
@@ -28,3 +28,6 @@ include_dirs = fmod
 lib_path = fmod/res
 speaker_mode = 5.1
 
+[html5]
+heap_size = 512
+