Riesi
/
frog_emojis
mirror of https://github.com/Riesi/frog_emojis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Mirror of Github repository
151 Commits 9 Branches 23 Tags 124 MiB
Python 81.5%
Shell 18.5%
Go to file
Miepee ef42630fca Actions: use external script 2022-03-01 14:55:26 +01:00
.github/workflows Actions: use external script 2022-03-01 14:55:26 +01:00
png [png] generate PNGs 2022-03-01 13:30:55 +01:00
svg [meta] introduce new naming convention and folder structure 🐸 ! 2022-02-22 13:20:10 +01:00
LICENSE [meta] improve README, use correct grahpics license and include a proper code license 2022-01-03 20:35:31 +01:00
LICENSE-GRAPHICS [meta] improve README, use correct grahpics license and include a proper code license 2022-01-03 20:35:31 +01:00
README.md [meta] introduce new naming convention and folder structure 🐸 ! 2022-02-22 13:20:10 +01:00
checkEmojis.sh Actions: use external script 2022-03-01 14:55:26 +01:00
gen_png.py [tools] fix git option not supporting renamed git objects properly 2022-03-01 13:30:55 +01:00
telegram_definitions.txt [bot] fix definitions file 2021-10-24 11:52:37 +02:00

README.md

Most of theses frogs are based on the SVGs of the twitter emoji set (https://twemoji.twitter.com). Others are unique designs with other inspirations in mind.

Have fun using them! 🐸

License

By contributing you agree to license your contribution under the terms of the GPLv3 (for code) and CC-BY 4.0 (for graphics) licenses. The corresponding license can be found in the LICENCE and LICENSE-GRAPHICS file respectively. The following links also reference to the licenses:

GPLv3: http://www.gnu.org/licenses/gpl-3.0.txt

CC-BY 4.0: https://github.com/twitter/twemoji/blob/gh-pages/LICENSE-GRAPHICS

Contributing

When submitting PRs keep the following in mind please:

  • only submit SVGs.
  • use the following naming scheme: verb/adjective+Frog+Object+Differential with camelCase. For example, sleepyFrogFamilyTkg for an emoji with a sleepy frog family, which is differentiated from a sleepy frog family, by including Tkg.
    • should you submit an emoji that has a clear emoji mapping to it, please prefix it with U[unicodeChracter]-. For example, U1f35e-frogBread.
    • should you be on Windows and case sensitivity seems to commit wrong, run the following command in the git repo: git config core.ignorecase false
  • only submit SVGs with the file ending .svg. Not .SVG or .sVg

Generating PNGs

If you want to generate PNGs from the SVGs, you can use the gen_png.py script.

Dependencies

  • Python 3.9 - To run the script.
  • Inkscape - Used to generate the PNGs. Needs to be located in PATH.
  • (Optional) git - Can be used to automatically add a new commit with the generated PNGs.

Usage

gen_png.py [OPTION]

-h, --help                      Shows this help message.
-a, --all                       Generate PNGs of all SVGs.
-s, --specific S [S ...]        Generate PNGs for each S in the "svg" folder. The '.svg' suffix is optional.
-r, --resolution R [R ...]      Custom resolutions that will be generated instead of the defaults (72, 512, 1024).
-g, --git                       Generates PNGs of SVGs that changed since last auto tag and creates a git commit with them. Requires 'git' to be installed and located in PATH.