AkkomaGang/akkoma
AkkomaGang
/
akkoma
12
63
Fork 83
Code Issues 166 Pull Requests 14 Packages Projects 2 Releases 13 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
timorl commented 2022-12-11 10:38:50 +00:00
Contributor
Copy Link

I managed to steal some emoji, but I had to figure out the specifics the hard way. This should make it easier for future criminals.

Feel free to close if this documentation was omitted on purpose, I can imagine some reasons for why it might have.

I managed to steal some emoji, but I had to figure out the specifics the hard way. This should make it easier for future criminals. Feel free to close if this documentation was omitted on purpose, I can imagine some reasons for why it might have.
timorl force-pushed cinnamon-hate from 5360ad1f61 to fa9c7eae56 2022-12-13 11:43:34 +00:00 Compare
floatingghost reviewed 2022-12-14 12:54:03 +00:00
floatingghost left a comment
Owner
Copy Link

a few nits to pick

a few nits to pick
docs/docs/configuration/custom_emoji.md Outdated
@ -70,0 +72,4 @@
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 to automatically add to your instance emoji that massages 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
Owner
Copy Link

typo, messages

typo, messages
timorl commented 2022-12-14 20:14:44 +00:00
Author
Contributor
Copy Link

Fixed.

Fixed.
docs/docs/configuration/custom_emoji.md Outdated
@ -70,0 +74,4 @@
You can use the `Pleroma.Web.ActivityPub.MRF.StealEmojiPolicy` Message Rewrite Facility to automatically add to your instance emoji that massages 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.
To activate this you have to configure it in your configuration file (`prod.secret.exs` or `dev.secret.exs`). For example if you wanted to steal from `coolemoji.space` and `spiceenthusiasts.biz` any emoji that is not related to cinnamon and not larger than about 10K you would add the following:
floatingghost commented 2022-12-14 12:51:46 +00:00
Owner
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
Author
Contributor
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.
docs/docs/configuration/custom_emoji.md Outdated
@ -70,0 +92,4 @@
size_limit: 10000
```
Note that this _might_ actually be illegal in some ways, due to emoji pack licensing. 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
Owner
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
Author
Contributor
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
First-time contributor
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
Author
Contributor
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?
timorl added 1 commit 2022-12-14 20:12:29 +00:00
timorl force-pushed cinnamon-hate from 0b3ccf9147 to 393e0c481e 2022-12-14 20:13:42 +00:00 Compare
timorl added 1 commit 2022-12-16 17:00:44 +00:00
ci/woodpecker/pr/woodpecker Pipeline is pending Details
376fb2609a
Merge branch 'develop' into cinnamon-hate
timorl added 1 commit 2022-12-16 18:43:36 +00:00
ci/woodpecker/pr/woodpecker Pipeline is pending Details
af2c3d6e1e
Merge branch 'develop' into cinnamon-hate
floatingghost commented 2022-12-30 02:58:02 +00:00
Owner
Copy Link

seems fine currently, thanks~

seems fine currently, thanks~
floatingghost merged commit bca1c43dcb into develop 2022-12-30 02:58:07 +00:00
floatingghost deleted branch cinnamon-hate 2022-12-30 02:58:07 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
approved, awaiting change

   
bug

Something is not working

  
configuration

This requires config changes

  
documentation

This is about human-readable docs

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
extremely low priority

   
feature request

Something new?

  
Fix it yourself

Support has been attempted

  
help wanted

Need some help

  
invalid

Something is wrong

  
mastodon_api

   
needs docs

   
needs tests

   
not a bug

   
planned

   
pleroma_api

   
privacy

   
question

More information is needed

  
static_fe

   
triage

   
wontfix

This won't be fixed

No Label
approved, awaiting change
bug
configuration
documentation
duplicate
enhancement
extremely low priority
feature request
Fix it yourself
help wanted
invalid
mastodon_api
needs docs
needs tests
not a bug
planned
pleroma_api
privacy
question
static_fe
triage
wontfix
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: AkkomaGang/akkoma#364
No description provided.
Delete Branch "timorl/akkoma:cinnamon-hate"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?