scratchfoundation/scratch-desktop
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratch-desktop.git synced 2024-12-22 13:42:27 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
Scratch 3.0 as a self-contained desktop application
321 commits 64 branches 63 tags 22 MiB
JavaScript 93.5%
CSS 2.5%
Shell 2.2%
Ruby 1.2%
HTML 0.6%
Find a file
Christopher Willis-Ford 19a47ecde8 split HOC in two: one inside AppStateHOC, one out 
`ScratchDesktopOuterComponent` is now responsible for
`showTelemetryModal` which only works if it comes from outside the
`AppStateHOC` since it's used in the `AppStateHOC` constructor. The
outer component also handles a few static props, like
`isScratchDesktop`.

`ScratchDesktopInnerComponent` handles everything else, most notably
anything that interacts with the state established by `AppStateHOC`.
2020-11-17 15:55:43 -08:00
.circleci add comments based on code review feedback 2020-08-03 13:18:40 -07:00
.github Update CONTRIBUTING.md 2020-06-09 17:04:00 -04:00
buildResources add entitlements suggested by Electron 2020-05-13 17:15:07 -07:00
scripts fix fetch script for new library schema 2020-10-28 15:47:58 -07:00
src split HOC in two: one inside AppStateHOC, one out 2020-11-17 15:55:43 -08:00
.editorconfig Use eslint-config-scratch 2018-09-27 14:28:23 -07:00
.eslintignore Use eslint-config-scratch 2018-09-27 14:28:23 -07:00
.eslintrc.js Add media library assets, fetch script 2018-10-19 15:19:41 -07:00
.gitattributes Fix line endings for electron-webpack.json5 2019-07-11 16:16:17 -07:00
.gitignore add settings for mas-dev build 2020-05-22 15:19:28 -07:00
.npmignore Initial commit 2018-09-06 11:20:27 -07:00
electron-builder.yaml use 'Scratch 3' for external product name 2020-09-21 10:46:55 -07:00
electron-webpack.json5 assume direct control of webpack config 2020-08-11 17:17:15 -07:00
LICENSE Update LICENSE 2019-03-06 12:59:20 -05:00
package-lock.json 3.18.1 2020-10-28 15:54:01 -07:00
package.json 3.18.1 2020-10-28 15:54:01 -07:00
README.md Merge branch 'develop' into redo-rename 2020-09-21 10:46:47 -07:00
TRADEMARK Update TRADEMARK 2019-03-06 12:59:41 -05:00
webpack.main.js assume direct control of webpack config 2020-08-11 17:17:15 -07:00
webpack.makeConfig.js reduce webpack output on CI 2020-08-14 13:48:05 -07:00
webpack.renderer.js during webpack, find modules using require.resolve 2020-09-30 09:32:54 -07:00

README.md

scratch-desktop

Scratch 3.0 as a standalone desktop application

Developer Instructions

A note about scratch-gui

Eventually, the scratch-desktop branch of the Scratch GUI repository will be merged with that repository's main development line. For now, though, the scratch-desktop branch holds a few changes that are necessary for the Scratch app to function correctly but are not yet merged into the main development branch. If you only intend to build or work on the scratch-desktop repository then you can ignore this, but if you intend to work on scratch-gui as well, make sure you use the scratch-desktop branch there.

Previously it was necessary to explicitly build scratch-gui before building scratch-desktop. This is no longer necessary and the related build scripts, such as build-gui, have been removed.

Prepare media library assets

In the scratch-desktop directory, run npm run fetch. Re-run this any time you update scratch-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)

This section is relevant only to members of the Scratch Team.

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 Scratch[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: https://github.com/electron/electron-osx-sign/issues/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:scratch-desktop}",
                "runtimeExecutable": "npm",
                "autoAttachChildProcesses": true,
                "runtimeArgs": ["start", "--"],
                "protocol": "inspector",
                "skipFiles": [
                    // it seems like skipFiles only reliably works with 1 entry :(
                    //"<node_internals>/**",
                    "${workspaceFolder:scratch-desktop}/node_modules/electron/dist/resources/*.asar/**"
                ],
                "sourceMaps": true,
                "timeout": 30000,
                "outputCapture": "std"
            }
        ]
    },