# Epub Player

Please refer to the github readme document.

{% embed url="<https://github.com/project-sunbird/sunbird-epub-player/tree/main#readme>" %}

### System Requirements <a href="#system-requirements" id="system-requirements"></a>

To install Epub player, ensure that your laptop or desktop has the following minimum system requirements:

* Operating System: Windows 7 and above, or 4.2 Mac OS X 10.0 and above/Linux
* RAM: >1.5GB
* CPU: 2 cores, >2 GHz

### Configuration

Player need some config that needs to be pass to the player as input , below listed out sample player config and mock player input config data

* Please check sample player config in below link\
  <https://github.com/project-sunbird/sunbird-epub-player#player-config><br>
* Please check in below link for mock player input config data\
  <https://github.com/project-sunbird/sunbird-epub-player/blob/main/src/app/data.ts>

### Sample code for references

* **Angular** \
  Refer sample code for Angular  [here](https://github.com/project-sunbird/sunbird-epub-player)<br>
* Web component \
  Refer sample code for Web component  [here](https://github.com/project-sunbird/sunbird-epub-player/blob/main/web-component/index.html)

### How to set up

* **As a  Web component** \
  For set up as web  component in plain javascript projects please follow the  [link](https://github.com/project-sunbird/sunbird-epub-player/tree/release-5.3.0#use-as-web-components)<br>
* **As a  Web component in angular app**\
  For set up as web  component in angular  projects please follow the  [link](https://github.com/project-sunbird/sunbird-epub-player/tree/release-5.3.0#use-as-web-components)<br>
* **As a  Web component in mobile app**\
  For set up as web  component in mobile app  projects please follow the  [link](https://github.com/project-sunbird/sunbird-epub-player/tree/release-5.3.0#use-as-web-component-in-mobile-app)<br>
* **As a  Angular library in angular app**\
  For set up as angular library in angular  projects please follow the  [link](https://github.com/project-sunbird/sunbird-epub-player/tree/release-5.3.0#use-as-web-components)<br>
* **As a  Angular library in mobile app**\
  For set up as angular library in  mobile app projects please follow the  [link](https://github.com/project-sunbird/sunbird-epub-player/tree/release-5.3.0#use-as-angular-library-in-mobile-app)

### External Dependencies

#### [Sunbird Telemetry](https://telemetry.sunbird.org/)

Sunbird Telemetry is a specification to instrument all the key events. Using this specification reference applications & services will generate telemetry events.

####


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://knowlg.sunbird.org/use/installation-guide/players/v2/epub-player.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.