aboutsummaryrefslogtreecommitdiff
path: root/docs/config
diff options
context:
space:
mode:
authorSadposter <hannah+pleroma@coffee-and-dreams.uk>2019-04-10 10:44:54 +0100
committerSadposter <hannah+pleroma@coffee-and-dreams.uk>2019-04-10 10:44:54 +0100
commitbe8350baa2f8c9cf9be3f53ee4a0041dada1386f (patch)
tree8414fc2108941ccadd9b9fd4dd37c9d3cf731399 /docs/config
parent589629cf3e1bee9a4f6e92b8456d8614eff73c89 (diff)
parentc8440b5e0c97c5d5c03e4b99e30a61df6ab95319 (diff)
downloadpleroma-be8350baa2f8c9cf9be3f53ee4a0041dada1386f.tar.gz
Merge branch 'develop' into feature/user-status-subscriptions
Diffstat (limited to 'docs/config')
-rw-r--r--docs/config/custom_emoji.md39
1 files changed, 37 insertions, 2 deletions
diff --git a/docs/config/custom_emoji.md b/docs/config/custom_emoji.md
index e833d2080..419a7d0e2 100644
--- a/docs/config/custom_emoji.md
+++ b/docs/config/custom_emoji.md
@@ -11,8 +11,43 @@ 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
+happy, /emoji/custom/happy.png, Tag1,Tag2
+sad, /emoji/custom/sad.png, Tag1
+foo, /emoji/custom/foo.png
```
The files should be PNG (APNG is okay with `.png` for `image/png` Content-type) and under 50kb for compatibility with mastodon.
+
+## Emoji tags (groups)
+
+Default tags are set in `config.exs`.
+```elixir
+config :pleroma, :emoji,
+ shortcode_globs: ["/emoji/custom/**/*.png"],
+ groups: [
+ Finmoji: "/finmoji/128px/*-128.png",
+ Custom: ["/emoji/*.png", "/emoji/custom/*.png"]
+ ]
+```
+
+Order of the `groups` matters, so to override default tags just put your group on top of the list. E.g:
+```elixir
+config :pleroma, :emoji,
+ shortcode_globs: ["/emoji/custom/**/*.png"],
+ groups: [
+ "Finmoji special": "/finmoji/128px/a_trusted_friend-128.png", # special file
+ "Cirno": "/emoji/custom/cirno*.png", # png files in /emoji/custom/ which start with `cirno`
+ "Special group": "/emoji/custom/special_folder/*.png", # png files in /emoji/custom/special_folder/
+ "Another group": "/emoji/custom/special_folder/*/.png", # png files in /emoji/custom/special_folder/ subfolders
+ Finmoji: "/finmoji/128px/*-128.png",
+ Custom: ["/emoji/*.png", "/emoji/custom/*.png"]
+ ]
+```
+
+Priority of tags assigns in emoji.txt and custom.txt:
+
+`tag in file > special group setting in config.exs > default setting in config.exs`
+
+Priority for globs:
+
+`special group setting in config.exs > default setting in config.exs`