Skip to content

README.md

Latest commit

 

History

History
375 lines (250 loc) · 13.4 KB

README.md

File metadata and controls

375 lines (250 loc) · 13.4 KB

scratch-gui modified for use in 02engine

Setup

See https://docs.02engine.org/development/getting-started to setup the complete TurboWarp environment.

This fork uses Bun as the package/script runner. Do not use npm install, npm run ..., or npm test for normal development in this repository.

Install Bun first: https://bun.sh/

Then install dependencies:

bun install

Development Commands

Start the local development server:

bun run start

Build the GUI:

bun run build

Run the default test pipeline:

bun run test

Run lint only:

bun run test:lint

Run unit tests only:

bun run test:unit

Run integration tests only:

bun run test:integration

Run smoke tests only:

bun run test:smoke

Watch and rebuild:

bun run watch

Sync credits:

bun run sync:credits

Sync PenguinMod extension metadata:

bun run sync:penguinmod

Notes

  • The project scripts in package.json are written to work with Bun.
  • Some old upstream scratch-gui documentation is kept below inside an HTML comment for license/history reference. Any old npm commands in that commented section are not the recommended workflow for 02engine.
  • If dependencies become corrupted, remove node_modules and run bun install again.

License

TurboWarp's modifications to Scratch are licensed under the GNU General Public License v3.0. See LICENSE or https://www.gnu.org/licenses/ for details.

The following is the original license for scratch-gui, which we are required to retain. This is NOT the license of this project.

Copyright (c) 2016, Massachusetts Institute of Technology
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

src/lib/default-project/dango.svg is based on Twemoji and is licensed under CC BY 4.0 https://creativecommons.org/licenses/by/4.0/