{"id":13760973,"url":"https://github.com/readbeyond/minstrel","last_synced_at":"2025-08-04T17:48:05.745Z","repository":{"id":32442431,"uuid":"36020692","full_name":"readbeyond/minstrel","owner":"readbeyond","description":"Minstrel is a FLOSS hybrid reading app specifically designed for Audio-eBooks","archived":false,"fork":false,"pushed_at":"2016-11-10T12:18:18.000Z","size":5153,"stargazers_count":96,"open_issues_count":2,"forks_count":21,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-03-30T13:34:07.741Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/readbeyond.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-05-21T15:23:55.000Z","updated_at":"2024-11-16T07:14:51.000Z","dependencies_parsed_at":"2022-07-22T08:22:11.689Z","dependency_job_id":null,"html_url":"https://github.com/readbeyond/minstrel","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readbeyond%2Fminstrel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readbeyond%2Fminstrel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readbeyond%2Fminstrel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readbeyond%2Fminstrel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/readbeyond","download_url":"https://codeload.github.com/readbeyond/minstrel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251653037,"owners_count":21622060,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T13:01:30.146Z","updated_at":"2025-04-30T06:26:14.709Z","avatar_url":"https://github.com/readbeyond.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Minstrel \n\n**Minstrel** is a FLOSS hybrid reading app specifically designed for Audio-eBooks\n\n* Version: 3.0.1\n* Date: 2015-05-21\n* Developed by: [ReadBeyond][rb]\n* Lead Developer: [Alberto Pettarin][ap]\n* License: the MIT License (MIT)\n* Web Page: [Minstrel][webpage]\n* Contact: [minstrel@readbeyond.it](mailto:minstrel@readbeyond.it)\n\n## Installing the App\n\nIf you just want to install the app on your phone/tablet,\nyou can download [**Menestrello**][menestrello],\nthe official stable release of **Minstrel**\nmaintained by ReadBeyond, using:\n\n1. [App Store][appstore] (iPhone/iPad)\n2. [Google Play][googleplay] (Android devices)\n3. [Android APK][apk] (Android devices, manual installation)\n\n\n## Developing the App\n\n### System Requirements\n\n1. [Android SDK][androidsdk] (Android) and/or [Xcode][xcode] (iOS)\n2. [Apache Cordova 5.0.0][cordova]\n\nIf you want to build the Android APK from command line,\nmake sure the Android SDK is in your `$PATH`\nso that `cordova` can run it.\n\n### Installation\n\n1. Clone the GitHub repository and enter the `cordova` directory:\n    \n    ```bash\n    $ git clone https://github.com/readbeyond/minstrel.git\n    $ cd minstrel/cordova\n    ```\n\n2. Create the Cordova project directory:\n   \n    ```bash\n    $ bash create_minstrel.sh\n    or\n    $ bash create_minstrel.sh android\n    $ bash create_minstrel.sh ios\n    ```\n\n   The first command will create both versions of the app,\n   the last two commands will create only the specified version.\n\n3. Build the Android version:\n    \n    ```bash\n    $ cd minstrel/\n    $ bash build.sh\n    ```\n\n    will build the app and copy the generated APK into `/tmp/`.\n\n4. Build the iOS version:\n\n    ```bash\n    $ open minstrel/platforms/ios/Minstrel.xcodeproj\n    ```\n    \n    will open the generated project in Xcode.\n\n\n## Documentation\n\nBasically, all you have is\n[the official Web page][webpage]\nof the project and\nthe comments in the source code.\n\nUnfortunately, at the moment\nwe do not have enough resources\nfor properly documenting this project.\nYou can help us by \n[sponsoring this project](#supporting).\n\n\n## Features\n\n* Supported formats: EPUB 2, EPUB 3 (reflowable and pre-paginated), CBZ, ABZ (more can be added easily)\n* Multilingual UI: EN, IT, DA, FR, DE, PL, ES, TR\n* Import documents from: browser, Download Manager, Notifications, or the file system (Android); Safari and iTunes (iOS)\n* Library sorted by: author, title, narrator, duration, language, series, or recently open\n* Library titles can be filtered\n* Display book metadata\n* Reading settings saved per book, and globally customizable defaults\n* Night mode, customizable colors, orientation lock, screen brightness\n* Several reading fonts, including OpenDyslexic and TestMe fonts for dyslexic people\n* Customizable touch zones\n* Incremental unzipping of assets\n* Nearly complete support for EPUB 3 Media Overlays (aka SMIL or read aloud)\n* Tap-text-to-play-it, synchronous highlighting, autoscroll\n* Keep playing audio while the app is in background\n* Adjustable playback speed with rate-vs-pitch correction (0.5x-2.0x)\n* Smart footnotes\n* Image zooming\n* Support for non linear contents\n* Ignore book CSS, user-provided CSS overrules\n* Enable/disable Javascript execution\n* Presentation mode and image info in CBZ, M3U support in ABZ\n\n\n## Limitations/Missing Features/TODO List\n\n* Full text search, search in Google/Wikipedia/etc.\n* Dictionary/vocabulary building\n* Annotations/highlighting/bookmarks\n* Asset drawers/extraction, e.g. image collection\n* Sharing\n* Cloud/personal server integration\n* Downloading documents directly inside the app\n* User-provided fonts\n* UI for allowing the user to modify the book CSS on the fly (and save it)\n* OPDS support\n* EPUB parsing takes shortcuts here and there\n* EPUB rendering should happen in its own `\u003ciframe\u003e` (=\u003e no monkey patching)\n* Better pagination, especially in Android\n* Progress indicators of some sort\n* Support for facing FXL pages\n* Support for parallel texts, e.g. via EPUB 3 Multiple Renditions\n* Split screens and other panels\n* Document metadata page should show TOC/assets preview\n* Reading metadata from ID3 tags of MP3 files\n* Streaming audio from a remote server\n* More robust unzipping, e.g. checking for the required space, etc.\n* JS code should be refactored, e.g. using a sane framework\n* User-provided localization, e.g. via PO files\n* User manual/tutorial\n* UI/UX could be drastically improved\n* Accessibility testing\n* Formal testing\n\n\n## Supporting and Contributing\n\n### Supporting\n\nWould you like supporting the development of **Minstrel**?\n\nWe are open to accept sponsorships to\n\n* fix bugs,\n* add new features,\n* improve the quality and the performance of the code,\n* support other platforms (e.g., Web or Windows Phone),\n* acquire devices for testing purposes,\n* hire an accessibility expert to make the app accessible,\n* hire an UI designer to redesign the app, and\n* improve the documentation.\n\nFeel free to [get in touch](mailto:minstrel@readbeyond.it).\n\n### Contributing\n\nIf you are able to contribute code directly,\nthat's great!\nFeel free to open a pull request,\nwe will be glad to have a look at it.\n\nPlease make your code consistent with\nthe existing code base style\nand test your contributed code\nbefore opening the pull request.\n\nCreate a new branch (e.g., `myfeature`)\nfor each logically-independent feature\nyou want to contribute.\n\nAny contribution adding or altering\nthe JS/native plugin interfaces\nmust work for both Android and iOS\nbefore the contribution can be merged\ninto the master branch of the app.\nThis policy ensures that both platforms\nare supported and have the same features\nat any given time.\nImprovements to the existing native plugins\nthat do not alter the JS/native interfaces\nare not subject to this rule.\n\n**Please note that, by opening a pull request,\nyou automatically agree to apply\nthe MIT license\nto the code you contribute.**\n\nIf you think you found a bug,\nplease use the\n[GitHub issue tracker](https://github.com/readbeyond/minstrel/issues)\nto file a bug report.\n\n\n## Legal Information\n\n### License\n\n**Minstrel** is released under the terms of the MIT License (MIT).\nSee the [LICENSE](LICENSE) file for details.\n\n\n### Privacy Policy\n\nWe value your privacy as much as we value ours.\nReadBeyond does not collect any data about your eBooks,\nreading preferences, or reading statistics.\nOn Android, the Network connection permission is requested solely\nbecause Minstrel uses a WebView (\"in-app browser\") to render the eBooks,\nhowever the app does not send data to nor receive data from the Internet,\nexcept for downloading a file when the user selects\n\"Open with Minstrel\" in the browser.\n\n\n### Font Licenses\n\n#### Amaranth\n\nCopyright © 2011, Gesine Todt (hallo@gesine-todt.de), with Reserved Font Name Amaranth. This Font Software is licensed under the SIL Open Font License, Version 1.1.\n\nWeb: [http://scripts.sil.org/OFL][sil_ofl_fonts]\n\n\n#### Andika\n\nCopyright © 2004-2011, SIL International (http://scripts.sil.org), with Reserved Font Names 'Andika' and 'SIL'. This Font Software is licensed under the SIL Open Font License, Version 1.1.\n\nWeb: [http://scripts.sil.org/OFL][sil_ofl_fonts]\n\n\n#### Avería Serif\n\nCopyright © 2011, Dan Sayers (i@iotic.com), with Reserved Font Name Avería Serif. This Font Software is licensed under the SIL Open Font License, Version 1.1.\n\nWeb: [http://scripts.sil.org/OFL][sil_ofl_fonts]\n\n\n#### Charis SIL\n\nThis Font Software is Copyright © 1997-2011, SIL International (http://scripts.sil.org/) with Reserved Font Names \"Charis\" and \"SIL\". This Font Software is licensed under the SIL Open Font License, Version 1.1.\n\nWeb: [http://scripts.sil.org/OFL][sil_ofl_fonts]\n\n\n#### Font Awesome\n\nCopyright © 2014, Dave Gandy (http://fontawesome.io), with Reserved Font Name Font Awesome. This Font Software is licensed under the SIL Open Font License, Version 1.1.\n\nWeb: [http://scripts.sil.org/OFL][sil_ofl_fonts]\n\n\n#### Gentium\n\nCopyright © 2003-2008, SIL International (http://scripts.sil.org), with Reserved Font Names \"Gentium\" and \"SIL\". This Font Software is licensed under the SIL Open Font License, Version 1.1.\n\nWeb: [http://scripts.sil.org/OFL][sil_ofl_fonts]\n\n\n#### EB Garamond\n\nCopyright © 2010, 2011, 2012 Georg Duffner (http://www.georgduffner.at). This Font Software is licensed under the SIL Open Font License, Version 1.1.\n\nWeb: [http://scripts.sil.org/OFL][sil_ofl_fonts]\n\n\n#### OpenDyslexic Font\n\nCopying is an act of love. Please copy. OpenDyslexic(open-dyslexic) by Abelardo Gonzalez is licensed under a Creative Commons Attribution 3.0 Unported License. Based on a work at dyslexicfonts.com.\n\nWeb: [http://opendyslexic.org/][open_dyslexic_font]\n\n\n#### Roboto\n\nCopyright © 2012 Christian Robertson (https://plus.google.com/110879635926653430880/about). This Font Software is licensed under the Apache License, Version 2.0.\n\nWeb: [http://www.google.com/fonts/specimen/Roboto][roboto]\n\n\n#### TestMe\n\nCopyright © 2013 Luciano Perondi (www.synsemia.org|molotro@gmail.com). Derived from Titillium Copyright © 2008-2010, Accademia di Belle Arti di Urbino (www.campivisivi.net|direzione@accademiadiurbino.it), with Reserved Font Name TestMe. This Font Software is licensed under the SIL Open Font License, Version 1.1.\n\nWeb: [http://scripts.sil.org/OFL][sil_ofl_fonts]\n\n\n#### Volkhov\n\nCopyright © 2011, Cyreal (www.cyreal.org), with Reserved Font Name \"Volkhov\". This Font Software is licensed under the SIL Open Font License, Version 1.1.\n\nWeb: [http://scripts.sil.org/OFL][sil_ofl_fonts]\n\n\n### Third-Party Licenses and Trademarks\n\n#### Apache Cordova\n\nThis app has been compiled using `Apache Cordova 5.0.0` by the Apache Software Foundation, released under the terms of the Apache License, Version 2.0.\n\nWeb: [http://cordova.apache.org/][cordova]\n\n#### cssbeautify.js\n\nThis app includes `cssbeautify.js` code by Ariya Hidayat (Sencha Inc.), released under the terms of the MIT License.\n\nWeb: [http://cssbeautify.com/][cssbeautify]\n\n#### EPUB\n\n`EPUB` is a registered trademark of the International Digital Publishing Forum (IDPF).\n\nWeb: [http://idpf.org/][epub]\n\n#### Hammer.js\n\nThis app includes `Hammer.js` code by Jorik Tangelder, released under the terms of the MIT License.\n\nWeb: [https://github.com/EightMedia/hammer.js][hammer]\n\n#### jQuery\n\nThis app includes `jQuery 1.9.1` code by the jQuery Foundation, released under the terms of the MIT License.\n\nWeb: [https://jquery.org/][jquery]\n\n#### jQuery Mobile\n\nThis app includes `jQuery Mobile` code by the jQuery Foundation, released under the terms of the MIT License.\n\nWeb: [http://jquerymobile.com/][jquerymobile]\n\n#### nativeDroid\n\nThe UI theme is `nativeDroid` by Raphael Wildhaber.\n\nWeb: [http://nativedroid.godesign.ch/][nativedroid]\n          \n#### Objective-Zip\n\nOn iOS, this app uses the `Objective-Zip` wrapper for Zlib and MiniZip, released under the terms of the New BSD License.\n\nWeb: [https://github.com/flyingdolphinstudio/Objective-Zip][objective_zip]\n          \n#### Sonic Library \n\nOn Android, this app uses the `Sonic Library` by Bill Cox, released under the terms of the GNU Lesser General Public Licensee 2.1.\n\nWeb: [http://dev.vinux-project.org/sonic/][sonic]\n\n#### sprintf.js \n\nThis app includes `sprintf.js` code by Ash Searle, released under the terms of the \"This code is unrestricted: you are free to use it however you like.\" license.\n\n\n\n\n## Acknowledgments\n\n* Antonio Tombolini and the technical staff of Simplicissimus Book Farm provided many useful comments.\n* Marta D'Asaro designed the icon.\n* Iacopo Balocco suggested embedding the OpenDyslexic font.\n* Carlo Fantozzi and Nicola Zago suggested several UI enhancements.\n* Several users of the SBF forum provided precious feedback.\n* Marco Iannacone suggested embedding the TestMe font.\n* Fabrizio Venerandi inspired the EPUB reader options for dealing with non linear spine items.\n\n[rb]: http://www.readbeyond.it/\n[ap]: http://www.albertopettarin.it/\n[webpage]: http://www.readbeyond.it/minstrel/\n[appstore]: https://itunes.apple.com/us/app/menestrello/id771746561\n[googleplay]: https://play.google.com/store/apps/details?id=it.readbeyond.menestrello\n[menestrello]: http://www.readbeyond.it/menestrello/\n[apk]: http://www.readbeyond.it/menestrello/\n[androidsdk]: https://developer.android.com/sdk/\n[xcode]: https://developer.apple.com/xcode/\n[cordova]: http://cordova.apache.org/\n[cssbeautify]: http://cssbeautify.com/\n[epub]: http://idpf.org/\n[hammer]: https://github.com/EightMedia/hammer.js\n[jquery]: https://jquery.org/\n[jquerymobile]: http://jquerymobile.com/\n[nativedroid]: http://nativedroid.godesign.ch/\n[objective_zip]: https://github.com/flyingdolphinstudio/Objective-Zip\n[open_dyslexic_font]: http://opendyslexic.org/\n[roboto]: http://www.google.com/fonts/specimen/Roboto\n[sil_ofl_fonts]: http://scripts.sil.org/OFL\n[sonic]: http://dev.vinux-project.org/sonic/\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadbeyond%2Fminstrel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freadbeyond%2Fminstrel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadbeyond%2Fminstrel/lists"}