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 code 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 share code carries one of two permissions, chosen by the creator:

GrantYou can…
InstallInstall and use the widget on your overlays.
RemixInstall and fork it into your own editable copy in the Widget Creator.

A remix grant only works if the widget's author marked it remixable. See Publishing & sharing → Licensing.

Create a code (for authors)

If you're the author, mint a share code from your widget's publishing controls and choose whether it grants install or remix. You can rotate the code at any time, which invalidates the old one — handy if a code leaks or a collaboration ends.

Share codes work whether your widget is public or private, so you can hand a specific build to a tester without listing it for everyone.

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 and publish it under your own name, subject to the original's licence. A widget built from a share-alike (CC-BY-SA) widget must keep the same licence.

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