Skip to content

Embedding

GarboMuffin edited this page Mar 5, 2021 · 52 revisions

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. Change width and height to match your needs. The player will automatically resize to fit. Feel free to use this however you please.

URL parameters

All standard URL Parameters are still available, along with some special values exclusive to 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.

Usernames and cloud variables

By default the embed will generate a random username for each user. Unlike the homepage where this is remembered between visits, the embed generates a new one every visit. You can use the username URL parameter to override this behavior, for example: https://turbowarp.org/443603478/embed?username=1234

If you don't need cloud variables, consider setting the username parameter to an empty value to potentially reduce load on our server, for example: https://turbowarp.org/443603478/embed?username

Security considerations

If you use user-supplied information to generate an embed link, please make sure to use encodeURIComponent or other sanitization to make sure that users cannot specify arbitrary parameters.

Licensing

While some pages in TurboWarp are licensed under the GPLv3.0, the embed page is not one of these pages. It is licensed under the permissive BSD-3-Clause License and is not subject to the terms of the GPL. (In other words, it does not load any GPL-licensed code and you are therefore not subject to the terms of the GPL)

This also means that the embed will not load any addons, which are GPLv3.0.

I am not a lawyer and this is not legal advice.

Clone this wiki locally