Official quick start templates

We recommend that you use one of our templates to get started.

• Typescript (recommended):

https://github.com/albaart/alba-template-p5-typescript

• JavaScript:

https://github.com/albaart/alba-template-p5-javascript

• ThreeJS coming shortly.

<aside> 🥱 TLDR - Use alba.params.seed to seed your project’s randomness.

• Use window.innerWidth or window.innerHeight to set the size of the canvas, and set the second dimension by multiplying or dividing by the aspectRatio.
• Use window.devicePixelRatio to detect the pixel density of a user’s device
• Call alba.setMetadata(traits) to set metadata, passing an object with key/value pairs. - Call alba.setComplete(true) when you’re done drawing to capture the image output.

</aside>

Uploading your script

Your project needs to be combined into a single script, then copy and added in the Artist Dashboard. Alba’s focus is on purely code-based projects, so to ensure that your work is 100% reproducible on-chain, there is no ability to make external API calls, or upload HTML files, pre-rendered images, or other assets.

When you save your code on Alba:

• The original version of your code is archived in a private, internal database for future proofing the distribution and presentation of your work for any institutions or curators we might work with in the future, so we encourage you to paste in the unminified version of your code.
• Your code is automatically minified, as long as minification can save you 10% in file size or more.
• The minified code is then compressed using gzip to save on space and upload costs.

There is a cost calculator in the Artist Dashboard where you can get an estimate on the upload cost of your script.

Alba currently supports releasing projects of any size. However, our dashboard only supports launching projects which are under 24kb after compression. If your project is larger than that, you won’t be able to deploy your project on your own right now, but reach out to us in Discord and we can help publish it in multiple chunks.

Alba’s scripts

In addition to any library dependencies you select while setting up your project, we automatically inject two Alba scripts into your project: