https://github.com/mateusaquino/amongsprite

🖼️ NPM Package for generating custom Among Us canvas
https://github.com/mateusaquino/amongsprite

among among-us amongus avatar icon sprite

Last synced: about 1 month ago
JSON representation

🖼️ NPM Package for generating custom Among Us canvas

• Host: GitHub
• URL: https://github.com/mateusaquino/amongsprite
• Owner: MateusAquino
• Created: 2020-11-13T22:20:42.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-05-14T08:58:41.000Z (over 2 years ago)
• Last Synced: 2024-10-28T22:16:27.341Z (about 2 months ago)
• Topics: among, among-us, amongus, avatar, icon, sprite
• Language: JavaScript
• Homepage:
• Size: 5.5 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


    

    
AmongSprite



Package for generating custom Among Us canvas.




  

    

  

  

    

  

  

    

  



## 🚀 Install

Simply run:

```bash

npm install amongsprite

```

## 📟 How to Use

Check the [assets](./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.

```js

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).

```js

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', ``);

```

## ⚠️ Disclaimer

This is an unofficial Among Us Sprite generator. The fan art is provided by [Among Us Avatar Maker](https://amongusavatarmaker.com) whereas [Innersloth](http://www.innersloth.com/gameAmongUs.php) owns all rights to Among Us.