andreaz98 commented 1 month ago

Using different colors to indicate the state of OMEMO messages

The main goal of this MarkDown is to organize the ideas for this feature that has the potential to become an interesting and useful feature for every profanity's user, IMHO. The chosen color must not cause eyestrain on long OMEMO chats sessions. I'll try to keep this document updated as I make progress in the development.

TODO list

[X] Understand how to implement the option /omemo colors on|off (default: off).
[X] Implement /omemo colors on|off.
[X] Understand how /save works, getting a light grasp of it is sufficient.
[ ] When /omemo colors on, implement sent OMEMO messages are white, received OMEMO messages are darker white.
[ ] Understand how to insert colors, on, and off in the autocompletion.
[ ] Based on the currently loaded theme, text of the received OMEMO messages will be a bit darker than the text for sent OMEMO messages.
[ ] /omemo colors reverse on|off: sent OMEMO messages will be a bit darker than the received OMEMO messages.
[ ] The user can set a color of her choice, e.g. /omemo colors set yellow for received OMEMO messages will be yellow regardless the loaded theme. If the /omemo colors reverse on is set, the sent OMEMO messages will be yellow.
[ ] Code is Ready for review

[ ] Support OMEMO colors on MUC. NOTE: profanity doesn't support OMEMO on MUCs yet.

Further ideas:

[ ] opaqueness of non-OMEMO messages. Text of non-OMEMO messages will result opaque to the eyes of the reader.

Not so sure about this one:

[ ] background color around OMEMO messages

DISCLAIMER

This is an open source project. This feature is not about me, it is about us. Please, feel free to contribute by sharing ideas, developing code, commenting etc. :)

jubalh commented 1 month ago

Hi! Thanks for your PR.

There won't be a need for the OMEMO-colors.md file. You can just have this as a comment here in the PR or having it in a GitHub issue in case you don't create a PR for a topic.

So I'll just leave this PR open and start reviewing once you set it to ready. Have fun coding! Keep in mind that the PR might or might not be merged based on the implementation and usefulness.

andreaz98 commented 1 month ago

Hi! Thanks for your PR.

There won't be a need for the OMEMO-colors.md file. You can just have this as a comment here in the PR or having it in a GitHub issue in case you don't create a PR for a topic.

So I'll just leave this PR open and start reviewing once you set it to ready. Have fun coding! Keep in mind that the PR might or might not be merged based on the implementation and usefulness.

Hi! I understand the PR might and might not be merged based upon implementation and usefulness :)

profanity-im / profanity