Skip to content

Embedding

GarboMuffin edited this page Jul 15, 2021 · 52 revisions

This page has moved to https://docs.turbowarp.org/embedding

Embedding TurboWarp is very similar to how you embed Scratch 3:

<iframe src="https://turbowarp.org/414716080/embed" width="499" height="416" allowtransparency="true" frameborder="0" scrolling="no" allowfullscreen></iframe>

Replace 414716080 with the ID of your project. The dimensions above of 499x416 will result in the stage itself being rendered without distortion at the default stage size (480x360), but you can change it to anything and the player will automatically resize to fit.

URL parameters

All standard URL Parameters are still available. You can use these to control usernames and other things.

There are also some special values only available in embeds:

Autoplay

Embeds also support the autoplay parameter, which will automatically hit the green flag when the project is loaded. For example: https://turbowarp.org/15832807/embed?autoplay

Note that audio may not work until the user interacts with the project (for example, clicking). This is a restriction imposed by browsers. There is nothing TurboWarp can do to work around this.

Security considerations

If you use user-supplied information to generate embed links, please make sure to use encodeURIComponent or other sanitization to make sure that users cannot specify arbitrary parameters, as some parameters can cause remote code execution or other unexpected behaviors.

License

TurboWarp is licensed under the GPLv3.0. We believe that an <iframe> of a GPLv3.0 work doesn't create a derivative work under the GPLv3.0, rather, it creates an "aggregate work" (which is not subject to the same requirements as derivative works). However, we are not lawyers and this is not legal advice. Talk to a real lawyer for more information.

Need more control?

Try the TurboWarp Packager.

Clone this wiki locally