Serve Unity WebGL Locally When Compression is Enabled
I wrote a simple localhost server that will help you serve your Unity WebGL game, even if the game has GZip or Brotli compression turned on. (The default compression for Unity WebGL is GZip).
Easiest Way
The easiest way: When you "build and run" from unity, Unity will load up your game at a random localhost port ex: localhost:12345, and they will get all the content encoding's right for Gzip and Brotli compression.
But sometimes you want to load up a server after you've done your export--here's how.
TL;DR
Make sure you a have a recent node.js LTS installed.
cd /your/webgl/export
npm install -g serve-unity
serve-unityThen, visit http://localhost:8000 in your web browser and your game will load up.
Note: If you have compression turned off, you can just use python3 -m http.server without installing any packages (assuming you have python3). Details in this article.
Details
A plain old server (python3 -m http.server) does not serve compressed files with the encoding that Unity needs, so there is code in serve-unity that serves these files with the proper content-type and content-encoding.
if (filePath.endsWith(".gz")) {
res.writeHead(200, {
"Content-Type": mimeType,
"Content-Encoding": "gzip",
});
fs.createReadStream(filePath).pipe(res);
} else if (filePath.endsWith(".br")) {
res.writeHead(200, {
"Content-Type": mimeType,
"Content-Encoding": "br",
});
fs.createReadStream(filePath).pipe(res);
}Did this help?
I'd appreciate a star on github:
TheRoccoB
