mirror of
https://github.com/scratchfoundation/scratch-vm.git
synced 2024-12-23 06:23:37 -05:00
Virtual Machine used to represent, run, and maintain the state of programs for Scratch 3.0
660029010d
Not sure exactly how to use these yet, but it seems helpful to have them in there. |
||
---|---|---|
playground | ||
src | ||
test | ||
.editorconfig | ||
.eslintrc | ||
.gitignore | ||
.travis.yml | ||
LICENSE | ||
Makefile | ||
package.json | ||
README.md | ||
TRADEMARK | ||
vm.js | ||
vm.min.js | ||
webpack.config.js |
scratch-vm
Scratch VM is a library for representing, running, and maintaining the state of computer programs written using Scratch Blocks.
Installation
npm install scratch-vm
Setup
var VirtualMachine = require('scratch-vm');
var vm = new VirtualMachine();
// Block events
workspace.addChangeListener(vm.blockListener);
var flyoutWorkspace = workspace.toolbox_.flyout_.workspace_;
flyoutWorkspace.addChangeListener(vm.flyoutBlockListener);
// Run threads
vm.runtime.start();
Standalone Build
make build
<script src="/path/to/vm.js"></script>
<script>
var vm = new window.VirtualMachine();
// do things
</script>
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
. At any time, the current state of the AST can be viewed by inspecting the vm.runtime.blocks
object.
Anatomy of a Block
{
"7AJZR#NA;m*b}R]pdq63": {
"id": "7AJZR#NA;m*b}R]pdq63",
"opcode": "control_wait",
"inputs": {
"DURATION": {
"name": "DURATION",
"block": ",xA8/S!Z6+kR,9dph.rO"
}
},
"fields": {},
"next": null,
"topLevel": true
},
",xA8/S!Z6+kR,9dph.rO": {
"id": ",xA8/S!Z6+kR,9dph.rO",
"opcode": "math_number",
"inputs": {},
"fields": {
"NUM": {
"name": "NUM",
"value": "1"
}
},
"next": null,
"topLevel": false
}
}
Testing
make test
make coverage
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!