Using Assets

Last updated 5 months ago

Assets represent files that get loaded before the game starts. These can include audio, images, and custom assets such as level data.

Using Pearl's asset system saves you from writing custom code to load assets, and provides a simple UI for accessing your assets within your game's components.

Pearl's asset system does not handle the problem of bundling assets with your game, but is very easy to use with a bundler like Webpack, as you'll see below.

TODO: Explain Webpack require() a lil bit

Preloading Assets

Pearl includes a special preloader for loading assets before starting the game.

import {createPearl, ImageAsset} from 'pearl';
assets: {
swordImage: new ImageAsset(require('../sprites/sword.png')),
// ....

Now, within a component, we can access and use swordImage. For example, here we create a Sprite with it:

const swordImage = this.pearl.assets.get(ImageAsset, 'swordImage');
const swordSprite = new Sprite(

Custom Assets

You can define custom assets to load by extending the Asset class. For example, to load level data from an external file as a string, we could define an asset:

import {AssetBase} from 'pearl';
class LevelAsset extends AssetBase<string> {
async load(path: string): Promise<string> {
const resp = await fetch(path);
const level = await resp.body();
return level;
assets: {
levelOne: new LevelAsset(require('../levels/levelOne.txt')),
class LevelOne extends Component<null> {
init() {
const levelData = this.pearl.assets.get(LevelAsset, 'levelOne');