ScratchNpm

A Node.js configuration tool for Scratch and Scratch mod projects. ScratchNpm helps you set up and manage your Scratch projects with a simple configuration file.

Installation

Install ScratchNpm as a dev dependency in your project:

npm install scratchnpm --save-dev

During installation, you'll be prompted with questions to set up your project.scratchjs.json configuration file.

Manual Setup

If you want to run the setup again or skip the automatic installation prompt, you can manually run:

npx scratchnpm-init

Configuration

ScratchNpm creates a project.scratchjs.json file in your project root with the following structure:

{
    "name": "Your Project Name",
    "version": "1.0.0",
    "description": "Your project description",
    "authors": "Your Name",
    "license": "MIT",
    "is scratch?": false,
    "scratch-mods": {
        "PenguinMod": true,
        "Turbowarp": true,
        "MistWarp": true
    },
    "main": "project.sb3",
    "devDependencies": {
        "scratchnpm": "1.0.0"
    }
}

Configuration Options

• name: Your project's name
• version: Project version (follows semantic versioning)
• description: A brief description of your project
• authors: Project author(s)
• license: Project license (default: MIT)
• is scratch?: Whether this is a standard Scratch project
• scratch-mods: Compatibility flags for Scratch mods
  • PenguinMod: Support for PenguinMod
  • Turbowarp: Support for Turbowarp
  • MistWarp: Support for MistWarp
• main: Your main .sb3 file
• devDependencies: Development dependencies (automatically includes scratchnpm)

Supported Scratch Mods

ScratchNpm supports configuration for:

• PenguinMod
• Turbowarp
• MistWarp

Example Project Structure

my-scratch-project/
├── node_modules/
├── project.scratchjs.json
├── package.json
└── my-game.sb3

Usage

1. Install ScratchNpm in your project
2. Answer the setup questions
3. Your project.scratchjs.json will be created automatically
4. Start building your Scratch project!

Future Features

ScratchNpm is currently a configuration tool. Future versions may include:

• Project validation
• Build tools for Scratch mods
• Asset management
• And more!

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

License

MIT

Author

Toastyzz0

Made with ❤️ for the Scratch community