Acuity Flipbook

To keep this module exceptionally lightweight and ensure the fastest possible load times across the globe, Acuity Flipbook does not bundle heavy JavaScript libraries locally. Instead, it relies on secure, industry-standard Content Delivery Networks (CDNs):

• PDF.js (v3.11.174): Loaded via Cloudflare (cdnjs.cloudflare.com) to handle the heavy lifting of parsing the PDF and extracting the canvas data.
• StPageFlip: Loaded via jsDelivr (cdn.jsdelivr.net) to power the 3D physics, responsive scaling, and page-turning math.

(Note: Because these rendering engines are loaded via CDN, the end-user's browser requires an active internet connection to render the flipbook.)

Requirements:

• Backdrop CMS 1.x
• PHP 8+ (While the code may technically function with PHP 7.4 at this time, we strictly require PHP 8.0+ and will not address issues related to older PHP versions.)

Installation:

Install this module using the official Backdrop CMS instructions at https://docs.backdropcms.org/documentation/extend-with-modules

Enable the module.

Configuration

Simply add a standard File field to any content type (allowing .pdf extensions) and set the Manage Display formatter to Acuity 3D Flipbook (PDF). The module mathematically analyzes the native dimensions of the uploaded document and scales the two-page spread to perfectly fit your theme's layout column without breaking responsiveness.

Issues:

Bugs and Feature requests should be reported in the Issue Queue: https://github.com/backdrop-contrib/acuity_flipbook/issues

About the "Acuity" Name

"Acuity" is the name used to organise a collection of modules and utilities. These tools are grouped under a unified name to streamline installation and make it easier for site maintainers to identify these suite of solutions.

Technically, the namespaces acuity_ and abms_ were chosen to enhance code readability and keep function names simple and easy to type.

While part of this larger Acuity family, this module is a standalone utility.

Current Maintainer(s):

• Steve Moorhouse (albanycomputers) (https://github.com/albanycomputers)
• Seeking additional maintainers and contributors.

Credits:

• Steve Moorhouse - Zulip (DrAlbany)
• Google Gemini Pro 3.1 assisted with the coding of this module.

Sponsorship:

• Albany Computer Services (https://www.albany-computers.co.uk)
• Albany Web Design (https://www.albanywebdesign.co.uk)
• Albany Hosting (https://www.albany-hosting.co.uk)

License

This project is GPL v2 software. See the LICENSE.txt file in this directory for complete text.