Bug Uncaught ReferenceError: unityFramework is not defined at HTMLScriptElement.script.onload (WebGL)

jukka_j · Nov 4, 2020

Starting from Unity 2020.1, Unity WebGL projects no longer enable the Software Decompression Fallback of gzip and brotli by default. The software decompression fallback was added there because a lot of web servers are misconfigured and they do not properly advertise compressed content to the browser clients.

When a web server properly declares compressed content to the browser, the browser can decompress the content already while it downloads the file (streamed decompression). This effectively means that decompression comes "for free" since download times generally dominate on the web.

In the absence of properly declared compression, the software decompression fallback would manually run a decompressor after all the content has already been received by the browser. This is much slower than the pipelined approach that the browser is able to do, and a disservice of sorts to users, who would not be able to observe that they are not getting the best performance out of their Unity WebGL build startup times.

To fix the issue, the primary approach is to usher people to set up proper web hosting configuration. If this is not possible (e.g. cannot access the web server configuration since you are not the web admin), the software compression fallback still exists in Unity in 2020.1, but now just needs to be enabled manually.

Here is the server configuration block I would recommend to be used for nginx. It enables Brotli and gzip pre-compressed file compression support, WebAssembly streaming, and on-demand gzip compression if Unity builds did not have compression enabled when the project was built.

Code (JavaScript):

# Enable on-the-fly gzip compression of uncompressed files

# See https://docs.nginx.com/nginx/admin-guide/web-server/compression/

# See also http://nginx.org/en/docs/http/ngx_http_gzip_module.html

#

# For a more advanced installation, one can try brotli-compressing the files on demand.

# See https://github.com/google/ngx_brotli

#

# Brotli is not enabled by default here however, because the support is not included in

# nginx by default but one must install Brotli support from source. Replace the gzip

# directives with their commented out Brotli counterparts if you would like to enable on-demand

# Brotli compression. (remember to add "load_module modules/ngx_http_brotli_filter_module.so;"

# directive to top level of nginx.conf)

gzip on;

#brotli on;

# N.b. there also exists a feature "gzip_static" in nginx,

# http://nginx.org/en/docs/http/ngx_http_gzip_static_module.html,

# however that feature can be ignored, as Unity generates precompressed content

# from WebGL Build Settings menu out of the box.

# Unfortunately nginx does not support caching compressed files to avoid

# needing to recompress each time, so use a low compression level to keep

# things fast. (this is already the default, but shown here for posterity)

gzip_comp_level 1;

# brotli_comp_level 0; # (defaults to 6)

# Send the HTTP Response header "Vary: Accept-Encoding" as part of compressed

# requests. If an intermediate caching web proxy is used in-between, this

# will enable the proxy to properly cache compressed vs noncompressed files.

gzip_vary on;

# The following file types should be compressed on demand (.html, .js, .data, .wasm and .symbols.json).

# To ensure that .data files and .symbols.json files are compressed on demand,

# we define a custom MIME type application/octet-stream-compressible (not a registered IANA type)

# that we associate with these file suffixes so that they will be compressed on demand.

# This way we will be careful not to sloppily enable compression for *all* application/octet-stream

# files on the whole server, which might be undesirable for performance.

gzip_types application/wasm application/javascript application/octet-stream-compressible;

# brotli_types application/wasm application/javascript application/octet-stream-compressible;

# Nginx has two limitations to keep in mind:

# 1. While the file mime.types can be used to configure MIME types for file suffixes, that file

# does not support describing files that have multiple suffixes (e.g. .symbols.json or .data.gz)

# Therefore we use the location directives here to configure the MIME types for all file suffixes.

# 2. For each request, only one location specifier is used to match and serve a file. Therefore

# the following code has a little bit of repetition in order to cover each unique suffix.

# Our custom octet-stream-compressible MIME type for data files that compress well.

location ~ .+\.(data|symbols\.json)$ {

default_type application/octet-stream-compressible;

}

# Register default MIME type for .wasm files (this could also be done in mime.types but since

# we need to define MIME types for files that have multiple suffixes, do it all here to be

# coherent)

# Alternatively you can add a line

# application/wasm wasm;

# to mime.types

location ~ .+\.wasm$ {

# Enable streaming WebAssembly compilation by specifying the correct MIME type for

# Wasm files.

default_type application/wasm;

}

# On-disk Brotli-precompressed data files should be served with compression enabled:

location ~ .+\.(data|symbols\.json)\.br$ {

# Because this file is already pre-compressed on disk, disable the on-demand compression on it.

# Otherwise nginx would attempt double compression.

gzip off;

#brotli off;

add_header Content-Encoding br;

# No special MIME type need to be declared here (can add application/octet-stream

# for .data and application/json for .symbols/json if one desires, but that does

# not get used for anything, so keep the configuration simple by omitting them)

}

# On-disk Brotli-precompressed JavaScript code files:

location ~ .+\.js\.br$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding br;

default_type application/javascript;

}

# On-disk Brotli-precompressed WebAssembly files:

location ~ .+\.wasm\.br$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding br;

# Enable streaming WebAssembly compilation by specifying the correct MIME type for

# Wasm files.

default_type application/wasm;

}

# On-disk gzip-precompressed data files should be served with compression enabled:

location ~ .+\.(data|symbols\.json)\.gz$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding gzip;

}

# On-disk gzip-precompressed JavaScript code files:

location ~ .+\.js\.gz$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding gzip;

default_type application/javascript;

}

# On-disk gzip-precompressed WebAssembly files:

location ~ .+\.wasm\.gz$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding gzip;

# Enable streaming WebAssembly compilation by specifying the correct MIME type for

# Wasm files.

default_type application/wasm;

}

Reading the above comments, there are some nginx configuration files that use

Code (CSharp):

add_header Content-Type application/javascript;

directive to set up a MIME type. That unfortunately does not set a MIME type, but just appends a new header. The result will be that nginx will actually send two instances of the Content-Type header in the HTTP responses. Instead check out the "default_type" directive to set the header instead of appending, to avoid this duplication.

UltimateGamer84 · Nov 28, 2020

jukka_j said: ↑

Starting from Unity 2020.1, Unity WebGL projects no longer enable the Software Decompression Fallback of gzip and brotli by default. The software decompression fallback was added there because a lot of web servers are misconfigured and they do not properly advertise compressed content to the browser clients.

When a web server properly declares compressed content to the browser, the browser can decompress the content already while it downloads the file (streamed decompression). This effectively means that decompression comes "for free" since download times generally dominate on the web.

In the absence of properly declared compression, the software decompression fallback would manually run a decompressor after all the content has already been received by the browser. This is much slower than the pipelined approach that the browser is able to do, and a disservice of sorts to users, who would not be able to observe that they are not getting the best performance out of their Unity WebGL build startup times.

To fix the issue, the primary approach is to usher people to set up proper web hosting configuration. If this is not possible (e.g. cannot access the web server configuration since you are not the web admin), the software compression fallback still exists in Unity in 2020.1, but now just needs to be enabled manually.

Here is the server configuration block I would recommend to be used for nginx. It enables Brotli and gzip pre-compressed file compression support, WebAssembly streaming, and on-demand gzip compression if Unity builds did not have compression enabled when the project was built.

Code (JavaScript):

# Enable on-the-fly gzip compression of uncompressed files

# See https://docs.nginx.com/nginx/admin-guide/web-server/compression/

# See also http://nginx.org/en/docs/http/ngx_http_gzip_module.html

#

# For a more advanced installation, one can try brotli-compressing the files on demand.

# See https://github.com/google/ngx_brotli

#

# Brotli is not enabled by default here however, because the support is not included in

# nginx by default but one must install Brotli support from source. Replace the gzip

# directives with their commented out Brotli counterparts if you would like to enable on-demand

# Brotli compression. (remember to add "load_module modules/ngx_http_brotli_filter_module.so;"

# directive to top level of nginx.conf)

gzip on;

#brotli on;

# N.b. there also exists a feature "gzip_static" in nginx,

# http://nginx.org/en/docs/http/ngx_http_gzip_static_module.html,

# however that feature can be ignored, as Unity generates precompressed content

# from WebGL Build Settings menu out of the box.

# Unfortunately nginx does not support caching compressed files to avoid

# needing to recompress each time, so use a low compression level to keep

# things fast. (this is already the default, but shown here for posterity)

gzip_comp_level 1;

# brotli_comp_level 0; # (defaults to 6)

# Send the HTTP Response header "Vary: Accept-Encoding" as part of compressed

# requests. If an intermediate caching web proxy is used in-between, this

# will enable the proxy to properly cache compressed vs noncompressed files.

gzip_vary on;

# The following file types should be compressed on demand (.html, .js, .data, .wasm and .symbols.json).

# To ensure that .data files and .symbols.json files are compressed on demand,

# we define a custom MIME type application/octet-stream-compressible (not a registered IANA type)

# that we associate with these file suffixes so that they will be compressed on demand.

# This way we will be careful not to sloppily enable compression for *all* application/octet-stream

# files on the whole server, which might be undesirable for performance.

gzip_types application/wasm application/javascript application/octet-stream-compressible;

# brotli_types application/wasm application/javascript application/octet-stream-compressible;

# Nginx has two limitations to keep in mind:

# 1. While the file mime.types can be used to configure MIME types for file suffixes, that file

# does not support describing files that have multiple suffixes (e.g. .symbols.json or .data.gz)

# Therefore we use the location directives here to configure the MIME types for all file suffixes.

# 2. For each request, only one location specifier is used to match and serve a file. Therefore

# the following code has a little bit of repetition in order to cover each unique suffix.

# Our custom octet-stream-compressible MIME type for data files that compress well.

location ~ .+\.(data|symbols\.json)$ {

default_type application/octet-stream-compressible;

}

# Register default MIME type for .wasm files (this could also be done in mime.types but since

# we need to define MIME types for files that have multiple suffixes, do it all here to be

# coherent)

# Alternatively you can add a line

# application/wasm wasm;

# to mime.types

location ~ .+\.wasm$ {

# Enable streaming WebAssembly compilation by specifying the correct MIME type for

# Wasm files.

default_type application/wasm;

}

# On-disk Brotli-precompressed data files should be served with compression enabled:

location ~ .+\.(data|symbols\.json)\.br$ {

# Because this file is already pre-compressed on disk, disable the on-demand compression on it.

# Otherwise nginx would attempt double compression.

gzip off;

#brotli off;

add_header Content-Encoding br;

# No special MIME type need to be declared here (can add application/octet-stream

# for .data and application/json for .symbols/json if one desires, but that does

# not get used for anything, so keep the configuration simple by omitting them)

}

# On-disk Brotli-precompressed JavaScript code files:

location ~ .+\.js\.br$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding br;

default_type application/javascript;

}

# On-disk Brotli-precompressed WebAssembly files:

location ~ .+\.wasm\.br$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding br;

# Enable streaming WebAssembly compilation by specifying the correct MIME type for

# Wasm files.

default_type application/wasm;

}

# On-disk gzip-precompressed data files should be served with compression enabled:

location ~ .+\.(data|symbols\.json)\.gz$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding gzip;

}

# On-disk gzip-precompressed JavaScript code files:

location ~ .+\.js\.gz$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding gzip;

default_type application/javascript;

}

# On-disk gzip-precompressed WebAssembly files:

location ~ .+\.wasm\.gz$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding gzip;

# Enable streaming WebAssembly compilation by specifying the correct MIME type for

# Wasm files.

default_type application/wasm;

}

Reading the above comments, there are some nginx configuration files that use

Code (CSharp):

add_header Content-Type application/javascript;

directive to set up a MIME type. That unfortunately does not set a MIME type, but just appends a new header. The result will be that nginx will actually send two instances of the Content-Type header in the HTTP responses. Instead check out the "default_type" directive to set the header instead of appending, to avoid this duplication.
Click to expand...

Thank you so much! It took me ages to try to debug this thing, all solutions I found said to disable compression, which is not a real solution in my case.

adambielecki · Nov 30, 2020

hippocoder said: ↑

Any suggestions?

Is WebGL is non functional in 2020.1 alpha?
Click to expand...

It does not seems to be working on any 2020 version I tried so far with compression enabled.
I sometimes wondering if there are any regression tests in the place as recently updating project to later version of unity is extremely dangerous task, it's ok if you are using unity for hobby, but not acceptable in professional environment.

PaulRdy · Dec 2, 2020

Hey @jukka_j I've included a .htaccess file to enable correct streaming as suggested here: https://docs.unity3d.com/Manual/Webgl-Server-configuration-for-WebAssembly-streaming.html
I'm on an Apache server and using Unity 2020.2.0b13. Issue is the same .gz archive isn't getting unzipped. I'm also using the UWP.

Triplefun-Damian · Dec 4, 2020

For anyone having issues with this, you can also select "Decompression Fallback" in your Publishing Settings, rather than building a Development Build or disabling compression altogether.

That said, the optimal solution is to fix your headers on the server side so that each file has the proper Content-Type and Content-Encoding - once set, your browser will handle the rest: https://forum.unity.com/threads/cha...-templates-introduced-in-unity-2020-1.817698/

"Decompression Fallback" is useful, though, if you're testing locally (for example, I use it while running live-server in VSC). It basically pushes the decompression to pure js

I'm on 2020.1.8f1 for what it's worth

Zaimatsu · Dec 17, 2020

I've been trying to host a unity web player build on Github Pages and have the same problem. I didn't find any solution for this, except building without compression as few before said.
I've posted an issue here, maybe Github community will help:
https://github.community/t/github-pages-referenceerror-unityframework/150646

mr-andersons · Dec 26, 2020

This Decompression Fallback seems to have fixed this for me. Am I losing any compression when using this?

Triplefun-Damian · Dec 28, 2020

mr-andersons said: ↑

This Decompression Fallback seems to have fixed this for me. Am I losing any compression when using this?
Click to expand...

No, you're just off-loading the decompression to the client-side once the download has completed, which will make the start up slower (and your final payload a bit heavier as it now has a bunch of JS decompression code)

When you get the correct headings set on the server, the decompression is done for "free" by the browser itself as it's downloading.

Master_Eisa · Jan 12, 2021

Hello everybody,

I have set all metadata regarding content type and content encoding as described. Unfortunately it doesn't work for me. Decompressing data and wasm file seem to work but. Build.framework.js.(Gz) or (br) I've tried both compressions. I still get the following error.

Code (JavaScript):

Uncaught ReferenceError: unityFramework is not defined

I am currently providing my game uncompressed. It would be really nice if that would work, because I already deploy the game without texture compression, as it is currently not supported by unity on mobile devices.
What am I doing wrong? or is it still an existing bug?

Best regards Björn

mmuller · Jan 14, 2021

Just to add 2021.1.0b1725 with GZIP compression returns:

Code (javscript):

abort("both async and sync fetching of the wasm failed") at jsStackTrace@

Using this .htaccess file:

Code (htaccess):

# This configuration file should be uploaded to the server as "<Application Folder>/Build/.htaccess"

# This configuration has been tested with Unity 2020.1 builds, hosted on Apache/2.4

# NOTE: "mod_mime" Apache module must be enabled for this configuration to work.

<IfModule mod_mime.c>

# The following lines are required for builds without decompression fallback, compressed with gzip

RemoveType .gz

AddEncoding gzip .gz

AddType application/octet-stream .data.gz

AddType application/wasm .wasm.gz

AddType application/javascript .js.gz

AddType application/octet-stream .symbols.json.gz

# The following lines are required for builds without decompression fallback, compressed with Brotli

RemoveType .br

RemoveLanguage .br

AddEncoding br .br

AddType application/octet-stream .data.br

AddType application/wasm .wasm.br

AddType application/javascript .js.br

AddType application/octet-stream .symbols.json.br

# The following line improves loading performance for uncompressed builds

AddType application/wasm .wasm

# Uncomment the following line to improve loading performance for gzip-compressed builds with decompression fallback

# AddEncoding gzip .unityweb

# Uncomment the following line to improve loading performance for brotli-compressed builds with decompression fallback

# AddEncoding br .unityweb

zezba9000 · Jan 23, 2021

Same issue on Unity 2020.2.2
Have to turn off gzip compression or enabled fallback

Munkey · Jan 30, 2021

zezba9000 said: ↑

Same issue on Unity 2020.2.2
Have to turn off gzip compression or enabled fallback
Click to expand...

What do you mean? Turn off gzip compression where? where is enable fallback?

zezba9000 · Jan 30, 2021

Munkey said: ↑

What do you mean? Turn off gzip compression where? where is enable fallback?
Click to expand...

Munkey · Jan 30, 2021

zezba9000 said: ↑

View attachment 785087
Click to expand...

Thank you so much!

ronshalev3d · Jan 31, 2021

zezba9000 said: ↑

View attachment 785087
Click to expand...

Did you use also as Development Build?

zezba9000 · Feb 1, 2021

ronshalev3d said: ↑

Did you use also as Development Build?
Click to expand...

No release build works fine

wechat_os_Qy0zi83TzMbgvXiL3uYvsdqhQ · Feb 8, 2021

This issue still exist in 2020.2.3f1

epicoro · Feb 8, 2021

It is not a bug! Your server configuration is wrong. Follow this example. Make sure you refresh the page with Shift+F5. This should resolve your issuess and you can use compression as usual.

grimunk · Feb 16, 2021

If you use S3/cloudflare you can gzip your .unityweb files but omit the extension. You can add metadata to them on S3 to bind the content-encoding: gzip header. It's a bit less work going this route than running/maintaining your own server, probably cheaper too.

Bshsf_9527 · Feb 27, 2021

mmuller said: ↑

Just to add 2021.1.0b1725 with GZIP compression returns:

Code (javscript):

abort("both async and sync fetching of the wasm failed") at jsStackTrace@

Using this .htaccess file:

Code (htaccess):

# This configuration file should be uploaded to the server as "<Application Folder>/Build/.htaccess"

# This configuration has been tested with Unity 2020.1 builds, hosted on Apache/2.4

# NOTE: "mod_mime" Apache module must be enabled for this configuration to work.

<IfModule mod_mime.c>

# The following lines are required for builds without decompression fallback, compressed with gzip

RemoveType .gz

AddEncoding gzip .gz

AddType application/octet-stream .data.gz

AddType application/wasm .wasm.gz

AddType application/javascript .js.gz

AddType application/octet-stream .symbols.json.gz

# The following lines are required for builds without decompression fallback, compressed with Brotli

RemoveType .br

RemoveLanguage .br

AddEncoding br .br

AddType application/octet-stream .data.br

AddType application/wasm .wasm.br

AddType application/javascript .js.br

AddType application/octet-stream .symbols.json.br

# The following line improves loading performance for uncompressed builds

AddType application/wasm .wasm

# Uncomment the following line to improve loading performance for gzip-compressed builds with decompression fallback

# AddEncoding gzip .unityweb

# Uncomment the following line to improve loading performance for brotli-compressed builds with decompression fallback

# AddEncoding br .unityweb

Click to expand...

Try to change those files which endwith ".br.gz" 's MIME Type to "application/octet-stream".
for example
commond "AddType application/javascript .js.gz" should be "AddType application/octet-stream .js.gz"
...
and so on.

because I think .js.gz is a binary file rather than a js file.

I test and found .wasm.gz file still use application/wasm but not application/octet-stream

After update web configuration ,you need clear the webbrowser caching ,then you can run webgl application.

Bshsf_9527 · Feb 27, 2021

jukka_j said: ↑

Starting from Unity 2020.1, Unity WebGL projects no longer enable the Software Decompression Fallback of gzip and brotli by default. The software decompression fallback was added there because a lot of web servers are misconfigured and they do not properly advertise compressed content to the browser clients.

When a web server properly declares compressed content to the browser, the browser can decompress the content already while it downloads the file (streamed decompression). This effectively means that decompression comes "for free" since download times generally dominate on the web.

In the absence of properly declared compression, the software decompression fallback would manually run a decompressor after all the content has already been received by the browser. This is much slower than the pipelined approach that the browser is able to do, and a disservice of sorts to users, who would not be able to observe that they are not getting the best performance out of their Unity WebGL build startup times.

To fix the issue, the primary approach is to usher people to set up proper web hosting configuration. If this is not possible (e.g. cannot access the web server configuration since you are not the web admin), the software compression fallback still exists in Unity in 2020.1, but now just needs to be enabled manually.

Here is the server configuration block I would recommend to be used for nginx. It enables Brotli and gzip pre-compressed file compression support, WebAssembly streaming, and on-demand gzip compression if Unity builds did not have compression enabled when the project was built.

Code (JavaScript):

# Enable on-the-fly gzip compression of uncompressed files

# See https://docs.nginx.com/nginx/admin-guide/web-server/compression/

# See also http://nginx.org/en/docs/http/ngx_http_gzip_module.html

#

# For a more advanced installation, one can try brotli-compressing the files on demand.

# See https://github.com/google/ngx_brotli

#

# Brotli is not enabled by default here however, because the support is not included in

# nginx by default but one must install Brotli support from source. Replace the gzip

# directives with their commented out Brotli counterparts if you would like to enable on-demand

# Brotli compression. (remember to add "load_module modules/ngx_http_brotli_filter_module.so;"

# directive to top level of nginx.conf)

gzip on;

#brotli on;

# N.b. there also exists a feature "gzip_static" in nginx,

# http://nginx.org/en/docs/http/ngx_http_gzip_static_module.html,

# however that feature can be ignored, as Unity generates precompressed content

# from WebGL Build Settings menu out of the box.

# Unfortunately nginx does not support caching compressed files to avoid

# needing to recompress each time, so use a low compression level to keep

# things fast. (this is already the default, but shown here for posterity)

gzip_comp_level 1;

# brotli_comp_level 0; # (defaults to 6)

# Send the HTTP Response header "Vary: Accept-Encoding" as part of compressed

# requests. If an intermediate caching web proxy is used in-between, this

# will enable the proxy to properly cache compressed vs noncompressed files.

gzip_vary on;

# The following file types should be compressed on demand (.html, .js, .data, .wasm and .symbols.json).

# To ensure that .data files and .symbols.json files are compressed on demand,

# we define a custom MIME type application/octet-stream-compressible (not a registered IANA type)

# that we associate with these file suffixes so that they will be compressed on demand.

# This way we will be careful not to sloppily enable compression for *all* application/octet-stream

# files on the whole server, which might be undesirable for performance.

gzip_types application/wasm application/javascript application/octet-stream-compressible;

# brotli_types application/wasm application/javascript application/octet-stream-compressible;

# Nginx has two limitations to keep in mind:

# 1. While the file mime.types can be used to configure MIME types for file suffixes, that file

# does not support describing files that have multiple suffixes (e.g. .symbols.json or .data.gz)

# Therefore we use the location directives here to configure the MIME types for all file suffixes.

# 2. For each request, only one location specifier is used to match and serve a file. Therefore

# the following code has a little bit of repetition in order to cover each unique suffix.

# Our custom octet-stream-compressible MIME type for data files that compress well.

location ~ .+\.(data|symbols\.json)$ {

default_type application/octet-stream-compressible;

}

# Register default MIME type for .wasm files (this could also be done in mime.types but since

# we need to define MIME types for files that have multiple suffixes, do it all here to be

# coherent)

# Alternatively you can add a line

# application/wasm wasm;

# to mime.types

location ~ .+\.wasm$ {

# Enable streaming WebAssembly compilation by specifying the correct MIME type for

# Wasm files.

default_type application/wasm;

}

# On-disk Brotli-precompressed data files should be served with compression enabled:

location ~ .+\.(data|symbols\.json)\.br$ {

# Because this file is already pre-compressed on disk, disable the on-demand compression on it.

# Otherwise nginx would attempt double compression.

gzip off;

#brotli off;

add_header Content-Encoding br;

# No special MIME type need to be declared here (can add application/octet-stream

# for .data and application/json for .symbols/json if one desires, but that does

# not get used for anything, so keep the configuration simple by omitting them)

}

# On-disk Brotli-precompressed JavaScript code files:

location ~ .+\.js\.br$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding br;

default_type application/javascript;

}

# On-disk Brotli-precompressed WebAssembly files:

location ~ .+\.wasm\.br$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding br;

# Enable streaming WebAssembly compilation by specifying the correct MIME type for

# Wasm files.

default_type application/wasm;

}

# On-disk gzip-precompressed data files should be served with compression enabled:

location ~ .+\.(data|symbols\.json)\.gz$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding gzip;

}

# On-disk gzip-precompressed JavaScript code files:

location ~ .+\.js\.gz$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding gzip;

default_type application/javascript;

}

# On-disk gzip-precompressed WebAssembly files:

location ~ .+\.wasm\.gz$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding gzip;

# Enable streaming WebAssembly compilation by specifying the correct MIME type for

# Wasm files.

default_type application/wasm;

}

Reading the above comments, there are some nginx configuration files that use

Code (CSharp):

add_header Content-Type application/javascript;

directive to set up a MIME type. That unfortunately does not set a MIME type, but just appends a new header. The result will be that nginx will actually send two instances of the Content-Type header in the HTTP responses. Instead check out the "default_type" directive to set the header instead of appending, to avoid this duplication.
Click to expand...

I use unity 2020.2.6 and IIS webserver and with gzip compression, I also face this issue even I use the "web.config" in this example , and I find out that those web configuration maybe have some mistake ,because when I change ".js.gz" 's MIME Type From "application/javascript" to "application/octet-stream" and clear webbrowser caching and run webgl application again, it worked correctly without stunking any more.
As I am not a Server backend developer， I cannot tall the diffrent why this worked and donot know wheth if any other mistake in the web configuration that your team have had supported .
At least, I think ,maybe files endwith ".json.br" is also belong to "octet-stream" MIME Type.

Flasterblat · Apr 11, 2021

hippocoder said: ↑

Any suggestions?

Is WebGL is non functional in 2020.1 alpha?
Click to expand...

Disable compression.
File > Build Settings > Player Settings > Player > Publishing Settings > Compression Format = Disabled

ickydime · Apr 13, 2021

This issue still exists on Unity 2020.3.2f1

Bshsf_9527 · Apr 15, 2021

Flasterblat said: ↑

Disable compression.
File > Build Settings > Player Settings > Player > Publishing Settings > Compression Format = Disabled
Click to expand...

.wasm.gz file still use application/wasm but not application/octet-stream
After update web configuration ,you need clear the webbrowser caching ,then you can run webgl application.

nannings · May 17, 2021

Bug still exists (unity 2020.2.8f1)

gskikos · May 22, 2021

Removing compression resolves the problem with 2020.1.5f1

nxtboyIII · May 24, 2021

Bug still exists 2020.3.6f1

number_29 · May 25, 2021

Now the 2020.2.6f1 version I am using still has the same error. Compression format :disabled will fix it.

jhocking · Jun 18, 2021

Well on the one hand, thanks for this explanation because I hit this issue when doing a WebGL build from the latest LTS, Unity 2020.3.

On the other hand, you guys should really put some notice within Unity itself that this is gonna happen, because it was totally mystifying until I googled up this thread. Something like a popup warning about the server settings and linking to https://docs.unity3d.com/Manual/webgl-deploying.html

jukka_j said: ↑

Starting from Unity 2020.1, Unity WebGL projects no longer enable the Software Decompression Fallback of gzip and brotli by default. The software decompression fallback was added there because a lot of web servers are misconfigured and they do not properly advertise compressed content to the browser clients.

When a web server properly declares compressed content to the browser, the browser can decompress the content already while it downloads the file (streamed decompression). This effectively means that decompression comes "for free" since download times generally dominate on the web.

In the absence of properly declared compression, the software decompression fallback would manually run a decompressor after all the content has already been received by the browser. This is much slower than the pipelined approach that the browser is able to do, and a disservice of sorts to users, who would not be able to observe that they are not getting the best performance out of their Unity WebGL build startup times.

To fix the issue, the primary approach is to usher people to set up proper web hosting configuration. If this is not possible (e.g. cannot access the web server configuration since you are not the web admin), the software compression fallback still exists in Unity in 2020.1, but now just needs to be enabled manually.

Here is the server configuration block I would recommend to be used for nginx. It enables Brotli and gzip pre-compressed file compression support, WebAssembly streaming, and on-demand gzip compression if Unity builds did not have compression enabled when the project was built.

Code (JavaScript):

# Enable on-the-fly gzip compression of uncompressed files

# See https://docs.nginx.com/nginx/admin-guide/web-server/compression/

# See also http://nginx.org/en/docs/http/ngx_http_gzip_module.html

#

# For a more advanced installation, one can try brotli-compressing the files on demand.

# See https://github.com/google/ngx_brotli

#

# Brotli is not enabled by default here however, because the support is not included in

# nginx by default but one must install Brotli support from source. Replace the gzip

# directives with their commented out Brotli counterparts if you would like to enable on-demand

# Brotli compression. (remember to add "load_module modules/ngx_http_brotli_filter_module.so;"

# directive to top level of nginx.conf)

gzip on;

#brotli on;

# N.b. there also exists a feature "gzip_static" in nginx,

# http://nginx.org/en/docs/http/ngx_http_gzip_static_module.html,

# however that feature can be ignored, as Unity generates precompressed content

# from WebGL Build Settings menu out of the box.

# Unfortunately nginx does not support caching compressed files to avoid

# needing to recompress each time, so use a low compression level to keep

# things fast. (this is already the default, but shown here for posterity)

gzip_comp_level 1;

# brotli_comp_level 0; # (defaults to 6)

# Send the HTTP Response header "Vary: Accept-Encoding" as part of compressed

# requests. If an intermediate caching web proxy is used in-between, this

# will enable the proxy to properly cache compressed vs noncompressed files.

gzip_vary on;

# The following file types should be compressed on demand (.html, .js, .data, .wasm and .symbols.json).

# To ensure that .data files and .symbols.json files are compressed on demand,

# we define a custom MIME type application/octet-stream-compressible (not a registered IANA type)

# that we associate with these file suffixes so that they will be compressed on demand.

# This way we will be careful not to sloppily enable compression for *all* application/octet-stream

# files on the whole server, which might be undesirable for performance.

gzip_types application/wasm application/javascript application/octet-stream-compressible;

# brotli_types application/wasm application/javascript application/octet-stream-compressible;

# Nginx has two limitations to keep in mind:

# 1. While the file mime.types can be used to configure MIME types for file suffixes, that file

# does not support describing files that have multiple suffixes (e.g. .symbols.json or .data.gz)

# Therefore we use the location directives here to configure the MIME types for all file suffixes.

# 2. For each request, only one location specifier is used to match and serve a file. Therefore

# the following code has a little bit of repetition in order to cover each unique suffix.

# Our custom octet-stream-compressible MIME type for data files that compress well.

location ~ .+\.(data|symbols\.json)$ {

default_type application/octet-stream-compressible;

}

# Register default MIME type for .wasm files (this could also be done in mime.types but since

# we need to define MIME types for files that have multiple suffixes, do it all here to be

# coherent)

# Alternatively you can add a line

# application/wasm wasm;

# to mime.types

location ~ .+\.wasm$ {

# Enable streaming WebAssembly compilation by specifying the correct MIME type for

# Wasm files.

default_type application/wasm;

}

# On-disk Brotli-precompressed data files should be served with compression enabled:

location ~ .+\.(data|symbols\.json)\.br$ {

# Because this file is already pre-compressed on disk, disable the on-demand compression on it.

# Otherwise nginx would attempt double compression.

gzip off;

#brotli off;

add_header Content-Encoding br;

# No special MIME type need to be declared here (can add application/octet-stream

# for .data and application/json for .symbols/json if one desires, but that does

# not get used for anything, so keep the configuration simple by omitting them)

}

# On-disk Brotli-precompressed JavaScript code files:

location ~ .+\.js\.br$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding br;

default_type application/javascript;

}

# On-disk Brotli-precompressed WebAssembly files:

location ~ .+\.wasm\.br$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding br;

# Enable streaming WebAssembly compilation by specifying the correct MIME type for

# Wasm files.

default_type application/wasm;

}

# On-disk gzip-precompressed data files should be served with compression enabled:

location ~ .+\.(data|symbols\.json)\.gz$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding gzip;

}

# On-disk gzip-precompressed JavaScript code files:

location ~ .+\.js\.gz$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding gzip;

default_type application/javascript;

}

# On-disk gzip-precompressed WebAssembly files:

location ~ .+\.wasm\.gz$ {

gzip off; # Do not attempt dynamic gzip compression on an already compressed file

#brotli off;

add_header Content-Encoding gzip;

# Enable streaming WebAssembly compilation by specifying the correct MIME type for

# Wasm files.

default_type application/wasm;

}

Reading the above comments, there are some nginx configuration files that use

Code (CSharp):

add_header Content-Type application/javascript;

directive to set up a MIME type. That unfortunately does not set a MIME type, but just appends a new header. The result will be that nginx will actually send two instances of the Content-Type header in the HTTP responses. Instead check out the "default_type" directive to set the header instead of appending, to avoid this duplication.
Click to expand...

jhocking · Jun 18, 2021

nxtboyIII said: ↑

Bug still exists 2020.3.6f1
Click to expand...

To all the people reporting that the bug still exists, my understanding from reading through the explanations is that this isn't really a bug, it's just that we're all running afoul of some unexpected but intended behavior. Thus, my suggestion that the "fix" here is for Unity to make it clearer what's going on, because right now it sure looks like something is broken.

Something like a popup within Unity when you do a WebGL build that links to https://docs.unity3d.com/Manual/webgl-deploying.html

Stardog · Jul 2, 2021

Had this issue in 2020.3.12f1.

"Enable decompression fallback" fixed it, but only if a Compression Format is also selected, instead of Disabled.

We should be able to click-drag the index.html into our browser and have it work.

Jurassic · Aug 22, 2021

jhocking said: ↑

To all the people reporting that the bug still exists, my understanding from reading through the explanations is that this isn't really a bug, it's just that we're all running afoul of some unexpected but intended behavior. Thus, my suggestion that the "fix" here is for Unity to make it clearer what's going on, because right now it sure looks like something is broken.

Something like a popup within Unity when you do a WebGL build that links to https://docs.unity3d.com/Manual/webgl-deploying.html
Click to expand...

Can confirm this is still confusing as heck for someone doing WebGL builds for the first time. This thread has been the most helpful source of information on the topic, despite not being among the first Google results I found.

From what I understand if one is able to get compression working with the fallback option still enabled that should be an acceptable, if annoying, solution. Better than disabling compression entirely, at least. I think this configuration was the default setting (Decompression Fallback On) until this changed in the past year or so, so it is a relatively recent thing that people new to WebGL & Unity are encountering.

Things are still compressed this way, the user's PC just has to do some extra work to decompress the files, opposed to the decompression being handled automatically by the browser as the files are being downloaded if the server the fiels are on is configured properly.

zoofinders · Aug 23, 2021

OneManArmy3D said: ↑

Try to disable compression.
Click to expand...

Where can you disable compression

erdostamasa · Aug 26, 2021

Happening for 2020.3.16f1

WebGL.framework.js.gz:1 Uncaught SyntaxError: Invalid or unexpected token
WebGL.loader.js:1 Uncaught ReferenceError: unityFramework is not defined
at HTMLScriptElement.r.onload (WebGL.loader.js:1)

damian_pablo_gonzalez · Sep 16, 2021

Schubkraft said: ↑

should be fixed for 20.1a24
Click to expand...

I know it's an old post, but it's still happening in 2020.3.7f1, in remote location.
Changing "build settings > publishing settings > compression format" to "Disabled" solved it.

jhocking · Sep 17, 2021

damian_pablo_gonzalez said: ↑

I know it's an old post, but it's still happening in 2020.3.7f1, in remote location.
Changing "build settings > publishing settings > compression format" to "Disabled" solved it.
Click to expand...

This post has an image explaining this:
https://forum.unity.com/threads/unc...cript-onload-webgl.803967/page-2#post-6782027

Although I would recommend the fallback option at the bottom, not disabling compression. In other words, keep compression on, but enable the decompression fallback.

Search Unity

Bug Uncaught ReferenceError: unityFramework is not defined at HTMLScriptElement.script.onload (WebGL)

jukka_j

Unity Technologies

UltimateGamer84

adambielecki

PaulRdy

Triplefun-Damian

Zaimatsu

mr-andersons

Triplefun-Damian

Master_Eisa

mmuller

zezba9000

Munkey

zezba9000

Munkey

ronshalev3d

zezba9000

wechat_os_Qy0zi83TzMbgvXiL3uYvsdqhQ

epicoro

grimunk

Bshsf_9527

Bshsf_9527

Flasterblat

ickydime

Bshsf_9527

nannings

gskikos

nxtboyIII

number_29

jhocking

jhocking

Stardog

Jurassic

zoofinders

erdostamasa

damian_pablo_gonzalez

jhocking

Search Unity

Unity ID

Bug Uncaught ReferenceError: unityFramework is not defined at HTMLScriptElement.script.onload (WebGL)

Unity Technologies