diff --git a/README.md b/README.md index 66f35be..a8a8300 100644 --- a/README.md +++ b/README.md @@ -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 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`: @@ -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. diff --git a/build.md b/build.md index 9f7d19d..0dfcfee 100644 --- a/build.md +++ b/build.md @@ -34,14 +34,12 @@ Images for the various banners and icons can be found in `gfx/`. If you are compiling with cloud variables, you will need to have DevkitPro's SDKs and [Mist++](https://github.grady.link/mistpp) installed. -- **For PC**, the only thing you need is `cmake`, as all other dependencies will - be automatically downloaded. However, if you'd like to manually install them, - you'll need `SDL2`, `SDL2_ttf`, `SDL2_gfx`, `lunasvg`, `stb_image` (`stb`), - and `libcurl` (`curl`) from your package manager. - - > [!NOTE] - > On Arch Linux, `lunasvg` is not in the official package repos. You will need - > to use the AUR or let SE! automatically download and build it from source. +- **For the GameCube**, you need the DevkitPPC toolchain, libogc, and the + following SDL2-gamecube libraries: + - SDL2 + - sdl2_ttf +- **For DS(i)**, you'll need [BlocksDS](https://blocksds.skylyrac.net/) (which + uses the [Wonderful Toolchain](https://wonderful.asie.pl/)). - **For the 3DS**, you will need the DevkitARM toolchain, libctru, [bannertool](https://github.com/carstene1ns/3ds-bannertool), and [makerom](https://github.com/3DSGuy/Project_CTR). @@ -49,22 +47,20 @@ SDKs and [Mist++](https://github.grady.link/mistpp) installed. version of SDL3. See the [Nightly Build commands](https://github.com/ScratchEverywhere/ScratchEverywhere/blob/main/.github/workflows/nightly-3ds.yml) for a reference on how to compile SDL3 3DS for yourself. -- **For the Wii U**, you will need the DevkitPPC toolchain, WUT, and the - following SDL2-wiiu libraries: - - SDL2 - - sdl2_ttf - **For the Wii**, you need the DevkitPPC toolchain, libogc, and the following SDL2-wii libraries: - SDL2 - sdl2_ttf -- **For the GameCube**, you need the DevkitPPC toolchain, libogc, and the - following SDL2-gamecube libraries: +- **For the Wii U**, you will need the DevkitPPC toolchain, WUT, and the + following SDL2-wiiu libraries: - SDL2 - sdl2_ttf - **For the Switch**, you need the DevkitA64 toolchain, libnx, and the following SDL2-switch libraries: - SDL2 - sdl2_ttf +- **For the PSP**, all you need is the [PSPSDK](https://pspdev.github.io) + toolchain. It includes every SDL2 thing you might need. - **For the Vita**, all you need is the [vitasdk](https://vitasdk.org) toolchain. It includes every SDL2 thing you might need. - **For the PS4**, you'll need @@ -72,12 +68,19 @@ SDKs and [Mist++](https://github.grady.link/mistpp) installed. [OpenOrbis toolchain](https://github.com/OpenOrbis/OpenOrbis-PS4-Toolchain). For the latter, you only need the headers (`include/orbis/`) copied to `/opt/ps4-homebrew-sdk/target/include/orbis`. -- **For the PSP**, all you need is the [PSPSDK](https://pspdev.github.io) - toolchain. It includes every SDL2 thing you might need. - **For webOS**, all you need is the webosbrew Native SDK installed to your home directory and ares-cli. - **For Original Xbox**, you'll need [nxdk](https://github.com/xboxDev/nxdk) and [nxdk-sdl3_audio](https://github.com/Ryzee119/nxdk-sdl3/tree/nxaudio). +- **For PC and Libretro**, the only thing you need is `cmake`, as all other + dependencies will be automatically downloaded. However, if you'd like to + manually install them, you'll need `SDL2`, `SDL2_ttf`, `SDL2_gfx`, `lunasvg`, + `stb_image` (`stb`), and `libcurl` (`curl`) from your package manager. + + > [!NOTE] + > The version of `lunasvg` packaged in the AUR is outdated and has many + > issues. You will need to have SE! automatically download and build it from + > source. > [!NOTE] > DevkitPro's install instructions are available at: @@ -101,43 +104,45 @@ project inside of that. Then you need to compile the projects into proper Homebrew packages. This is done with `cmake`, though the exact commands differ between platforms: -- **For Windows**, you need to run - `cmake -B build-windows && cmake --build build-windows`. -- **For macOS**, you need to run - `cmake -B build-macOS && cmake --build build-macOS`. -- **For Linux**, you need to run - `cmake -B build-linux && cmake --build build-linux`. +- **For the GameCube**, you need to run + `$DEVKITPRO/libogc2/gamecube/bin/powerpc-eabi-cmake -B build-gamecube && cmake --build build-gamecube`. +- **For the DS(i)**, you need to run + `cmake -B build-nds -DCMAKE_TOOLCHAIN_FILE=$BLOCKSDS/cmake/BlocksDS.cmake && cmake --build build-nds`. +- **For the Wii**, you need to run + `$DEVKITPRO/portlibs/wii/bin/powerpc-eabi-cmake -B build-wii && cmake --build build-wii`. - **For the 3DS**, you need to run `$DEVKITPRO/portlibs/3ds/bin/arm-none-eabi-cmake -B build-3ds -DSE_MAKEROM=/path/to/makerom -DSE_BANNERTOOL=/path/to/bannertool && cmake --build build-3ds`. Replace `/path/to/makerom` and `/path/to/bannertool` with the actual paths to the executables. - **For the Wii U**, you need to run `$DEVKITPRO/portlibs/wiiu/bin/powerpc-eabi-cmake -B build-wiiu && cmake --build build-wiiu && cmake --build build-wiiu --target package_wiiu`. -- **For the Wii**, you need to run - `$DEVKITPRO/portlibs/wii/bin/powerpc-eabi-cmake -B build-wii && cmake --build build-wii`. -- **For the GameCube**, you need to run - `$DEVKITPRO/libogc2/gamecube/bin/powerpc-eabi-cmake -B build-gamecube && cmake --build build-gamecube`. - **For the Switch**, you need to run `cmake -DCMAKE_TOOLCHAIN_FILE=$DEVKITPRO/cmake/Switch.cmake -B build/switch && cmake --build build/switch`. +- **For the PSP**, you need to run + `psp-cmake -B build/psp -S . -DSE_SYSTEM=ON -DSE_CLOUDVARS=OFF && make -C build/psp`. - **For the Vita**, you need to run `cmake -DCMAKE_TOOLCHAIN_FILE=$VITASDK/share/vita.toolchain.cmake -B build/vita && cmake --build build/vita`. - **For the PS4**, you need to run `/opt/ps4-homebrew-sdk/bin/orbis-cmake -B build-ps4 && cmake --build build-ps4`. -- **For the PSP**, you need to run - `psp-cmake -B build/psp -S . -DSE_SYSTEM=ON -DSE_CLOUDVARS=OFF && make -C build/psp`. - **For webOS**, you need to run `cmake -B build/webos -S . -DCMAKE_TOOLCHAIN_FILE="~/arm-webos-linux-gnueabi_sdk-buildroot/share/buildroot/toolchainfile.cmake" -DSE_CLOUDVARS=OFF -DWEBOS=ON -DSE_RENDERER=sdl2 && make -C build/webos all package`. > [!NOTE] > webOS **requires** the `WEBOS=ON` flag. It will not compile without it. +- **For the Original Xbox**, you need to run + `cmake -B build/xbox -DCMAKE_TOOLCHAIN_FILE="$NXDK_DIR/share/toolchain-nxdk.cmake" -DXBOX=ON && cmake --build build/xbox`. + > [!NOTE] + > Original Xbox requires the `XBOX=ON` flag. +- **For Windows**, you need to run + `cmake -B build-windows && cmake --build build-windows`. +- **For macOS**, you need to run + `cmake -B build-macOS && cmake --build build-macOS`. +- **For Linux**, you need to run + `cmake -B build-linux && cmake --build build-linux`. - **For libretro**, you need to run `mkdir build && cd build && cmake .. -DLIBRETRO=ON && cmake --build .`. > [!NOTE] > Creating the `build` directory and using the `LIBRETRO=ON` flag is required > for libretro builds. -- **For the Original Xbox**, you need to run - `cmake -B build/xbox -DCMAKE_TOOLCHAIN_FILE="$NXDK_DIR/share/toolchain-nxdk.cmake" -DXBOX=ON && cmake --build build/xbox`. - > [!NOTE] - > Original Xbox requires the `XBOX=ON` flag. - **For WASM**, you need to run `emcmake cmake -B build/wasm && cmake --build build/wasm` @@ -195,21 +200,21 @@ The audio backend to be used. Can be one of `sdl2`, `sdl1`, `sdl3`, `libpulse`, | Platform | `sdl1` | `sdl2` | `sdl3` | `libpulse` | `winmm` | `nds` | `wiiu` | `xbox` | `libretro` | `headless` | | ------------- | ------ | ------ | ------ | ---------- | ------- | ----- | ------ | ------ | ---------- | ---------- | -| Windows | ✅ | ✅ | ✅ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ | -| macOS | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | -| Linux/BSD | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | +| GameCube | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | +| DS(i) | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ✅ | +| Wii | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | | 3DS | ❌ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | -| DS | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ✅ | | Wii U | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ✅ | -| Wii | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | -| GameCube | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | | Switch | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | -| Vita | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | | PSP | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | +| Vita | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | | PS4 | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | | webOS | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | -| Libretro | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | | Original Xbox | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ✅ | +| Windows | ✅ | ✅ | ✅ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ | +| macOS | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | +| Linux/BSD | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | +| Libretro | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | | WASM | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | Setting `SE_AUDIO_ENGINE` to `all` will include all supported audio engines in @@ -220,21 +225,21 @@ not have a preference, then the preference of the renderer will be used instead. #### Default by Platform -- **Windows:** `winmm` -- **macOS:** No preference -- **Linux/BSD:** `libpulse` +- **GameCube:** No preference +- **DS(i):** No preference +- **Wii:** No preference - **3DS:** `3ds` -- **DS:** No preference - **Wii U:** No preference -- **Wii:** No preference -- **GameCube:** No preference - **Switch:** No preference -- **Vita:** No preference - **PSP:** No preference +- **Vita:** No preference - **PS4:** No preference - **webOS:** No preference -- **Libretro:** `libretro` - **Original Xbox:** `xbox` +- **Windows:** `winmm` +- **macOS:** No preference +- **Linux/BSD:** `libpulse` +- **Libretro:** `libretro` - **WASM:** No preference #### Default by Renderer @@ -306,21 +311,21 @@ The allowed modes depend on the platform you are building for: | Platform | `source` | `system` | `fallback` | | ------------- | -------- | -------- | ---------- | -| Windows | ✅ | ✅ | ✅ | -| macOS | ✅ | ✅ | ✅ | -| Linux/BSD | ✅ | ✅ | ✅ | +| GameCube | ❌ | ✅ | ✅ | +| DS(i) | ❌ | ✅ | ✅ | +| Wii | ✅ | ✅ | ✅ | | 3DS | ❌ | ✅ | ✅ | -| DS | ❌ | ✅ | ✅ | | Wii U | ❌ | ✅ | ✅ | -| Wii | ✅ | ✅ | ✅ | -| GameCube | ❌ | ✅ | ✅ | | Switch | ❌ | ✅ | ✅ | -| Vita | ❌ | ✅ | ✅ | | PSP | ❌ | ✅ | ✅ | +| Vita | ❌ | ✅ | ✅ | | PS4 | ❌ | ✅ | ✅ | | webOS | ❌ | ❌ | ✅ | -| Libretro | ✅ | ✅ | ✅ | | Original Xbox | ❌ | ✅ | ✅ | +| Windows | ✅ | ✅ | ✅ | +| macOS | ✅ | ✅ | ✅ | +| Linux/BSD | ✅ | ✅ | ✅ | +| Libretro | ✅ | ✅ | ✅ | | WASM | ✅ | ✅ | ✅ | ### `SE_DOWNLOAD` @@ -332,6 +337,12 @@ Text-to-Speech blocks. Defaults to `ON` on all supported platforms. Whether or not the runtime inspector is enabled. Defaults to `ON`. +### `SE_JIT` + +Whether or not to use the just-in-time compiler to compile bytecode into machine +code, massively improving performance. Defaults to `ON` for all supported +platforms. + ### `SE_LOADSCREEN` Whether or not to show the leading screen while loading a project. If set to @@ -374,21 +385,21 @@ The renderer backend to be used. Can be one of `sdl1`, `sdl2`, `sdl3`, `opengl`, | Platform | `d3d9` | `opengl_core` | `nv2a` | `xbox` | `gx2` | `sdl2` | `sdl3` | `opengl` | `gdi` | `sdl1` | `citro2d` | `gl2d` | `headless` | | ------------- | ------ | ------------- | ------ | ------ | ----- | ------ | ------ | -------- | ----- | ------ | --------- | ------ | ---------- | -| Windows | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ✅ | -| macOS | ❌ | ✅ | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ | ❌ | ✅ | ❌ | ❌ | ✅ | -| Linux/BSD | ❌ | ✅ | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ | ❌ | ✅ | ❌ | ❌ | ✅ | +| GameCube | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | +| DS(i) | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ | +| Wii | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ✅ | | 3DS | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ✅ | -| DS | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ | | Wii U | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | -| Wii | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ✅ | -| GameCube | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | | Switch | ❌ | ✅ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | -| Vita | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ | ❌ | ❌ | ✅ | ❌ | ❌ | ✅ | | PSP | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | +| Vita | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ | ❌ | ❌ | ✅ | ❌ | ❌ | ✅ | | PS4 | ❌ | ✅ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | | webOS | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | -| Libretro | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | | Original Xbox | ❌ | ❌ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | +| Windows | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ✅ | +| macOS | ❌ | ✅ | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ | ❌ | ✅ | ❌ | ❌ | ✅ | +| Linux/BSD | ❌ | ✅ | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ | ❌ | ✅ | ❌ | ❌ | ✅ | +| Libretro | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | | WASM | ❌ | ✅ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | SE! prioritizes renderers in the following order: `d3d9`, `opengl_core`, `nv2a`, diff --git a/controls.md b/controls.md index 9cb9101..f4ed902 100644 --- a/controls.md +++ b/controls.md @@ -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. diff --git a/docker.md b/docker.md index 2f88b16..fae8751 100644 --- a/docker.md +++ b/docker.md @@ -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)
`.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! diff --git a/extensions/format.md b/extensions/format.md index bc58987..59c1c40 100644 --- a/extensions/format.md +++ b/extensions/format.md @@ -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 diff --git a/index.md b/index.md index 6715ecc..2f6d82c 100644 --- a/index.md +++ b/index.md @@ -27,18 +27,18 @@ features:

+GameCube Nightly Build +DS(i) Nightly Build +Wii Nightly Build 3DS Nightly Build -NDS Nightly Build Wii U Nightly Build -Wii Nightly Build -GameCube Nightly Build Switch Nightly Build -Vita Nightly Build PSP Nightly Build +Vita Nightly Build PS4 Nightly Build -PC Nightly Build webOS Nightly Build -Libretro Nightly Build Original Xbox Nightly Build +PC Nightly Build +Libretro Nightly Build Discord

diff --git a/install.md b/install.md index 33cf86b..cb2e677 100644 --- a/install.md +++ b/install.md @@ -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 @@ -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 @@ -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 @@ -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] @@ -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] @@ -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 @@ -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 +! diff --git a/intro.md b/intro.md index 95c6390..fb4551b 100644 --- a/intro.md +++ b/intro.md @@ -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)! diff --git a/limitations.md b/limitations.md index 04bac8c..a901c71 100644 --- a/limitations.md +++ b/limitations.md @@ -9,8 +9,9 @@ crashes, and things that will just not work. you know of a block that's causing problems). - Performance is poor when running complex projects, specifically those with many clones or lots of blocks running at once. - - Some older platforms (NDS, GameCube, PSP, Original Xbox) especially struggle - due to memory constraints. Try to keep projects small on these platforms. + - Some older platforms (Original Xbox, DS(i), GameCube, PSP) especially + struggle due to memory constraints. Try to keep projects small on these + platforms. - Sounds may take time to load when playing them for the first time. ## Unimplemented Blocks @@ -39,43 +40,55 @@ features support specific features. ### Features -| Platform | Cloud Variables | Native Extensions | Lua Extensions | -| ------------- | --------------- | ----------------- | -------------- | -| Windows | ✅ | ❌ | ✅ | -| macOS | ✅ | ✅ | ✅ | -| Linux | ✅ | ✅ | ✅ | -| 3DS | ✅ | ❌ | ✅ | -| DS | ❌ | ❌ | ❌ | -| Wii U | ✅ | ❌ | ✅ | -| Wii | ❌ | ❌ | ✅ | -| GameCube | ❌ | ❌ | ✅ | -| Switch | ❌ | ❌ | ✅ | -| Vita | ❌ | ❌ | ✅ | -| PSP | ❌ | ❌ | ❌ | -| PS4 | ✅ | ❌ | ❌ | -| Libretro | ✅ | ❌ | ❌ | -| Original Xbox | ❌ | ❌ | ✅ | +| Platform | Cloud Variables | Native Extensions | Lua Extensions | Just-in-Time Compiler | +| ------------- | --------------- | ----------------- | -------------- | --------------------- | +| GameCube | ❌ | ❌ | ✅ | ✅[^3] | +| DS(i) | ❌ | ❌ | ❌ | ❌ | +| Wii | ❌ | ❌ | ✅ | ✅ | +| Wii U | ✅ | ❌ | ✅ | ✅ | +| 3DS | ✅ | ❌ | ✅ | ✅ | +| Switch | ❌ | ❌ | ✅ | ✅ | +| PSP | ❌ | ❌ | ❌ | ❌ | +| Vita | ❌ | ❌ | ✅ | ✅ | +| PS4 | ✅ | ❌ | ❌ | ✅ | +| webOS | ❌ | ❌ | ✅ | ✅[^2] | +| Original Xbox | ❌ | ❌ | ✅ | ✅ | +| Windows | ✅ | ❌ | ✅ | ✅[^1] | +| macOS | ✅ | ✅ | ✅ | ✅[^1] | +| Linux | ✅ | ✅ | ✅ | ✅[^1] | +| Libretro | ✅ | ❌ | ❌ | ✅[^1] | +| WASM | ❌ | ❌ | ✅ | ❌ | + +[^1]: PC and Libretro only support JIT on `x86_64` (`amd64`), `aarch64` + (`arm64`), `i386` and `i686` (`x86`), and `riscv64`. + +[^2]: webOS only supports JIT on `aarch64` (`arm64`). + +[^3]: GameCube currently has the JIT compiler disabled by default. You will need + to manually enable it in the project settings. ### Extensions -| Platform | Pen | Text to Speech[^1] | Makey Makey | Translate | +| Platform | Pen | Text to Speech[^4] | Makey Makey | Translate | | ------------- | --- | ------------------ | ----------- | --------- | -| Windows | ✅ | ✅ | ✅ | ✅ | -| macOS | ✅ | ✅ | ✅ | ✅ | -| Linux | ✅ | ✅ | ✅ | ✅ | +| GameCube | ✅ | 🟡 | ✅ | ❌ | +| DS(i) | ❌ | ❌ | ✅ | ❌ | +| Wii | ✅ | 🟡 | ✅ | ❌ | | 3DS | ✅ | ✅ | ✅ | ✅ | -| DS | ❌ | ❌ | ✅ | ❌ | | Wii U | ✅ | ✅ | ✅ | ✅ | -| Wii | ✅ | 🟡 | ✅ | ❌ | -| GameCube | ✅ | 🟡 | ✅ | ❌ | | Switch | ✅ | 🟡 | ✅ | ❌ | -| Vita | ✅ | 🟡 | ✅ | ❌ | | PSP | ✅ | 🟡 | ✅ | ❌ | +| Vita | ✅ | 🟡 | ✅ | ❌ | | PS4 | ✅ | ✅ | ✅ | ✅ | -| Libretro | ✅ | ✅ | ✅ | ✅ | +| webOS | ✅ | ✅ | ✅ | ✅ | | Original Xbox | ✅ | ✅ | ✅ | ✅ | +| Windows | ✅ | ✅ | ✅ | ✅ | +| macOS | ✅ | ✅ | ✅ | ✅ | +| Linux | ✅ | ✅ | ✅ | ✅ | +| Libretro | ✅ | ✅ | ✅ | ✅ | +| WASM | ✅ | 🟡 | ✅ | ❌ | -[^1]: Text-to-Speech can use either the official Scratch servers (if the +[^4]: Text-to-Speech can use either the official Scratch servers (if the platform supports it), or DECtalk, which runs locally but is not 100% accurate. Platforms marked with a 🟡 support DECtalk only, while those with a ✅ support both. @@ -84,12 +97,14 @@ features support specific features. - **[Wii, Wii U, GameCube, Switch, PS4, Original Xbox]** The first controller connected will be the only one that will work. +- **[DS(i)]** Dual screen mode will not be supported. +- **[DS(i)]** Only WAV audio is supported at the moment. +- **[DS(i)/3DS]** ::sb touching color [#754D75]?:: and + :sb color [#754D75] is touching [#754D75]?:: are unimplemented. - **[Wii]** If you're using a PAL Wii, you must use 50Hz. -- **[PSP]** Images cannot be over 512x512. - **[3DS]** If a project has a bunch of large images, some may not load. - **[3DS]** Some vector images will appear bigger than they should. -- **[NDS]** Dual screen mode will not be supported. -- **[NDS]** Only WAV audio is supported at the moment. +- **[PSP]** Images cannot be over 512x512. - **[Vita]** Back touch will not be supported. - **[Original Xbox]** UI and projects might fail to load graphical assets from time to time. Rebooting your Xbox should fix this. @@ -98,5 +113,3 @@ features support specific features. - **[Original Xbox]** Not all projects will look correct upon launch. "Fuzzy" assets is a known quirk of the renderer, and will be addressed in future releases. -- **[NDS/3DS]** ::sb touching color [#754D75]?:: and - ::sb color [#754D75] is touching [#754D75]?:: are unimplemented. diff --git a/settings.md b/settings.md index 32050bf..a7c780d 100644 --- a/settings.md +++ b/settings.md @@ -23,7 +23,7 @@ they must be unpacked again if the original project file changes. Whether to show the project on the bottom screen instead of the top. -**Exclusive to 3DS/DS/Wii U.** Disabled by default. +**Exclusive to 3DS/DS(i)/Wii U.** Disabled by default. ### Pen Mode @@ -55,7 +55,7 @@ Whether or not to display FPS info when running a project. Disabled by default. Whether or not to store the project in RAM. This can boost performance when loading a new costume or sound, but may cause problems on lower-end platforms. -Enabled by default on all platforms except for DS, GameCube, and PSP. +Enabled by default on all platforms except for DS(i), GameCube, and PSP. ### Warp Timer @@ -66,6 +66,18 @@ finishes. This can fix crashes/freezes related to infinite loops, but it may also cause a performance impact. It is enabled by default. +### Runtime + +The runtime to use while running the project. Can be either `JIT`, `Bytecode`, +or `Interpreter`. + +JIT has the highest performance, but isn't supported for all platforms. +Interpreter should only be used for troubleshooting or if the platform doesn't +support anything else, as it is much slower than the other runtimes. + +Defaults to Interpreter on PSP, GameCube, and DS(i), JIT for platforms that +support it, and Bytecode for everything else. + ## Global Settings These settings can be found on the main menu. They apply to all projects. @@ -98,6 +110,18 @@ effect. Enabled by default. Enables DECtalk for text-to-speech if the platform supports it. +### Renderer + +Select a different renderer to use. Can help with troubleshooting. + +### Window Backend + +Select a different windowing backend to use. Can help with troubleshooting. + +### Audio Backend + +Select a different audio backend to use. Can help with troubleshooting. + ## Pause Menu Settings These settings are found in the pause menu (accessible by holding Start for 3