add readme

main
capy4king 2023-07-16 10:31:31 +02:00
parent 2b940ba523
commit a147c44df4
1 changed files with 13 additions and 0 deletions

13
marsey/README.md 100644
View File

@ -0,0 +1,13 @@
# Marsey font
marseys/ - all marsey assets
marseys/marsey_load.sh [name] - download a marsey by its name and automatically convert it to the right format and size. Must be used while inside the marsey directory.
marseys.conf - links the marseys to the corresponding
convert_filename.py - convert any emoji to the corresponding emoji identifier for marseys.conf. Eg, 🤓 -> emoji_u1f913.png
sexrace.py - generates all gender and ethnicity variations given a placeholder input for marseys.conf. Example input for thumbs up: marseythumbsup=emoji_u1f44dRACE.png. Input for cop: marseycop=emoji_u1f46eRACEGENDERADD.png
marsey_replacer.sh - replaces emojis by marseys, as specified in marseys.conf. Must be run from the marseymoji base directory.