Skip to content

Latest commit

 

History

History
executable file
·
62 lines (41 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
62 lines (41 loc) · 2.61 KB

Contribution Guide

About

This documents information that should help you get started in contributing to the project, such as project conventions.

License

This section is only relevant to submissions of new assets for the repository. If your contribution is feedback or an emote idea, this does not apply to you.

Before contributing, please keep in mind that this repository is under the Creative Commons Attribution 4.0 International (CC BY 4.0) license.

This is a very permissive and perpetual public license which grants anyone the right to use the work for any purpose, including commercial.

Please read the terms before submitting assets to the project. A human readable summary of CC BY is also available.

Conventions

Files & Directories

Directory Purpose
src/static/ The full quality static emojis.
src/masks/ Grayscale mask that show what parts of the image can have it's color altered.
src/projects/ Project files for each emote.
LICENSE The license your contribution will be published under.
README.md Information and attributions to serve to anyone receiving the emotes.

Naming and Guidelines

Type Name Notes
Emotes pandaXyz.png Minimum of 512x512, should still look good at 64x64.
Masks pandaXyz.mask.png Same size as emote. Not required if every pixel should be modulated for color variations.
Projects pandaXyz.ora You can use any program to draw, but the result must be an ORA file.

Reference Sheet

Color Palette

Body Part Colors
Fur #E9700D
Mouth fur #E4C195, #7B3C05
Body fur #5A1F00
Ears #430700
Mouth #950500, #F966E0

Adding Emotes

There are three acceptable ways to include new emotes in the repository, in order of preference:

  1. Fork the repository on GitLab, and use git to push your emote and open a merge request.
  2. If you don't know how to open a merge request, you can open an issue with your emote attached.
  3. If you don't have a GitLab account and are reluctant to make one, email Seth Falco and attach your emote.

If you follow either option 2 or 3, you must do the following in your message:

  • Attach a copy of the CC BY 4.0 license, and declare that you understand the license terms.
  • Share the name and email address you'd like to use for attribution.