Giter Club home page Giter Club logo

serenityos-emoji-font's Introduction

SerenityOS Emoji Font

The SerenityOS pixel art emojis embedded in a TrueType font.

banner

Installation & Usage

A nightly build of the font is done automatically via GitHub Actions, you can download it from here.

The font can be installed as a system wide font for emojis, used on a website, and more. The former will depend a lot on your operating system and desktop environment, an example for the latter can be found in the HTML file included in the archive mentioned above.

Please make sure to include a copy of the LICENSE file when distributing the font!

What's included?

Everything from /res/emoji, except for the private use area (PUA) emojis, which are mostly the yaks.

This means that non-standard emojis such as flags and ZWJ combinations (e.g. catdog) are included as well.

Building locally

Uses pixart2svg for vectorization of the emoji PNG images and nanoemoji to build the font. SVGs are cached, so subsequent runs of the build script will be much faster.

  • Clone SerenityOS and export the path of your local checkout:

    export SERENITY_SOURCE_DIR='...'
  • Install dependencies:

    pip install --user -r requirements.txt
  • Download and patch pixart2svg:

    wget https://gist.githubusercontent.com/m13253/66284bc244deeff0f0f8863c206421c7/raw/f9454958dc0a33cea787cc6fbd7e8e34ba6eb23b/pixart2svg.py
    for file in patches/*.patch; do
      patch -p0 < "$file"
    done
  • Build SerenityOS-Emoji.ttf:

    python main.py

The output files (TTF, index.html listing all included emojis) will be in build/.

TODO

This is an initial proof of concept that could be refined in multiple ways:

  • Replace pixart2svg with something that is more flexible and doesn't need to be patched locally (it's GPL-licensed)
  • Find a better approach for vectorization - the current solution of using adjacent SVG rects should in theory yield perfect results but has visible gaps between segments in reality, depending on the renderer and zoom level

Credit

This wouldn't be possible without all the awesome people creating & refining these emojis for the SerenityOS project! โค

serenityos-emoji-font's People

Contributors

hjalves avatar linusg avatar xexxa avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

serenityos-emoji-font's Issues

The scripts are BSD too right?

Hello!

Umm all the scripts and patches are BSD too right? The license kinda says so, but it's formatted in a ambiguous manner. It feels like the scripts are All right reserved but the original emojis are all right reserved, but licensed with BSD.

Maybe we can make the license clearer? "Both the scripts and the original emoji files are licensed under the BSD" would make it clearer for others.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.