aw3

aw3 is the software behind (almost) everything on the main AmpMod website. We gave it that strange name because this is the 3rd attempt at making an AmpMod website. The first attempt was this sloppily thrown together PHP server and the second was ampmod-web, which went well until the git history was ruined and poor decisions started to be made after we added a new contributor.

Stack:

• SvelteKit for integrating the backend and frontend. Because of this, we use Svelte for the frontend.
• TypeScript for scripting.
• pnpm for package management.
• Drizzle ORM and PostgreSQL for the database.
• Paraglide for translations.

What aw3 does

• Store projects and their assets
• Host pages for projects and users
• Host pages about AmpMod
• Provide APIs for the above
• Administrating the aw3 instance

What aw3 won't do in the near future

• Commenting on projects (it most likely never will - it's a nightmare to moderate for a small community with only a few admins) Update: we are considering adding comments to AmpMod, so this might be removed from the list soon
• Forums, wiki, manual, extension gallery (hosted separately)
• Editor (we have links to paths such as /projects/editor and /settings/addons but we expect you to reverse proxy those - see below)

What we plan for aw3 to do

• Studios

aw3 is purpose-built

aw3 is designed specifically for official AmpMod hosting. It is not built to be a general platform for hosting projects. Using it for a mod of AmpMod or its upstream projects would require heavy modification to have it under your branding, as unlike AmpMod itself, aw3 doesn't use a set-and-forget branding module.

Dev setup

pnpm install
pnpm dev

Database additional step

To run the database, you will need Docker. Then, you can run pnpm db:start in the root of your copy of aw3. It's good to run this in a separate terminal, and run pnpm db:push every time you update the schema.

Running in production

First, you will want to run pnpm run build.

Then, to serve the frontend, run node ./build. To set up the database, run the command above.

For the official AmpMod server, we use Docker and a Woodpecker CI workflow that builds aw3 as a container that can run on the server painlessly.

Setting up editor links

To set up links to AmpMod itself, such as /projects/editor, you need to use a reverse proxy to route those paths to AmpMod. aw3 previously hosted these routes by itself, but it was a bit clunky so we now expect that you do it yourself.

Licensing

aw3 is licenced under the AGPLv3 or at your option, any later version. See COPYING for more information.

Some files are taken from ampmod-web-front under the MIT licence, and the ampmod gui package under the GPLv3.