Amongsprite NPM

🚀 Install

Simply run:

npm install amongsprite

📟 How to Use

Check the assets for the name of Backgrounds, hats, outfits and pets.

Syntax

• resolution in pixels (looks nicer if < 600)
• hexColor should be a 6-digit hex code (eg. #000000)
• Other params should be valid names from assets OR an url to a custom image (use 600x600).
• If you use are using a custom image:
↳ #123456 will be replaced with the main color
↳ #654321 will be replaced with the shadow.
Note: Alternatively, you may import const { Types } = AmongSprite for better content assistant.

const AmongSprite = require('amongsprite')

const canvas = await AmongSprite.create(resolution, hexColor, background, hat?, outfit?, pet?)

Example

Working example bellow should generate the same image above (Rick Sprite).

const AmongSprite = require('amongsprite');
const { Types } = AmongSprite;

const canvas = await AmongSprite.create(
	175, 
	'#D6C9BD', 
	Types.BG.PORTAL_SPACE, 
	Types.HATS.RICK, 
	Types.OUTFITS.RICK, 
	Types.PETS.UFO
);

const fs = require('fs');
fs.writeFileSync('./result.html', `<img src='${canvas.toDataURL()}'></img>`);