smalruby3-desktop

Smalruby3 as a standalone desktop application forked from LLK/scratch-desktop.

Changes from Scratch Desktop

• Remove the Scratch Cat, Gobo, Pico, Nano, Tera and Giga graphics (sprites and costumes).
• Remove TRADEMARK file.
• Use smalruby3-gui instead of scratch-desktop.
• Remove telemetry feature, because we don't have a telemetry server.
• Preload setup-opal.js to setup Opal that is copied from smalruby3-gui/static/javascripts/setup-opal.js.
• Set WebRTC IPHandlingPolicy to default.
• Bump up electron version 9.0.0.

Developer Instructions

Prepare smalruby3-gui

This step is temporary: eventually, the smalruby3-desktop branch of the smalruby3-gui repository will be merged with that repository's main development line. For now, though, the smalruby3-desktop branch holds a few changes that are necessary for Scratch Desktop to function correctly but are not yet merged into the main development branch.

Prepare smalruby3-gui: Quick Start

1. Clone both smalruby3-desktop and smalruby3-gui
   1. mkdir smalruby3
   2. cd smalruby3
   3. git clone https://github.com/smalruby/smalruby3-desktop.git
   4. git clone https://github.com/smalruby/smalruby3-gui.git
2. cd smalruby3-gui
   1. git checkout smalruby3-desktop
   2. rm -rf node_modules/scratch-vm
   3. npm install
   4. (cd node_modules/scratch-vm && npm --production=false install && $(npm bin)/webpack --colors --bail --silent)
   5. npm link
   6. cd ..
3. cd smalruby3-desktop
   1. npm install
   2. npm link smalruby3-gui
   3. npm run build-gui or npm run watch-gui

Your copy of smalruby3-gui should now be ready for use with Smalruby3 Desktop.

Prepare media library assets

In the smalruby3-desktop directory, run npm run fetch. Re-run this any time you update smalruby3-gui or make any other changes which might affect the media libraries.

Run in development mode

npm start

Make a packaged build

npm run dist

Node that on macOS this will require installing various certificates.

Signing the NSIS installer (Windows, non-store)

By default all Windows installers are unsigned. An APPX package for the Microsoft Store shouldn't be signed: it will be signed automatically as part of the store submission process. On the other hand, the non-Store NSIS installer should be signed.

To generate a signed NSIS installer:

1. Acquire our latest digital signing certificate and save it on your computer as a p12 file.
2. Set WIN_CSC_LINK to the path to your certificate file. For maximum compatibility I use forward slashes.
   • CMD: set WIN_CSC_LINK=C:/Users/You/Somewhere/Certificate.p12
   • PowerShell: $env:WIN_CSC_LINK = "C:/Users/You/Somewhere/Certificate.p12"
3. Set WIN_CSC_KEY_PASSWORD to the password string associated with your P12 file.
   • CMD: set WIN_CSC_KEY_PASSWORD=superSecret
   • PowerShell: $env:WIN_CSC_KEY_PASSWORD = "superSecret"
4. Build the NSIS installer only: building the APPX installer will fail if these environment variables are set.
   • npm run dist -- -w nsis

Workaround for code signing issue in macOS

Sometimes the macOS build process will result in a build which crashes on startup. If this happens, check in Console for an entry similar to this:

failed to parse entitlements for Smalruby3 Desktop[12345]: OSUnserializeXML: syntax error near line 1

This appears to be an issue with codesign itself. Rebooting your computer and trying to build again might help. Yes, really.

See this issue for more detail: electron/osx-sign#218

Make a semi-packaged build

This will simulate a packaged build without actually packaging it: instead the files will be copied to a subdirectory of dist.

npm run dist:dir

Debugging

You can debug the renderer process by opening the Chromium development console. This should be the same keyboard shortcut as Chrome on your platform. This won't work on a packaged build.

You can debug the main process the same way as any Node.js process. I like to use Visual Studio Code with a configuration like this:

    "launch": {
        "version": "0.2.0",
        "configurations": [
            {
                "name": "Desktop",
                "type": "node",
                "request": "launch",
                "cwd": "${workspaceFolder:smalruby3-desktop}",
                "runtimeExecutable": "npm",
                "autoAttachChildProcesses": true,
                "runtimeArgs": ["start", "--"],
                "protocol": "inspector",
                "skipFiles": [
                    // it seems like skipFiles only reliably works with 1 entry :(
                    //"<node_internals>/**",
                    "${workspaceFolder:smalruby3-desktop}/node_modules/electron/dist/resources/*.asar/**"
                ],
                "sourceMaps": true,
                "timeout": 30000,
                "outputCapture": "std"
            }
        ]
    },