Virtual Machine used to represent, run, and maintain the state of programs for Scratch 3.0
Find a file
semantic-release-bot 020d2c369e chore(release): 4.5.18 [skip ci]
## [4.5.18](https://github.com/scratchfoundation/scratch-vm/compare/v4.5.17...v4.5.18) (2024-03-24)

### Bug Fixes

* **deps:** update dependency scratch-blocks to v1.1.62 ([1331f57](1331f572ce))
2024-03-24 12:22:12 +00:00
.github chore(deps): pin dependencies 2024-02-16 00:16:45 +00:00
.husky build(husky): fix permissions on husky commit-msg hook 2022-08-23 07:11:04 -07:00
.tx Update tx/config for Scratch 3.0 2018-05-11 08:20:20 -04:00
docs fix: update GitHub links with /scratchfoundation/ 2023-09-28 09:16:47 -07:00
src fix: export ArgumentType and BlockType 2024-03-13 13:21:16 -07:00
test fix: use web-worker to replace tiny-worker and worker-loader 2024-03-04 11:10:29 -08:00
.editorconfig ci: add GH Pages deploy and the i18n cron job 2022-06-07 14:55:24 -07:00
.eslintignore Add benchmark to ignore files 2017-11-20 19:18:18 -05:00
.eslintrc.js Use ES6 linting rules in the project root 2017-04-24 15:37:58 -04:00
.gitattributes use scratch-renovate-config:conservative 2021-07-26 16:28:07 -07:00
.gitignore Remove cache from Travis, begin using npm ci 2018-06-28 10:52:04 -04:00
.jsdoc.json Add jsdoc to package json and test/build tasks 2018-07-31 11:22:42 -04:00
.npmignore Remove webpack config from npm ignore. Custom branches that depend directly on the repo need this to work. 2018-07-10 16:41:43 -04:00
.nvmrc chore(deps): update dependency node to v18 2024-02-27 23:59:22 +00:00
CHANGELOG.md chore(release): 4.5.18 [skip ci] 2024-03-24 12:22:12 +00:00
commitlint.config.js build: tell commitlint to ignore release commits instead of disabling Husky during semantic-release 2022-08-26 10:16:25 -07:00
LICENSE Initial commit 2016-03-28 12:53:44 -04:00
package-lock.json chore(release): 4.5.18 [skip ci] 2024-03-24 12:22:12 +00:00
package.json chore(release): 4.5.18 [skip ci] 2024-03-24 12:22:12 +00:00
README.md fix: update GitHub links with /scratchfoundation/ 2023-09-28 09:16:47 -07:00
release.config.js ci: add GH Pages deploy and the i18n cron job 2022-06-07 14:55:24 -07:00
renovate.json5 chore(deps): use js-lib-bundled Renovate config 2024-02-21 09:31:19 -08:00
TRADEMARK Update TRADEMARK 2018-06-18 13:13:09 -04:00
webpack.config.js fix(build): simplify webpack config using clone() 2024-03-08 20:10:00 -08:00

scratch-vm

Scratch VM is a library for representing, running, and maintaining the state of computer programs written using Scratch Blocks.

CI/CD

Installation

This requires you to have Git and Node.js installed.

To install as a dependency for your own application:

npm install scratch-vm

To set up a development environment to edit scratch-vm yourself:

git clone https://github.com/scratchfoundation/scratch-vm.git
cd scratch-vm
npm install

Development Server

This requires Node.js to be installed.

For convenience, we've included a development server with the VM. This is sometimes useful when running in an environment that's loading remote resources (e.g., SVGs from the Scratch server). If you would like to use your modified VM with the full Scratch 3.0 GUI, follow the instructions to link the VM to the GUI.

Running the Development Server

Open a Command Prompt or Terminal in the repository and run:

npm start

Playground

To view the Playground, make sure the dev server's running and go to http://localhost:8073/playground/ - you will be directed to the playground, which demonstrates various tools and internal state.

VM Playground Screenshot

Standalone Build

npm run build
<script src="/path/to/dist/web/scratch-vm.js"></script>
<script>
    var vm = new window.VirtualMachine();
    // do things
</script>

How to include in a Node.js App

For an extended setup example, check out the /src/playground directory, which includes a fully running VM instance.

var VirtualMachine = require('scratch-vm');
var vm = new VirtualMachine();

// Block events
Scratch.workspace.addChangeListener(vm.blockListener);

// Run threads
vm.start();

Abstract Syntax Tree

Overview

The Virtual Machine constructs and maintains the state of an Abstract Syntax Tree (AST) by listening to events emitted by the scratch-blocks workspace via the blockListener. Each target (code-running object, for example, a sprite) keeps an AST for its blocks. At any time, the current state of an AST can be viewed by inspecting the vm.runtime.targets[...].blocks object.

Anatomy of a Block

The VM's block representation contains all the important information for execution and storage. Here's an example representing the "when key pressed" script on a workspace:

{
  "_blocks": {
    "Q]PK~yJ@BTV8Y~FfISeo": {
      "id": "Q]PK~yJ@BTV8Y~FfISeo",
      "opcode": "event_whenkeypressed",
      "inputs": {
      },
      "fields": {
        "KEY_OPTION": {
          "name": "KEY_OPTION",
          "value": "space"
        }
      },
      "next": null,
      "topLevel": true,
      "parent": null,
      "shadow": false,
      "x": -69.333333333333,
      "y": 174
    }
  },
  "_scripts": [
    "Q]PK~yJ@BTV8Y~FfISeo"
  ]
}

Testing

npm test
npm run coverage

Publishing to GitHub Pages

npm run deploy

This will push the currently built playground to the gh-pages branch of the currently tracked remote. If you would like to change where to push to, add a repo url argument:

npm run deploy -- -r <your repo url>

Donate

We provide Scratch free of charge, and want to keep it that way! Please consider making a donation to support our continued engineering, design, community, and resource development efforts. Donations of any size are appreciated. Thank you!