Make pictures of Scratch blocks from text.
This repository has been archived on 2025-05-04. You can view files and clone it, but you cannot make any changes to it's state, such as pushing and creating new issues, pull requests or comments.
Find a file
2014-04-07 23:55:08 +01:00
build Include palette in translation strings 2014-04-07 23:55:08 +01:00
src Include palette in translation strings 2014-04-07 23:55:08 +01:00
tests Fix one test 2014-01-15 12:56:46 +00:00
.gitignore Update .gitignore 2014-01-12 13:58:47 +00:00
example.html Cleanup test.html; add example usage HTML file 2013-06-13 23:21:32 +01:00
LICENSE MIT License 2013-02-22 21:45:05 +00:00
README.md Fix URL in Readme.md 2014-01-01 11:59:16 +00:00

Render Scratch blocks code to HTML.

Screenshot

Test it here!


scratchblocks2 is used to write Scratch scripts on the Scratch Forums and Scratch Wiki.

Syntax

It's inspired by the block plugin by JSO that was used on the old Scratch Forums. It's a complete rewrite for Scratch 2.0, but it still uses the same syntax (with some minor additions).

It follows the philosophy of the original Block Plugin in that it tries to match the code you write as closely as possible, and doesn't check you've used the correct syntax. The block text is only used to find the correct colour.

It also includes a few hacks, such as recognising list reporters -- just make sure you refer to the list explicitly somewhere:

add [something] to [list v]
say (list)

For the full guide to the syntax, see the wiki.

Usage

If you just want the code, have a look at the example HTML file, which uses the scripts hosted on GitHub Pages, and jQuery hosted off Google.

For a more detailed explanation, or if you want to host the files yourself, read on.

You need to include jQuery (in the <head> of your page):

<script src="//ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.js"></script>

Then include the scratchblocks2 CSS and JS:

<link rel="stylesheet" href="scratchblocks2.css">
<script src="scratchblocks2.js"></script>

Then just call scratchblocks2.parse after the page has loaded, which will render matching page elements to shiny scratch blocks. Its sole argument is the CSS-style selector for the elements that contain the scratchblocks code. It uses pre.blocks by default.

scratchblocks2.parse("pre.blocks");

Finally, you need to put flag.png and arrows.png in the folder block_images, which must be in the same folder as scratchblocks2.css.

In summary, your directory layout should look something like this:

block_images/
    arrows.png
    flag.png
scratchblocks2.css
scratchblocks2.js

Inline blocks

To use blocks inside a paragraph...

I'm rather fond of the <code class="b">stamp</code> block in Scratch.

...make a separate call to parse using the inline argument.

scratchblocks2.parse("code.b", {inline: true});

Credits