summaryrefslogtreecommitdiff
path: root/docs/config/custom_emoji.md
diff options
context:
space:
mode:
authorlambda <lain@soykaf.club>2019-03-29 10:24:52 +0000
committerlambda <lain@soykaf.club>2019-03-29 10:24:52 +0000
commit749d53e2b2ffb108964c569f04e5989c63643338 (patch)
tree5c765f1be631734c99e690fbefc1906eb487f208 /docs/config/custom_emoji.md
parent52bec238c3c80a246eb269de9afb1f9b3ea58f4f (diff)
parent634e09e1a8d0c26ad9a89875e3f713a0bf07ea3e (diff)
downloadpleroma-749d53e2b2ffb108964c569f04e5989c63643338.tar.gz
pleroma-749d53e2b2ffb108964c569f04e5989c63643338.zip
Merge branch 'sayonara-gitlab-wiki' into 'develop'
Move out of Gitlab Wiki See merge request pleroma/pleroma!990
Diffstat (limited to 'docs/config/custom_emoji.md')
-rw-r--r--docs/config/custom_emoji.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/config/custom_emoji.md b/docs/config/custom_emoji.md
new file mode 100644
index 000000000..e833d2080
--- /dev/null
+++ b/docs/config/custom_emoji.md
@@ -0,0 +1,18 @@
+# Custom Emoji
+
+To add custom emoji:
+* Add the image file(s) to `priv/static/emoji/custom`
+* In case of conflicts: add the desired shortcode with the path to `config/custom_emoji.txt`, comma-separated and one per line
+* Force recompilation (``mix clean && mix compile``)
+
+Example:
+
+image files (in `/priv/static/emoji/custom`): `happy.png` and `sad.png`
+
+content of `config/custom_emoji.txt`:
+```
+happy, /emoji/custom/happy.png
+sad, /emoji/custom/sad.png
+```
+
+The files should be PNG (APNG is okay with `.png` for `image/png` Content-type) and under 50kb for compatibility with mastodon.