Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

iTerm2 image protocol support #48

Closed
11 tasks done
AnonymouX47 opened this issue Jun 4, 2022 · 13 comments · Fixed by #55
Closed
11 tasks done

iTerm2 image protocol support #48

AnonymouX47 opened this issue Jun 4, 2022 · 13 comments · Fixed by #55
Labels
cli Related to the image viewer's CLI (Not to be used anymore) enhancement New feature / Improvement suggestion or request iterm2 Related to the 'iterm2' render style lib Related to the library (Not to be used anymore) test Related to the test suite tui Related to the image viewer's TUI (Not to be used anymore)
Milestone

Comments

@AnonymouX47
Copy link
Owner

AnonymouX47 commented Jun 4, 2022

A branch off #23

Tested terminal emulators:

  • iTerm2
  • WezTerm
  • Konsole >= 22.04.0
    • Currently doesn't support native animations but the normal method used across all styles works excellently.

All functionalities work properly across all terminals except stated otherwise.

Progress:

  • Sizing
  • Rendering
    • Line-by-line
    • Whole image
  • Transparency
  • Formatting
  • Animation
  • CLI Integration
  • TUI Integration
  • Tests

Specific protocol features already or to be in use:

  • Native animation
@AnonymouX47 AnonymouX47 added documentation Improvements or additions to documentation enhancement New feature / Improvement suggestion or request lib Related to the library (Not to be used anymore) cli Related to the image viewer's CLI (Not to be used anymore) labels Jun 4, 2022
@AnonymouX47 AnonymouX47 added this to the 0.4.0 milestone Jun 4, 2022
@AnonymouX47 AnonymouX47 changed the title Iterm2 image protocol support iTerm2 image protocol support Jun 8, 2022
@AnonymouX47
Copy link
Owner Author

AnonymouX47 commented Jun 9, 2022

@paw-lu @leo-arch

Just tests left to go... You can check #50 for progress.

@leo-arch
Copy link

leo-arch commented Jun 9, 2022

Hi @AnonymouX47. No Mac here.

@AnonymouX47
Copy link
Owner Author

Tested on iTerm2... the only quirk was that drawing line-by-line is extremely slow due to the terminal's performance.

I'll mention it in the docs and set the whole render method to be used instead, wherever possible.

@AnonymouX47
Copy link
Owner Author

AnonymouX47 commented Jun 9, 2022

Hi @AnonymouX47. No Mac here.

Yeah, about that... I just got my hands on one over here 😃
Thanks.

@leo-arch
Copy link

leo-arch commented Jun 9, 2022

That was fast!

@AnonymouX47
Copy link
Owner Author

AnonymouX47 commented Jun 9, 2022

I'm releasing the next version (0.4.0) on the 14th of this month.
I should've completed the support for the graphics protocols but wherever it gets, I'll release it.

@AnonymouX47 AnonymouX47 added tui Related to the image viewer's TUI (Not to be used anymore) test Related to the test suite and removed documentation Improvements or additions to documentation labels Jun 13, 2022
@AnonymouX47 AnonymouX47 added the iterm2 Related to the 'iterm2' render style label Jun 23, 2022
@AnonymouX47
Copy link
Owner Author

Finally!

By the way, I found out that mintty (on Windows) implements this protocol... I've only given it a short try so far with no luck yet but as soon as I work it out, I'll add mintty to the supported terminal emulators.
There's also hterm but I'm less interested based on what I've read about it's implementation... the terminal emulator is not as widely used after all.

@AnonymouX47
Copy link
Owner Author

@Sam-Cleveland
Please, will you be able to help test on iTerm2?
You would have to clone and install from the main branch.

@Sam-Cleveland
Copy link

make test-iterm2 failed. Here's the output
log.txt

@AnonymouX47
Copy link
Owner Author

AnonymouX47 commented Jun 23, 2022

Thanks.

I noticed your local main branch is not up to date... i just merged #55 a few hours ago.

Also, among the output you sent is this:

.../tests/test_iterm2.py:15: PytestUnknownMarkWarning: Unknown pytest.mark.order - is this a typo? You can register custom marks to avoid this warning - for details, see https://docs.pytest.org/en/stable/how-to/mark.html @pytest.mark.order("first")

This shows that the pytest-order package is not installed.
Run:

make requires

OR

pip install --upgrade -r requirements.txt

Thanks :)

@AnonymouX47
Copy link
Owner Author

AnonymouX47 commented Jun 23, 2022

Also, I should note that the tests are independent of the terminal emulator they're running on.

What I actually meant by "test" earlier is more about using it to displaying images to see if it works as expected. :)

@AnonymouX47
Copy link
Owner Author

What I actually meant by "test" earlier is more about using it to displaying images to see if it works as expected. :)

@Sam-Cleveland, anything so far? :)

@AnonymouX47
Copy link
Owner Author

Finally 🥲, v0.4.0 is up!

Sorry, I couldn't meet up with the date I originally mentioned due to some difficulties.
I actually considered releasing it as it was then but I think the wait was worth it, with the amount of things that happened between then and now 😃.

Anyways... I've learnt to avoid dates henceforth 🌚😆, as so many things compete for my time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Related to the image viewer's CLI (Not to be used anymore) enhancement New feature / Improvement suggestion or request iterm2 Related to the 'iterm2' render style lib Related to the library (Not to be used anymore) test Related to the test suite tui Related to the image viewer's TUI (Not to be used anymore)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants