Stoat genemoji

Description

genemoji is a small CLI tool to generate Stoat's emoji asset folder. It transforms the various folder structures of the emoji packs into a unified directory structure.

Supported Packs

• Fluent
• Twemoji
• Mutant Remix
• Noto Emoji

Submodule Hint

This project contains submodules. Run git submodule init after you clone this repository to initialize the submodules. It is also recommended to run git submodule update after you pull from upstream.

Resources

genemoji

• The Metadata We Use to Power Emoji in Stoat

Stoat

• Stoat Project Board (Submit feature requests here)
• Stoat Testers Server
• Contribution Guide

Quick Start

genemoji runs on Bun.

bun install
bun start

When genemoji is finished generating the packs, the output will be located in emoji/, split up by pack ID.

The coverage report (bun run report) is published to GitHub Pages.

CLI Commands

Command	Description
bun start	Generate the emoji packs.
bun dev	Generate the emoji packs, re-running on source changes.
bun run report	Write an HTML coverage report into report/ (run after bun start).
bun run typecheck	Type-check the sources with TypeScript.
bun run format	Run Prettier on the client. (check only)
bun run format:fix	Run Prettier on the client. (automatically fixes bad formatting)