From 957e23884b0d8b356ecdf2530d4c824f52b102da Mon Sep 17 00:00:00 2001 From: Starlii10 Date: Sun, 28 Jun 2026 00:04:47 -0400 Subject: [PATCH 1/2] feat(readme): add build instructions --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 16adc42..4629924 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,27 @@ -# Scratch Everywhere! Extensions +# Scratch Everywhere! Lua Extensions -A collection of extensions for Scratch Everywhere! including ports of TurboWarp -extensions. +A collection of Lua extensions for Scratch Everywhere!, including ports of +TurboWarp extensions. > [!WARNING] > Custom extensions in Scratch Everywhere! are still in development. + +# Building + +To build a Lua extension, use +[`seec`](https://github.com/ScratchEverywhere/seec): + +```bash +seec -i /path/to/main.lua -m /path/to/meta.json -o /path/to/output.see +``` + +Alternatively, simply run `seec` in the directory with `main.lua` and +`meta.json`: + +```bash +cd /path/to/extension +seec +``` + +Then it should be as simple as copying the `.see` file to +`scratch-everywhere/extensions` and running Scratch Everywhere!! From 907b83c3538c06acf4b820fe340eb101a9495fb2 Mon Sep 17 00:00:00 2001 From: Starlii10 Date: Mon, 20 Jul 2026 16:59:24 -0400 Subject: [PATCH 2/2] fix(readme): update build instructions --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 4629924..683758b 100644 --- a/README.md +++ b/README.md @@ -8,20 +8,21 @@ TurboWarp extensions. # Building -To build a Lua extension, use -[`seec`](https://github.com/ScratchEverywhere/seec): +To build the Lua extensions, use `bun`: -```bash -seec -i /path/to/main.lua -m /path/to/meta.json -o /path/to/output.see +```sh +bun build.ts ``` -Alternatively, simply run `seec` in the directory with `main.lua` and -`meta.json`: +The compiled extensions can be found in the `bin` folder. -```bash -cd /path/to/extension -seec -``` - -Then it should be as simple as copying the `.see` file to +Then it should be as simple as copying the `.see` files to `scratch-everywhere/extensions` and running Scratch Everywhere!! + +# Using in an Editor + +`bun` will also build JavaScript versions of the extensions. These are intended +for use in a Scratch editor that supports loading custom extensions. + +> [!NOTE] +> These extensions will likely not work correctly in the editor.