Skip to content

ampelc/ampmod

AmpMod editor

CI status Multiple licences, click here for more info

This is the source code for the AmpMod editor. AmpMod (formerly UltiBlocks) is a powerful block-based programming language based off TurboWarp, mainly focusing on advanced data types, as well as dozens of quality-of-life changes.

Try AmpMod now!

View this repository on Codeberg or on GitHub.

To access the canary build which has the newest features at the cost of more bugs, see https://ampmod.codeberg.page/@canary

Included packages

The following packages are included in this monorepo:

Package Description
gui The user interface used to run/create projects.
vm The package that executes projects and loads extensions.
blocks The package used for the drag-and-drop block interface.
desktop The desktop app for AmpMod.
paint The paint editor for creating costumes and backdrops.
render-fonts A package that contains fonts used in projects.
branding Branding data. See Forking.

We have an NPM registry, but it's currently outdated. We hope to update it at some point to make depending on AmpMod's packages much easier.

Development

Please read CONTRIBUTING.md before you contribute. This might seem pointless, but it is very important so you don't end up submitting broken, vibe-coded snippets.

We use pnpm to manage dependencies. To install pnpm, run corepack enable (Node >= 18) or npm i -g pnpm (Node < 18).

Run pnpm i in the root directory to install all packages needed.

desktop's dependencies in particular may bloat your system. If you don't need to develop the desktop app, run pnpm --filter=!turbowarp-desktop i instead.

Forking

Here are some important recommendations for forks. Since AmpMod is free and open-source, we don't strictly require you to follow these. However, we recommend you do so.

  • Change the branding of your mod. This is perhaps the most important change for a fork. Instead of modifying packages/gui/src/lib/brand.js, you should modify packages/branding/src/index.js. You will especially want to change APP_NAME and APP_SOURCE.
  • Create your own accent colour. We recommend using a colour from the Scratch category palette, or at least a colour made to look like it. Some other accent colours like rainbow and grey already exist; you can use those.
  • Please release your source code. Not doing so is illegal and violates the GPL/MPL. However, you are allowed to use the files outside of packages and .woodpecker in closed-source projects, as those are under 0BSD.

Licence

AmpMod is free software. The root folder is under 0BSD. Each package has its own licence which is symlinked to a file in the licenses folder.

.woodpecker folder is under GPLv3.

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors