alyssa
/
pleroma
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
pleroma/docs/config/custom_emoji.md

54 lines
1.8 KiB
Markdown
Raw Normal View History

Move out of Gitlab Wiki I understand that this change is quite unreadable and hard to review, sorry for forgetting to do atomic commits. This patch does not change too much content wise, it just * Gets everything from gitlab wiki * Removes some specific gitlab hacks * Formats all documentation file names to be in snake case so they look the same way as our code does
2019-03-28 16:46:30 +00:00
# Custom Emoji
Fix headers and add !929 docs to extras [ci skip]
2019-03-15 09:58:15 +00:00
robots.txt Add default robots.txt that allows bots access to all paths. Add mix task to generate robots.txt taht allows bots access to no paths. Document custom emojis, MRF and static_dir static_dir documentation includes docs for the robots.txt Mix task.
2019-01-20 01:44:00 +00:00
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`:
```
Adding tag to emoji ets table changes in apis
2019-04-01 10:17:57 +00:00
happy, /emoji/custom/happy.png, Tag1,Tag2
sad, /emoji/custom/sad.png, Tag1
foo, /emoji/custom/foo.png
robots.txt Add default robots.txt that allows bots access to all paths. Add mix task to generate robots.txt taht allows bots access to no paths. Document custom emojis, MRF and static_dir static_dir documentation includes docs for the robots.txt Mix task.
2019-01-20 01:44:00 +00:00
```
The files should be PNG (APNG is okay with `.png` for `image/png` Content-type) and under 50kb for compatibility with mastodon.
Adding tag to emoji ets table changes in apis
2019-04-01 10:17:57 +00:00
updating custom_emoji docs
2019-04-02 08:57:57 +00:00
# Emoji tags (groups)
Adding tag to emoji ets table changes in apis
2019-04-01 10:17:57 +00:00
updating custom_emoji docs
2019-04-02 08:57:57 +00:00
Default tags are set in `config.exs`.
```
config :pleroma, :emoji,
shortcode_globs: ["/emoji/custom/**/*.png"],
groups: [
Finmoji: "/finmoji/128px/*-128.png",
Custom: ["/emoji/*.png", "/emoji/custom/*.png"]
]
```
Adding tag to emoji ets table changes in apis
2019-04-01 10:17:57 +00:00
updating custom_emoji docs
2019-04-02 08:57:57 +00:00
Order of the `groups` matters, so to override default tags just put your group on the top of the list. E.g:
Adding tag to emoji ets table changes in apis
2019-04-01 10:17:57 +00:00
```
config :pleroma, :emoji,
shortcode_globs: ["/emoji/custom/**/*.png"],
updating custom_emoji docs
2019-04-02 08:57:57 +00:00
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"]
]
Adding tag to emoji ets table changes in apis
2019-04-01 10:17:57 +00:00
```
updating custom_emoji docs
2019-04-02 08:57:57 +00:00
Priority of tag assign 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`