mirror of
https://github.com/scratchfoundation/scratch-vm.git
synced 2024-12-22 22:12:28 -05:00
84 lines
1.5 KiB
Markdown
84 lines
1.5 KiB
Markdown
## scratch-vm
|
|
|
|
[](https://travis-ci.com/LLK/scratch-vm)
|
|
|
|
## Installation
|
|
```bash
|
|
npm install scratch-vm
|
|
```
|
|
|
|
## Setup
|
|
```js
|
|
var VirtualMachine = require('scratch-vm');
|
|
var vm = new VirtualMachine();
|
|
|
|
// Block events
|
|
|
|
// UI events
|
|
|
|
// Listen for events
|
|
```
|
|
|
|
## Standalone Build
|
|
```bash
|
|
make build
|
|
```
|
|
|
|
```html
|
|
<script src="/path/to/vm.js"></script>
|
|
<script>
|
|
var vm = new window.VirtualMachine();
|
|
// do things
|
|
</script>
|
|
```
|
|
|
|
## Abstract Syntax Tree
|
|
|
|
#### Overview
|
|
|
|
#### Anatomy of a Block
|
|
```json
|
|
{
|
|
"id": "^1r~63Gdl7;Dh?I*OP3_",
|
|
"opcode": "wedo_motorclockwise",
|
|
"next": null,
|
|
"fields": {
|
|
"DURATION": {
|
|
"name": "DURATION",
|
|
"value": null,
|
|
"blocks": {
|
|
"1?P=eV(OiDY3vMk!24Ip": {
|
|
"id": "1?P=eV(OiDY3vMk!24Ip",
|
|
"opcode": "math_number",
|
|
"next": null,
|
|
"fields": {
|
|
"NUM": {
|
|
"name": "NUM",
|
|
"value": "10",
|
|
"blocks": null
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"SUBSTACK": {
|
|
"name": "SUBSTACK",
|
|
"value": "@1ln(HsUO4!]*2*%BrE|",
|
|
"blocks": null
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Testing
|
|
```bash
|
|
make test
|
|
```
|
|
|
|
```bash
|
|
make coverage
|
|
```
|
|
|
|
```bash
|
|
make benchmark
|
|
```
|