Skip to main content

Share codes

A share code lets a creator hand you a widget that isn't listed in the public Workshop. It's the way to share work-in-progress widgets, commissions, or team-only widgets privately. A code looks like CW-XXXXX.

Redeem a code​

  1. Open Widget Workshop from the sidebar.
  2. Paste the CW-XXXXX code into the share-code box in the header and look it up.
  3. You'll see the widget's name and status. Click Install (or Remix, if the widget allows it).

Once installed, the widget behaves exactly like any other custom widget — it appears under Add Widget → Custom widgets and you configure it through its properties. See Installing widgets.

What a code grants​

A code always lets you install and use the widget on your overlays. If the author has switched on Allow remixing for that widget, the code also lets you fork it into your own editable copy in the Widget Creator.

Widget settingA code lets you…
Allow remixing offInstall and use it.
Allow remixing onInstall it and fork it.

See Publishing & sharing → Licensing.

When you remix a private widget through a code, your copy is for your own use. You can build it and use it on your overlays, but you can't publish it or share it. See Remixing.

Create a code (for authors)​

Codes are for private widgets. Open your widget's settings, go to Share privately, and copy the code. A public widget doesn't need one, so that section is switched off and says so. You can rotate the code at any time, which invalidates the old one. That's handy if a code leaks or a collaboration ends.

What a code grants follows your Allow remixing setting. There's no second remix switch to keep in sync.

Anyone you give a code to can pass it on. Make a new code to cut them all off. Remixes made with a code are for the remixer's own use.

Your widget must be built and published before its code works.

Remixing​

If you have a remix grant (or the widget is publicly remixable), forking it creates a new widget that you own, with its own copy of the code. From there you can change anything, subject to the original's licence.

  • A remix of a public widget can be published under your own name. A widget built from a share-alike (CC-BY-SA) widget must keep the same licence.
  • A remix of a privately shared widget is for your own use. You can't publish it or share it, and it doesn't get a share code of its own. The author gave you permission, not permission to give others permission. If you made the original yourself, this doesn't apply to you.

Remixing is a great way to learn — install a remixable widget, fork it, and read how it works in the editor.