Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 1.52 KB

FORKING.md

File metadata and controls

26 lines (16 loc) · 1.52 KB

This file contains instructions on what you should do upon forking PenguinMod.

You don't HAVE to follow this document but it'll prevent a lot of confusion for your users and likely prevent your mod from being blacklisted from our internal servers.

Branding changes

Update any labels or text that says "PenguinMod" and put your mod's name. You shouldn't do this for IDs or anything like that.

You should also update your credits & privacy policy pages. We didn't work on your mod, you just made an extension of ours.

Update any links to our github to yours so people can find the source code. Also make sure to update links that you have your own version of like feedback, docs, or packager.

The "don't do that" section

Don't remove any credit to Scratch, TurboWarp, or PenguinMod. That's just not cool.
Imagine if someone just forked your copy and pretended they made it all themselves.

I'm not legal advice but you should probably not change the license or make the public repos you forked into private ones.

To my knowledge, you can't just do that without some problems.

Server changes

Unless you plan on keeping your mod 100% compatible with PenguinMod, please remove the Upload button and any project sharing features.

Our APIs are only built for PenguinMod and therefore will likely end up breaking in your mod at some point or another.

We also do not allow projects that only work outside of PenguinMod so if you end up having a lot of uploads from your site, then we'll have to block your site from being able to use the project API.