Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
# Scratch Everywhere! Website

This is the official **website** for Scratch Everywhere!.
This is the official **website** for Scratch Everywhere!, containing the
documentation.

If you're looking for Scratch Everywhere! itself, this is the wrong repository.
Use <https://github.com/ScratchEverywhere/ScratchEverywhere> instead.

## Contributions

All Markdown files are formatted with `deno fmt`. You should probably set up
formatting on save for convenience.

## Building

To build the site, use `bun`:
Expand All @@ -20,3 +16,13 @@ bun run docs:build

You can also use `bun run docs:dev` to run a local copy of the site for
previewing changes.

## Contributions

If you would like to contribute to Scratch Everywhere!, see our
[contributing guide](https://github.com/ScratchEverywhere/ScratchEverywhere/blob/main/CONTRIBUTING.md).

## Disclaimer

This project is not affiliated with Scratch, the Scratch Team, or any of the
supported platforms' parent companies or organizations.
139 changes: 75 additions & 64 deletions build.md

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions controls.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@

## Mouse

**3DS:** Glide your finger/stylus on the bottom screen to move the mouse, and
tap the bottom screen to click.

**Wii U GamePad:** Use the touchscreen on the GamePad.
**DS(i)/3DS:** Glide your finger/stylus on the bottom screen to move the mouse,
and tap the bottom screen to click.

**Wii Remote:** Use the Wii sensor bar to control the mouse.

**PS Vita:** Use the front touchscreen.
**Wii U GamePad:** Use the touchscreen on the GamePad.

**Handheld Switch:** Use the touchscreen.

**PS Vita:** Use the front touchscreen.

**Other Controllers:** Enter Mouse Mode by holding L. Use the D-pad to move the
mouse, and press R to click.
9 changes: 5 additions & 4 deletions docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,17 +212,18 @@ After a successful build, your exported files will appear directly in the

| Platform | File Types |
| ----------------- | --------------------------------------------- |
| **GameCube/Wii** | `.dol` |
| **DS(i)** | `.nds` |
| **3DS** | `.3dsx` and `.cia` |
| **Wii U** | `.rpx` and `.wuhb` |
| **Vita** | `.vpk` |
| **PS4** | `.pkg` |
| **Switch** | `.nro` |
| **PSP** | `.zip` |
| **DS** | `.nds` |
| **GameCube/Wii** | `.dol` |
| **Vita** | `.vpk` |
| **PS4** | `.pkg` |
| **webOS** | `.ipk` |
| **Original Xbox** | `.iso` and `.xbe` |
| **PC** | `scratch-*` (Unix/macOS) <br>`.exe` (Windows) |
| **Libretro** | `scratch-pc.so` |

You can now copy these files to your console and install or launch them like any
other homebrew app!
Expand Down
2 changes: 1 addition & 1 deletion extensions/format.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ support all platforms.
- 5th bit: Switch
- 6th bit: PC
- 7th bit: Vita
- 8th bit: NDS
- 8th bit: DS(i)
- 9th bit: PS4
- 10th bit: PSP
- 11th bit: webOS
Expand Down
12 changes: 6 additions & 6 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,18 @@ features:
<img src="https://github.com/ScratchEverywhere/ScratchEverywhere/raw/main/docs/demo.gif" style="border-radius: 12px; margin-top: 2rem;" />

<p align="center">
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-gamecube.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-gamecube.yml/badge.svg" alt="GameCube Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-nds.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-nds.yml/badge.svg" alt="DS(i) Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-wii.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-wii.yml/badge.svg" alt="Wii Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-3ds.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-3ds.yml/badge.svg" alt="3DS Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-nds.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-nds.yml/badge.svg" alt="NDS Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-wiiu.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-wiiu.yml/badge.svg" alt="Wii U Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-wii.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-wii.yml/badge.svg" alt="Wii Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-gamecube.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-gamecube.yml/badge.svg" alt="GameCube Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-switch.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-switch.yml/badge.svg" alt="Switch Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-vita.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-vita.yml/badge.svg" alt="Vita Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-psp.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-psp.yml/badge.svg" alt="PSP Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-vita.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-vita.yml/badge.svg" alt="Vita Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-ps4.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-ps4.yml/badge.svg" alt="PS4 Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-pc.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-pc.yml/badge.svg" alt="PC Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-webos.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-webos.yml/badge.svg" alt="webOS Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-libretro.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-libretro.yml/badge.svg" alt="Libretro Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-xbox.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-xbox.yml/badge.svg" alt="Original Xbox Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-pc.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-pc.yml/badge.svg" alt="PC Nightly Build"></a>
<a href="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-libretro.yml"><img src="https://github.com/ScratchEverywhere/ScratchEverywhere/actions/workflows/nightly-libretro.yml/badge.svg" alt="Libretro Nightly Build"></a>
<a href="https://discord.gg/Y2gf5vZHpJ"><img alt="Discord" src="https://img.shields.io/discord/1408875318248345612?style=flat&logo=discord&label=Discord%20Server&link=https%3A%2F%2Fdiscord.gg%2FY2gf5vZHpJ"></a>
</p>
193 changes: 99 additions & 94 deletions install.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,38 +15,47 @@ There are two methods to install the runtime:
> more unstable than releases. You should only use them if you are instructed
> to do so in a bug report or you know exactly what using nightlies implies.

## PC (Windows, Mac, Linux)
## GameCube

Download the respective executable file for your operating system from the
Download the `scratch-gamecube.zip` file in the
[Releases tab](https://github.com/ScratchEverywhere/ScratchEverywhere/releases)
or
[nightly build](https://nightly.link/ScratchEverywhere/ScratchEverywhere/workflows/nightly-pc/main):
[nightly build](https://nightly.link/ScratchEverywhere/ScratchEverywhere/workflows/nightly-gamecube/main/Scratch%20Everywhere!%20GameCube%20Nightly.zip).

- Windows: `scratch-windows.exe`
- Mac: `scratch-macOS`
- Linux: `scratch-linux`
Unzip the file. Put your Scratch projects in the same place you put your `.dol`
file.

> [!NOTE]
> If you're using Arch Linux or a distribution based on it, Scratch Everywhere!
> is also available on the
> [AUR](https://aur.archlinux.org/packages/scratch-everywhere) (There are
> [`-git`](https://aur.archlinux.org/packages/scratch-everywhere-git) and
> [`-bin`](https://aur.archlinux.org/packages/scratch-everywhere-bin) packages
> available as well), so you can just install it from there and keep it updated
> that way!
Then it should be as simple as opening the app on your GameCube!

Place the executable file in a convenient location on your PC.
## DS(i)

The location of Scratch projects depends on where (or how) you installed Scratch
Everywhere!.
Download the `.nds` file in the
[Releases tab](https://github.com/ScratchEverywhere/ScratchEverywhere/releases)
or
[nightly build](https://nightly.link/ScratchEverywhere/ScratchEverywhere/workflows/nightly-nds/main/Scratch%20Everywhere!%20DS%20Nightly.zip).

- **Windows:** `C:\Users\{username}\Documents\scratch-everywhere`
- **macOS:** Next to the executable
- **Linux/BSD (installed to `$PATH`):**
`/home/{username}/.local/share/scratch-everywhere`
- **Linux/BSD (not installed to `$PATH`):** Next to the executable
Place the `.nds` file in your SD card, and put Scratch projects in
`sd:/scratch-ds/`.

Then it should be as simple as running the executable file!
Then it should be as simple as running the app!

## Wii

Download the `scratch-wii.zip` file in the
[Releases tab](https://github.com/ScratchEverywhere/ScratchEverywhere/releases)
or
[nightly build](https://nightly.link/ScratchEverywhere/ScratchEverywhere/workflows/nightly-wii/main/Scratch%20Everywhere!%20Wii%20Nightly.zip).

> [!NOTE]
> Scratch Everywhere! is also on the
> [Open Shop Channel](https://oscwii.org/library/app/scratch-wii), so you can
> just download it there and keep it updated that way!

Unzip the file and put the `apps` folder inside of the root of your SD card.

Place the Scratch projects you want in `sdcard:/apps/scratch-wii/`

Then it should be as simple as opening the app in the Homebrew Menu on your Wii!

## 3DS

Expand Down Expand Up @@ -92,18 +101,6 @@ UniStores, find and select "ScratchBox".
You can now switch between ScratchBox and the default Universal-DB UniStore
using this menu!

## NDS

Download the `.nds` file in the
[Releases tab](https://github.com/ScratchEverywhere/ScratchEverywhere/releases)
or
[nightly build](https://nightly.link/ScratchEverywhere/ScratchEverywhere/workflows/nightly-nds/main/Scratch%20Everywhere!%20DS%20Nightly.zip).

Place the `.nds` file in your SD card, and put Scratch projects in
`sd:/scratch-ds/`.

Then it should be as simple as running the app!

## Wii U

Download the `scratch-wiiu.zip` file in the
Expand All @@ -123,36 +120,6 @@ Place the Scratch projects you want in `sdcard:/wiiu/scratch-wiiu/`.
Then it should be as simple as opening the app on the Wii U Menu or in the
Homebrew Launcher on your Wii U!

## Wii

Download the `scratch-wii.zip` file in the
[Releases tab](https://github.com/ScratchEverywhere/ScratchEverywhere/releases)
or
[nightly build](https://nightly.link/ScratchEverywhere/ScratchEverywhere/workflows/nightly-wii/main/Scratch%20Everywhere!%20Wii%20Nightly.zip).

> [!NOTE]
> Scratch Everywhere! is also on the
> [Open Shop Channel](https://oscwii.org/library/app/scratch-wii), so you can
> just download it there and keep it updated that way!

Unzip the file and put the `apps` folder inside of the root of your SD card.

Place the Scratch projects you want in `sdcard:/apps/scratch-wii/`

Then it should be as simple as opening the app in the Homebrew Menu on your Wii!

## GameCube

Download the `scratch-gamecube.zip` file in the
[Releases tab](https://github.com/ScratchEverywhere/ScratchEverywhere/releases)
or
[nightly build](https://nightly.link/ScratchEverywhere/ScratchEverywhere/workflows/nightly-gamecube/main/Scratch%20Everywhere!%20GameCube%20Nightly.zip).

Unzip the file. Put your Scratch projects in the same place you put your `.dol`
file.

Then it should be as simple as opening the app on your GameCube!

## Nintendo Switch

Download the `scratch-nx.nro` file in the
Expand All @@ -169,6 +136,19 @@ Put your Scratch projects in the same place you put your `.nro` file.

Then it should be as simple as opening the app on your Nintendo Switch!

## PSP

Download the `scratch-psp.zip` file from the
[Releases tab](https://github.com/ScratchEverywhere/ScratchEverywhere/releases)
or
[nightly build](https://nightly.link/ScratchEverywhere/ScratchEverywhere/workflows/nightly-psp/main/Scratch%20Everywhere!%20PSP%20Nightly.zip),
and put it in your PSP's memory card in `PSP/GAME`.

Put your Scratch Projects in `PSP/GAME/scratch-psp/scratch-everywhere/` (you
will need to create the folder yourself).

Then it should be as simple as opening the app on your PSP!

## Vita

> [!NOTE]
Expand All @@ -190,19 +170,6 @@ the folder yourself).
Then it should be as simple as opening and starting the app from your Vita's
LiveArea homescreen!

## PSP

Download the `scratch-psp.zip` file from the
[Releases tab](https://github.com/ScratchEverywhere/ScratchEverywhere/releases)
or
[nightly build](https://nightly.link/ScratchEverywhere/ScratchEverywhere/workflows/nightly-psp/main/Scratch%20Everywhere!%20PSP%20Nightly.zip),
and put it in your PSP's memory card in `PSP/GAME`.

Put your Scratch Projects in `PSP/GAME/scratch-psp/scratch-everywhere/` (you
will need to create the folder yourself).

Then it should be as simple as opening the app on your PSP!

## PS4

> [!NOTE]
Expand Down Expand Up @@ -237,22 +204,6 @@ folder doesn't exist, create it.

Then it should be as simple as opening the app on your TV from the home menu!

## Libretro (RetroArch)

Download the `scratch-everywhere.so` file from the
[Releases tab](https://github.com/ScratchEverywhere/ScratchEverywhere/releases)
or
[nightly build](https://nightly.link/ScratchEverywhere/ScratchEverywhere/workflows/nightly-ps4/main/Scratch%20Everywhere!%20Libretro%20Nightly.zip).

Place it in the RetroArch cores directory, which you can find in Settings ->
Directory -> Cores.

> [!IMPORTANT]
> In Settings -> Drivers -> Video, ensure your video driver is not set to `gl`.
> The `gl` driver is currently broken with the SE! core.

Then it should be as simple as loading the core and opening a Scratch project!

## Original Xbox

Download the `scratch-xbox.zip` file from the
Expand All @@ -278,3 +229,57 @@ This file is used with real modded Xboxes. Copy it wherever you'd like, and
place Scratch projects in `E:\ScratchEverywhere`.

Then it should be as simple as running `default.xbe`!

## PC (Windows, Mac, Linux)

Download the respective executable file for your operating system from the
[Releases tab](https://github.com/ScratchEverywhere/ScratchEverywhere/releases)
or
[nightly build](https://nightly.link/ScratchEverywhere/ScratchEverywhere/workflows/nightly-pc/main):

- Windows: `scratch-windows.exe`
- Mac: `scratch-macOS`
- Linux: `scratch-linux`

> [!NOTE]
> If you're using Arch Linux or a distribution based on it, Scratch Everywhere!
> is also available on the
> [AUR](https://aur.archlinux.org/packages/scratch-everywhere) (There are
> [`-git`](https://aur.archlinux.org/packages/scratch-everywhere-git) and
> [`-bin`](https://aur.archlinux.org/packages/scratch-everywhere-bin) packages
> available as well), so you can just install it from there and keep it updated
> that way!

Place the executable file in a convenient location on your PC.

The location of Scratch projects depends on where (or how) you installed Scratch
Everywhere!.

- **Windows:** `C:\Users\{username}\Documents\scratch-everywhere`
- **macOS:** Next to the executable
- **Linux/BSD (installed to `$PATH`):**
`/home/{username}/.local/share/scratch-everywhere`
- **Linux/BSD (not installed to `$PATH`):** Next to the executable

Then it should be as simple as running the executable file!

## Libretro (RetroArch)

Download the `scratch-everywhere.so` file from the
[Releases tab](https://github.com/ScratchEverywhere/ScratchEverywhere/releases)
or
[nightly build](https://nightly.link/ScratchEverywhere/ScratchEverywhere/workflows/nightly-ps4/main/Scratch%20Everywhere!%20Libretro%20Nightly.zip).

Place it in the RetroArch cores directory, which you can find in Settings ->
Directory -> Cores.

> [!IMPORTANT]
> In Settings -> Drivers -> Video, ensure your video driver is not set to `gl`.
> The `gl` driver is currently broken with the SE! core.

Then it should be as simple as loading the core and opening a Scratch project!

## WebAssembly

It's as simple as going to
<https://scratcheverywhere.github.io/ScratchEverywhere>!
6 changes: 3 additions & 3 deletions intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Scratch Everywhere! **(note the exclamation mark)** is a cross-platform
implementation of the Scratch runtime. In simpler words, it's a way to run
Scratch projects on old homebrew consoles.

The project supports 3DS, DS, DSi, Wii U, Wii, GameCube, Switch, Vita, PSP, PS4,
webOS (for LG TVs), Libretro (RetroArch), Original Xbox, Windows, Linux, and
macOS!
The project supports GameCube, DS, Wii, DSi, 3DS, Wii U, Switch, PSP, Vita, PS4,
webOS (for LG TVs), Original Xbox, Windows, macOS, Linux/BSD, Libretro
(RetroArch), and WebAssembly (for browsers)!
Loading
Loading