Extension Gallery

Submitting an extension

Important

Once submitted, your extension CANNOT be removed from the files. Your extension may be delisted, but the code must NEVER be removed.

This is to prevent projects being broken. If we remove your code, anyone who used your extension will have to remake their ENTIRE project without editing their file manually.

Step 1.

Create your extension. You can find a lot of details here.

Important Guidelines:

• Your extension should not already exist on the gallery. Please check the Pull Requests and our extension gallery to confirm.
• Your extension should be created for a specific purpose. An extension with random blocks someone might need will likely not get accepted if the blocks are not in a certain theme, like math or rendering.
• The primary purpose of your extension CANNOT be a monetization.
• Your extension CANNOT use eval() or new Function().
• If your extension uses external content such as JS libraries or CSS stylesheets, you must include them inside the extension code itself. You CANNOT fetch/import content from URLs that is a core part of your extension as it'll make the extension unusable offline, or in offline packaged projects. This does not apply to:
  • content that obviously requires internet, like an extension that allows projects to use a public API.
  • content of SDK-extensions, like "Yandex Games SDK (Unofficial)" extension.
• Your extension CANNOT be made entirely with AI and CANNOT be made ENTIRELY OR PARTLY with assistive tools such as TurboBuilder, ExtForge. You must understand the raw code your extension is running.
• Your extension CANNOT rely on the use of any generative AI. This is mainly for extensions that respond to messages from AI like ChatGPT.
• Your extension CANNOT reference, contain or use any content not suitable for ages under 16. (including extension icon and extension code)
• Your extension CANNOT contain discriminatory content or content that is against a certain group or minority.

Recommended Guidelines (optional):

• Your blocks should start with lowercase letter.
• Your blocks' texts should contain only letters. (No emojis, symbols, etc.)
• Your code should be clean. (You can use Prettier for it)
• Your code should start like this:

// Name: Extension
// ID: meMyExtension
// Description: Cool extension.
// By: Me <https://scratch.mit.edu/users/me/>
// License: MIT

// ...

• If your extension needs to run unsandboxed, you should check it via Scratch.extensions.unsandboxed.
• If your extension uses things that only work in Dash, you should check for platform before using them via Scratch.extensions.isDash.

Step 2.

Create info for your extension, like a description and a banner/thumbnail. The banner/thumbnail is not required, but it will be a static/images/unknown.svg if not provided.

Important Guidelines:

• Your banner/thumbnail MUST BE MIT licensed. (basically just make it yourself and the image should be usable anywhere)
• Your banner/thumbnail MUST BE 600x300 pixels.
• Your banner/thumbnail CANNOT reference or contain any content not suitable for ages under 16.
• If your banner/thumbnail is in SVG format, it CANNOT contain <text> elements.
• Ideally, your banner/thumbnail shound not contain any text, that needs to be translated, such as the name of extension.

Step 3.

Add your extension in the static/extensions folder.

Open this link in a new tab to open the folder.

• Click Add File at the top and click Create new file.
• GitHub will likely tell you to make a fork to do this step. Make sure to create one as you'll need to have the files somewhere.
• Create a new folder with your Scratch or GitHub username. You can do this by typing the username as the file name, and then typing a /. Then type the actual file name, followed by .js.
• Now, paste your extension's code into the file.
• You should now be able to Commit changes or Create a pull request, it'll likely be a green button.

Step 4.

Update the extension ID.

To avoid conflicts or issues with other extensions, please put your name in the extension ID. Use only characters a-z, A-Z and numbers to ensure that the ID is valid.

Note: Some extensions may be accepted without this rule if they provide reason.

For example: myExtension could be johnMyExtension or johnmyExtension

Step 5.

Create the pull request.

Continue through the menus until it lets you create a pull request.

You can post your extension banner/thumbnail and or description in the pull request.

Once your pull request is merged, it'll be on the site or upcoming onto the site. You may get responses about things you should change or fix though.

See the Optional Steps for more info on how to edit the site to show your extension.

Optional Steps

Step 6.

Add your extension banner to the website.

To do this, your GitHub profile should now have a fork of the repository. It will probably be under the same name.

Open this repository, and enter the static/images folder.

If you are using the website to add the file:

1. Click Add File at the top and click Create new file.
2. At the top where the file name is, type your username and then a / character.
3. Now type any file name and type anything inside the file, then create the file.
4. Exit back into the folder you created and instead, upload a file.
5. Upload your extension banner here. The banner should have the same name as your extension.
6. Go back to your original file you created to make the folder, and delete the file.

This should create the folder with the uploaded image inside.

Step 7.

Add your extension onto the extensions list.

Enter the src/lib/extensions.js file in the repository.

If you know JSON then you can tell how to edit the list inside, but otherwise try to keep the format of the last extension listed. Each extension is incased in {} brackets. Look below on how to copy it.

{
    name: "Evaluating Expressions", // The name of the extension.
    id: "usernameEvalExprsns", // The ID of the extension. Must be same as inside the extension code.
    description: "Blocks to return the result of an expression.", // The description for the extension.
    code: "Username/extension.js", // The folder and file name for the code of the extension.
    banner: "Username/Extension.png", // The folder and file name for the banner of the extension.
    creator: "Username", // Username of extension creator. For more information, see "Add creator(s)".
    
    // Only applies if you created a documentation page.
    documentation: "page-name", // This is the page name for the documentation you created.

    // These next ones are optional. You can choose not to include them.
    notes: "Additional help by someguy", // Optional. Allows you to note anyone else who helped you or any small info.
},

Add creator(s):

• One creator with username without link:

{
    // ...
    creator: "Username", // Username of extension creator.
    // ...
},

• One creator with username with link:

{
    // ...
    creator: { name: "Username", link: "_scratch_" },
    /*
        "name" - Username of extension creator.
        "link" can be:
            * "_scratch_" - Adds a link to Scratch profile whose username is specified in "name".
            * "_github_" - Adds a link to GitHub profile whose username is specified in "name".
            * Link to social profile. (ALLOWED Scratch or GitHub profile)
    */
    // ...
},

• Two and more creators:

{
    // ...
    creator: [
        "CreatorNo1",
        { name: "CreatorNo2", link: "_scratch_" },
        { name: "CreatorNo3", link: "_github_" },
        { name: "Den4ik-12", link: "https://github.com/DDen4ik-12" },
        // ...
    ],
    // ...
},