https://github.com/revoltchat/genemoji

Revolt Emoji Pack Structure Unification Toolchain
https://github.com/revoltchat/genemoji

emoji revolt

Last synced: 4 days ago
JSON representation

Revolt Emoji Pack Structure Unification Toolchain

• Host: GitHub
• URL: https://github.com/revoltchat/genemoji
• Owner: revoltchat
• Created: 2022-09-08T21:36:39.000Z (about 2 years ago)
• Default Branch: dev
• Last Pushed: 2024-03-28T13:38:14.000Z (8 months ago)
• Last Synced: 2024-03-28T14:56:52.453Z (8 months ago)
• Topics: emoji, revolt
• Language: TypeScript
• Homepage:
• Size: 8.79 KB
• Stars: 3
• Watchers: 4
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Revolt genemoji

## Description

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

## Supported Packs

-   [Fluent](https://github.com/microsoft/fluentui-emoji)

-   [Twemoji](https://twemoji.twitter.com)

-   [Mutant Remix](https://mutant.revolt.chat)

-   [Noto Color Emoji](https://fonts.google.com/noto/specimen/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 Revolt](https://github.com/googlefonts/emoji-metadata)

### Revolt

-   [Revolt Project Board](https://github.com/revoltchat/revolt/discussions) (Submit feature requests here)

-   [Revolt Testers Server](https://app.revolt.chat/invite/Testers)

-   [Contribution Guide](https://developers.revolt.chat/contributing)

## Quick Start

```sh

yarn build

yarn start

```

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

## CLI Commands

| Command           | Description                                                      |

| ----------------- | ---------------------------------------------------------------- |

| `yarn dev`        | Start TypeScript watcher, rebuilds on change.                    |

| `yarn build`      | Build the CLI.                                                   |

| `yarn start`      | Initiate generation with built CLI.                              |

| `yarn format`     | Run Prettier on the client. (check only)                         |

| `yarn format:fix` | Run Prettier on the client. (automatically fixes bad formatting) |