Skip to content

feat(readme): add build instructions #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Starlii10 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(readme): add build instructions #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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!!