Bloom player

[nikkuAg]

Summary

Added a new plugin for bloom format files and created a runner in the hashi to render bloom files in the iframe client.

Version 1: https://github.com/user-attachments/assets/1d1d73f8-b685-4acd-a68a-0a03ae7657cc

Version 2: https://github.com/user-attachments/assets/2eb5ffc8-b47e-42e5-9b96-22a0b2b58882

Version 3:

https://github.com/user-attachments/assets/035c554b-7158-4d20-911f-69d64a4ebe12

https://github.com/user-attachments/assets/46c15024-adb6-402d-b068-ab60e7121f11

…

References

#12237 #36 #12531 …

Reviewer guidance

…

---

Testing checklist

• [ ] Contributor has fully tested the PR manually
• [ ] If there are any front-end changes, before/after screenshots are included
• [ ] Critical user journeys are covered by Gherkin stories
• [ ] Critical and brittle code paths are covered by unit tests

PR process

• [ ] PR has the correct target branch and milestone
• [ ] PR has 'needs review' or 'work-in-progress' label
• [ ] If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
• [ ] If this is an important user-facing change, PR or related issue has a 'changelog' label
• [ ] If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

• Automated test coverage is satisfactory
• PR is fully functional
• PR has been tested for accessibility regressions
• External dependency files were updated if necessary (yarn and pip)
• Documentation is updated
• Contributor is in AUTHORS.md

[github-actions[bot]]

Build Artifacts

Asset type	Download link
PEX file	kolibri-0.18.0.dev0_git.20240925091145.pex
Windows Installer (EXE)	kolibri-0.18.0.dev0+git.20240925091145-windows-setup-unsigned.exe
Debian Package	kolibri_0.18.0.dev0+git.20240925091145-0ubuntu1_all.deb
Mac Installer (DMG)	kolibri-0.18.0.dev0+git.20240925091145.dmg
Android Package (APK)	kolibri-0.18.0.dev0+git.20240925091145-0.1.4-debug.apk
TAR file	kolibri-0.18.0.dev0+git.20240925091145.tar.gz
WHL file	kolibri-0.18.0.dev0+git.20240925091145-py2.py3-none-any.whl

[nikkuAg]

Now we can save the progress for bloom format files using the pages viewed https://github.com/user-attachments/assets/6915805d-e668-4712-b171-8b92b9abc978

[rtibbles]

This currently adds no new JS dependencies, so I would suggest reverting any changes to the yarn.lock file - this will also mean that you don't have conflicts any more.

[pcenov]

Hi @rtibbles - the player in its current implementation is functioning in a sense that I was able to open and play the downloaded bloompub files. As potential follow-up issues I would mention the following:

1. Missing table of contents menu
2. Missing text decrease/increase and theme color settings
3. Missing search option
4. The fullscreen option within the player is duplicating the Enter fullscreen option above it
5. The selection effect of the left and right arrows is unnecessary large
6. There's no option to view 2 pages side by side
7. When comparing a bloompub file with the corresponding epub file sometimes the images or parts of the text are missing

[rtibbles]

Hi @pcenov,

I am guessing some of this is by comparison against the EPub renderer in Kolibri - in chatting with @nikkuAg, it seems that some of these may be limitations of the underlying Bloom Player software (although we may be able to address them).

This seems to be something that shows on a per book basis and has to be defined for the specific book, we think:

1. Missing table of contents menu

It doesn't seem that Bloom Player currently supports these, so would have to be filed as potential enhancements for the future: 2. Missing text decrease/increase and theme color settings 3. Missing search option 6. There's no option to view 2 pages side by side

We can make follow up issues to fix these in Kolibri: 4. The fullscreen option within the player is duplicating the Enter fullscreen option above it (this is directly configurable in the Bloom Player, so we can just turn it off there) 7. When comparing a bloompub file with the corresponding epub file sometimes the images or parts of the text are missing

This would probably need to be fixed in our fork of Bloom Player, but we can track the issue in Kolibri: 5. The selection effect of the left and right arrows is unnecessary large