AkkomaGang/akkoma
AkkomaGang/akkoma
16
67
Fork 93
Code Issues 176 Pull requests 16 Projects 2 Releases 16 Packages Wiki Activity

Add docs about emoji stealing #364

Merged
floatingghost merged 5 commits from timorl/akkoma:cinnamon-hate into develop 2022-12-30 02:58:07 +00:00
Conversation 1 Commits 5 Files changed 1 +26
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/docs/configuration/custom_emoji.md
View file

@ -67,3 +67,29 @@ Priority of tags assigns in emoji.txt and custom.txt:
Priority for globs:
`special group setting in config.exs > default setting in config.exs`
## Stealing emoji
Managing your emoji can be hard work, and you just want to have the cool emoji your friends use? As usual, crime comes to the rescue!
You can use the `Pleroma.Web.ActivityPub.MRF.StealEmojiPolicy` [Message Rewrite Facility](../configuration/cheatsheet.md#mrf) to automatically add to your instance emoji that messages from specific servers contain. Note that this happens on message processing, so the emoji will be added only after your instance receives some interaction containing emoji _after_ configuring this.
floatingghost commented 2022-12-14 12:50:57 +00:00
Outdated
Review
Copy link

typo, messages

typo, messages
timorl commented 2022-12-14 20:14:44 +00:00
Outdated
Review
Copy link

Fixed.

Fixed.
To activate this you have to [configure](../configuration/cheatsheet.md#mrf_steal_emoji) it in your configuration file. For example if you wanted to steal any emoji that is not related to cinnamon and not larger than about 10K from `coolemoji.space` and `spiceenthusiasts.biz`, you would add the following:
floatingghost commented 2022-12-14 12:51:46 +00:00
Outdated
Review
Copy link

two things

first, missing a comma here

`coolemoji.space` and `spiceenthusiasts.biz`*,* any emoji

second, can you link to /configuration/cheatsheet/#mrf_steal_emoji instead of mentioning the file by name? OTP users will have a different file and so on

two things first, missing a comma here ``` `coolemoji.space` and `spiceenthusiasts.biz`*,* any emoji ``` second, can you link to `/configuration/cheatsheet/#mrf_steal_emoji` instead of mentioning the file by name? OTP users will have a different file and so on
timorl commented 2022-12-14 20:17:04 +00:00
Outdated
Review
Copy link

Ugh, the comma made me doubt the whole sentence was well-structured, so I reorganized it, maybe it's better now? Maybe it still needs commas somewhere?

I linked there and to the general section about MRF, but neither actually mentions where the config should go (although it is pretty easy to figure out :P). Also fyi, this same file higher up mentions both these files in the exact same way.

Ugh, the comma made me doubt the whole sentence was well-structured, so I reorganized it, maybe it's better now? Maybe it still needs commas somewhere? I linked there and to the general section about MRF, but neither actually mentions where the config should go (although it is pretty easy to figure out :P). Also fyi, this same file higher up mentions both these files in the exact same way.
```elixir
config :pleroma, :mrf,
policies: [
Pleroma.Web.ActivityPub.MRF.StealEmojiPolicy
]
config :pleroma, :mrf_steal_emoji,
hosts: [
"coolemoji.space",
"spiceenthusiasts.biz"
],
rejected_shortcodes: [
".*cinnamon.*"
],
size_limit: 10000
```
Note that this may not obey emoji licensing restrictions. It's extremely unlikely that anyone will care, but keep this in mind for when Nintendo starts their own instance.
floatingghost commented 2022-12-14 12:53:57 +00:00
Outdated
Review
Copy link

probably best not to insinuate illegality, just a "this may not obey emoji licensing restrictions" should be sufficient

probably best not to insinuate illegality, just a "this may not obey emoji licensing restrictions" should be sufficient
timorl commented 2022-12-14 20:18:21 +00:00
Outdated
Review
Copy link

Changed, but left the Nintendo ""joke"", I hope this is fine.

Changed, but left the Nintendo ""joke"", I hope this is fine.
Ghost commented 2022-12-14 20:54:27 +00:00
Outdated
Review
Copy link

It might be preferable to keep the documentation strictly related to Akkoma.

It might be preferable to keep the documentation strictly related to Akkoma.
timorl commented 2022-12-15 06:16:16 +00:00
Outdated
Review
Copy link

As in "don't write docs for emoji stealing at all, because that's just an MRF" or "keep the docs serious"? For the latter I should probably rewrite more parts of this PR than just the Nintendo thing. Or did you mean something else entirely?

As in "don't write docs for emoji stealing at all, because that's just an MRF" or "keep the docs serious"? For the latter I should probably rewrite more parts of this PR than just the Nintendo thing. Or did you mean something else entirely?