Install & Build - aeryli/Scratch-3DS GitHub Wiki

Installation

There are 2 methods to install the runtime.

  • Download the release or nightly build (easy)
  • Build the file yourself (harder)

[!NOTE] Nightly builds are significantly more unstable than releases and should probably only be used if you are instructed to do so in a bug report.

Get up and running for 3DS

Download the .3dsx file in the Releases tab or nightly build.

  • Place the .3dsx file in the 3ds/ folder of your 3DS SD card, along with any Scratch projects you want to run.

[!NOTE] Scratch 3DS is also on Universal Updater, so you can just download it there and keep it updated that way!

Then it should be as simple as opening the homebrew launcher on your 3DS and running the app!

Get up and running for Wii U

Download the .zip file in the Releases tab or nightly build.

Unzip the file in your sdcard:/wiiu/apps/ folder.

Place the scratch projects you want in sdcard:/wiiu/scratch-wiiu/

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

Building

In order to embed a Scratch project in the executable, you'll need to compile the source code.

For 3DS and Wii U, you will need to have Devkitpro's SDKs installed.

  • For the 3DS you will need the DevkitARM toolchain and libctru.

    • You will also need a 3DS compiled version of SDL2 and SDL2_mixer. See the Nightly Build commands for a reference on how to compile SDL2 3DS for yourself.

  • For the Wii U you will need the DevkitPPC toolchain, WUT, all SDL2-wiiu libraries, and libromfs-wiiu.

  • Devkitpro's install instructions are available at : https://devkitpro.org/wiki/Getting_Started

Download the source code from the releases tab and unzip it.

Make a romfs folder inside the unzipped source code and put the Scratch project inside of that.

  • The Scratch project MUST be named project.sb3, all lowercase.
  • For faster load times/less limitations, you can also unzip the sb3 project file and put the contents into a new folder called project.

If you would like to change the name of the app or any other information you can edit one of the Makefiles.

  • For the 3DS you need to edit Makefile_3ds and change APP_TITLE, APP_DESCRIPTION and APP_AUTHOR to whatever you please.
  • For the Wii U you need to edit Makefile_wiiu and change APP_NAME, APP_SHORT_DESCRIPTION, APP_LONG_DESCRIPTION and APP_AUTHOR to whatever you please.

Then you need to compile the projects into proper Homebrew packages.

  • For the 3DS you simply need to run make. Then copy the Scratch-3DS.3dsx file like you normally would.
  • For the Wii U you need to run make PLATFORM=wiiu all package and then copy the build/wiiu/scratch-wiiu folder into the sdcard:/wiiu/apps folder on your sd card.

Compilation Flags

Compilation flags are used to select which features will be enabled in the compiled version of Scratch 3DS. To use a compilation flag simply add it to the end of the make command (e.g. make ENABLE_BUBBLES=0).

  • 3DS - ENABLE_BUBBLES (default: 1): If set to 1, the loading screen is enabled, if set to 0 the screen is simply black during that time.