Permafy

Permafy is a PenguinMod-style fork focused on the project player, project catalog, and editor runtime.

Projects site

Repo split

This repository is the source for the project site and editor runtime used by the projects deployment.

We split the public site into separate GitHub Pages repos:

• Permafy/projects -> main project host and project viewer, using projects.permafy.org
• Permafy/studio -> editor-only site, using studio.permafy.org
• Permafy/permafy.github.io -> dashboard/home site at https://permafy.github.io

This repo is not the dashboard homepage. It is the project/player/editor codebase.

Source of truth

• Source code for projects/player/editor: Permafy/projects
• Source code for the dashboard/home site: separate repo, built from dashboard-site/
• Source code for Studio/editor-only deployment: separate repo, built from studio-site/

Build outputs

Use these commands to generate deployable sites:

npm run build
npm run build:studio-site
npm run build:dashboard-site

Then publish each directory to its own repository:

npx gh-pages -d build -r https://github.com/Permafy/projects.git -b gh-pages
npx gh-pages -d studio-site -r https://github.com/Permafy/studio.git -b gh-pages
npx gh-pages -d dashboard-site --dotfiles -r https://github.com/Permafy/permafy.github.io.git -b gh-pages

The dashboard repo keeps permafy.org configured as its custom domain; every dashboard-site/ build writes its CNAME so deployments preserve that connection. Its build also includes .nojekyll so GitHub Pages serves SvelteKit's _app/ assets; publish with --dotfiles so gh-pages includes that file.

Important DNS / GitHub Pages notes

• projects.permafy.org should point to the gh-pages branch of Permafy/projects
• studio.permafy.org should point to the gh-pages branch of Permafy/studio
• permafy.github.io is served by the Permafy/permafy.github.io repository
• Publish the dashboard output to the gh-pages branch, then change that repository's Pages source from main to gh-pages (root folder).
• Leave the dashboard without a CNAME file when using the default permafy.github.io address.

If projects is already published at permafy.org, then that site is currently serving the dashboard output from the gh-pages branch of the projects repo. To separate things correctly, the dashboard must live in its own repo or its own deployment branch.

Setup

See https://docs.turbowarp.org/development/getting-started to set up the complete TurboWarp environment.

If you just want to play with the GUI, the process is the same as upstream scratch-gui.

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/

default_project.pmf's README

Welcome to Permafy, a PenguinMod fork with some other Scratch Mods features!! :D we're glad to have you here!

See https://permafy.github.io/docs for the documentation and how to get started.

Have so much fun playing around w/ the editor! (scroll down for way more information)

--- additional information ---

Found a Bug? Tell me! https://github.com/Permafy/permafy.github.io/issues/

Wanna play around with the source code? https://github.com/Permafy/

--- supporting ---

Permafy is made by only one people and its alts. Wanna support him? Sorry, there is no pay method for him...

--- last thing xd ---

Here, we put this comment here since we got inspired by Astra Editor's default README feature and GaiaMod's (https://gaiamod-main.github.io).