Create a Node.js server configuration file that lets your Node.js server work with your Unity Web build.
Node.js is an open-source runtime environment that lets you execute JavaScript code on the server side. In Unity, you can use a Node.js app to serve your Unity Web build.
For more information about Node.js and how to install and use it, refer to the Node.js documentation.
To create a package.json file that’s ready for use with Unity Web:
Create a file in a text editor or IDE.
Name the file package.json
.
Save your file in your Node.js project directory.
Paste the following code into the file:
{
"name": "node_server_example",
"version": "1.0.0",
"description": "An example for serving a Unity Web build with Node.js",
"main": "index.js",
"dependencies": {
"express": "^4.19.2"
}
}
Your package.json
file is now ready for use. The code defines the index.js
file as your server project’s entry point, and defines the libraries your project will depend on.
To prepare your index.js file for use with Unity Web:
Create a file in a text editor or IDE.
Name the file package.json
.
Save your file in your Node.js project directory.
Paste the following code into the file:
#!/usr/bin/env node
const path = require('path');
const express = require('express');
// Create express application
const app = express();
// Settings
const hostname = 'localhost';
const port = 8080;
const enableCORS = true;
const enableWasmMultithreading = true;
// Serve the current working directory
const unityBuildPath = __dirname; // Note: this makes the current working directory visible to all computers over the network.
app.use((req, res, next) => {
var path = req.url;
// Provide COOP, COEP and CORP headers for SharedArrayBuffer
// multithreading: https://web.dev/coop-coep/
if (enableWasmMultithreading &&
(
path == '/' ||
path.includes('.js') ||
path.includes('.html') ||
path.includes('.htm')
)
) {
res.set('Cross-Origin-Opener-Policy', 'same-origin');
res.set('Cross-Origin-Embedder-Policy', 'require-corp');
res.set('Cross-Origin-Resource-Policy', 'cross-origin');
}
// Set CORS headers
if (enableCORS) {
res.set('Access-Control-Allow-Origin', '*');
}
// Set content encoding depending on compression
if (path.endsWith('.br')) {
res.set('Content-Encoding', 'br');
} else if (path.endsWith('.gz')) {
res.set('Content-Encoding', 'gzip');
}
// Explicitly set content type. Files can have wrong content type if build uses compression.
if (path.includes('.wasm')) {
res.set('Content-Type', 'application/wasm');
} else if (path.includes('.js')) {
res.set('Content-Type', 'application/javascript');
} else if (path.includes('.json')) {
res.set('Content-Type', 'application/json');
} else if (
path.includes('.data') ||
path.includes('.bundle') ||
path.endsWith('.unityweb')
) {
res.set('Content-Type', 'application/octet-stream');
}
// Ignore cache-control: no-cache
// when if-modified-since or if-none-match is set
// because Unity Loader will cache and revalidate manually
if (req.headers['cache-control'] == 'no-cache' &&
(
req.headers['if-modified-since'] ||
req.headers['if-none-match']
)
) {
delete req.headers['cache-control'];
}
next();
});
app.use('/', express.static(unityBuildPath, { immutable: true }));
const server = app.listen(port, hostname, () => {
console.log(`Web server serving directory ${unityBuildPath} at http://${hostname}:${port}`);
});
server.addListener('error', (error) => {
console.error(error);
});
server.addListener('close', () => {
console.log('Server stopped.');
process.exit();
});
If your build loads via CORS (for example, embedded on different website), then set the following line in your code to true
, otherwise set it to false
:
const enableCORS = true;
If you created your build with multithreading support, set the following line in your code to true
, otherwise set it to false
:
const enableWasmMultithreading = true;
Your server configuration is now ready for use with Unity Web builds.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.