packager: The project packager.
p4: The Svelte GUI for the packager. "p4" is the name that the packager uses internally to refer to itself.
scaffolding: A minimal Scratch project player used by the packager. Handles most of the boring details of playing Scratch projects such as handling basic mouse input.
common: Files used by both scaffolding and the packager.
addons: Optional addons such as gamepad support or pointerlock.
build: Various internal build tools including some webpack plugins and loaders.
locales: Translations.

Packaged projects generated while in development mode should not be distributed. Instead, you should run a production build to significantly reduce file size of both the website and the packager.

npm run build-prod

Output will be located in the dist folder.

Tips for forks

Branding

Please update the brand strings (src/packager/brand.js) to use your own name and links.
Update the privacy policy (static/privacy.html) to reflect your privacy practices.
Update this document (README.md) too.

Deploying: The packager is deployed as a simple static website. You can host it anywhere by just copying the dist folder after a build. We use GitHub Actions to deploy to GitHub Pages by running the "Deploy" workflow whenever we want to push to production (Actions > Deploy > Run workflow). This should be automatically available in forks after enabling GitHub Actions.

Changing Scratch internals: If you want to change the VM/renderer/etc. used, just npm install or npm link a different scratch-vm/scratch-render/etc and rebuild. You can even install a vanilla scratch-vm and all core functionality will still work (but optional features such as interpolation, high quality pen, stage size, etc. may not work)

Large files: Large files such as NW.js or Electron executables are stored on an external server outside of this repository and have no guarantee of existing long-term. It's easy to setup your own, see src/packager/large-assets.js for more information.

Service worker: Set the environment variable ENABLE_SERVICE_WORKER to 1 to enable service worker for offline support. Not recommended in development. Automatically used the GitHub Actions deploy script.

Standalone builds

To make a production standalone build:

npm run build-standalone-prod

Output will be located in dist/standalone.html.

License

This project is licensed under the GNU Lesser General Public License version 3. See COPYING and COPYING.LESSER for more information. We believe that packaging a project using the packager "makes use of an interface provided by the Library, but which is not otherwise based on the Library"