Godot COI Service Worker

This plugin makes use of the coi-serviceworker Javascript library to enable cross-origin isolation in Godot 4 games for situations in which you can't control the headers. In other words, it fixes the SharedArrayBuffer error.

See also this Godot proposal.

Read This First: Alternatives

1. If your web host allows you to set the proper headers, you should do that instead. For example, itch.io and Newgrounds both have options to enable this feature (refered to as enabling SharedArrayBuffer support).
2. In Godot 4.3, you can export a build that doesn't use threads. This should allow you to run your game without the cross-origin headers, which means you would not need this plugin. This may be a better alternative in many situations. More info here
3. Also in Godot 4.3, you can export a Progressive Web App (PWA), which has the option to have the functionality of this plugin built-in. More info here

Usage

Simply install this plugin and enable it in your project settings. When you export a Web build, the plugin will add the Javascript file to enable this feature. This script will reload the page on the user's first load to magically add the required COOP and COEP headers in a service worker. See the coi-serviceworker project page for more information.

Export Options

• Include Coi Service Worker - Whether to include the service worker. On by default, and you probably want this left on since that's the core of this addon.
• Iframe Breakout - If enabled, it will generate an index.html file that only has a button to open the game outside of the iframe it starts in. This can help on hosts that put the game in an iframe, since that often will not work. In order to use this feature, you must not export your game as index.html.

Limitations

There is a good chance that any host that embeds your game in an iframe within another page will still not work with this addon. If you were to open that embedded page into its own tab, it will probably work, but while it is embedded it won't. You can use the export option mentioned above to break out of the iframe.

Version History

v1.2

• Export options are now only visbible for web exports (thanks florianvazelle)

v1.1

• Now hides the SharedArrayBuffer error message on the intial load, before the service worker is loaded
• Added export options "Include Coi Service Worker" and "Iframe Breakout"
• Updated coi-serviceworker.min.js to v0.1.7

v1.0

• Initial release