create-photo-flipbook-ui README

The project's README from github.com/HaichaoLihc/create-photo-flipbook-ui. As one markdown file: README.md.

Create Photo Flipbook UI

A Codex skill for turning photographs into expressive photobooks using the bundled 2D Book runtime (formerly v1) in assets/html/.

3D Book 2 demo

Templates

These templates live in examples/, outside the skill folder, and are optional resources for people to copy and customize. They are not installed with the skill. The skill uses its own bundled 2D runtime; Library and the 3D templates are separate alternatives.

Library 2D Book
Library with three mock books 2D Book with a sample photo spread
Reorderable shelf with three empty mock books. Reference example of the skill’s bundled 2D runtime.
3D Book 1 3D Book 2
3D Book 1 on a dark background 3D Book 2 on a light background
React and WebGL reader with curved pages and a dark stage. Three.js and Quick FlipBook reader with a light stage and soft shadows.

Install

python3 ~/.codex/skills/.system/skill-installer/scripts/install-skill-from-github.py \
  --repo HaichaoLihc/create-photo-flipbook-ui \
  --path skills/create-photo-flipbook-ui \
  --ref main

Use

Use $create-photo-flipbook-ui to turn these photographs into photobooks.

One workflow, three stages:

  1. Understand the photos: their form, content, and themes. Semantic search and contact sheets are available.
  2. Define the style and design: fulfill the user's request with a coherent, high-quality book. Pinterest, the photo-skill catalogue, and image generation are available. Without a preferred style, preserve the original photos and use the bundled default photobook style.
  3. Build the UI: present the book with the built-in 2D HTML runtime and deliver a working local URL.

The skill defines outcomes and provides tools. The agent chooses the process.

The default photobook style provides concise text guidance, Source Serif 4, paper and cloth textures, and reusable page styles in the bundled runtime. The starter contains no sample photographs.

Photo search and reusable code

The skill declares the existing photo-search MCP dependency for library search, ranked contact sheets, and larger previews. The MCP itself is read-only. The bundled scripts/photo_library.py adapter adds folder-specific cached indexes and semantic searches by reusing an installed photo-search engine's index.py and PhotoSearchEngine; it does not replace the connected MCP's global index.

Install the engine and its Python requirements separately, set PHOTO_SEARCH_ENGINE_DIR to its location, and use its Python interpreter. See Photo library setup and commands. Index caches remain outside the skill and source folders. New and changed images are embedded incrementally; unchanged images are reused. Search output includes a contact sheet and manifest, and selections retain stable IDs and original paths.

Reusable resources shipped with the skill include the photo-library adapter, ordered contact-sheet renderer, Pinterest helper, and 2D book runtime. Art direction and sequencing remain in workflow instructions. Model weights and photo libraries are not part of the skill package.

See each template’s README for local preview instructions.

Negative Sleeves is a separate, photo-free film archive UI with page-corner previews and draggable film strips. Import a local photo folder with its Python builder; generated books and photographs stay Git-ignored.

Validate

python3 tests/validate_repo.py

Evaluation guide.

License

Original project code and the installable skill are MIT licensed. Third-party components retain their own licenses. The adapted code in examples/3d-book-1/ and all photographs, videos, and other media are excluded unless expressly stated otherwise.

create-photo-flipbook-ui (HaichaoLihc/create-photo-flipbook-ui)

Searching Database…

What is this?A Codex skill that turns a folder of user photos into a working photobook website, using a bundled 2D HTML flipbook runtime plus optional 3D Three.js/WebGL template examples.
Is this a standalone app, or something an AI agent runs for me?It is a Codex agent skill, not a standalone app: Codex uses it as a toolset to analyze your photos and generate a local flipbook site, choosing between the bundled 2D runtime or the separate 3D React/Three.js example templates.
How do I get this running?Install the skill package into your Codex skills directory so the agent can invoke it; the templates under examples/ are optional and must be copied separately since they are not installed with the skill.
Do I need anything extra for photo search to work?Semantic search and contact sheets rely on an existing photo-search MCP; the bundled scripts/photolibrary.py adapter also needs a separately installed photo-search engine, with PHOTOSEARCHENGINEDIR pointing to it.
Does it ship with any sample photos to try out?No, the starter skill comes with no sample images, so you need to supply your own photo folder to build a book.
Do my photos or generated books get uploaded anywhere?No, everything stays local: photos are imported from a local folder and the generated books and photographs are kept Git-ignored rather than committed or shared.
What's the difference between the 2D Book and the 3D Book templates?The 2D Book is the skill's own bundled HTML runtime used by default. The 3D Book 1 and 3D Book 2 examples are separate, optional templates outside the skill folder built with React+WebGL and Three.js+Quick FlipBook respectively.
What is Negative Sleeves?It is a separate, photo-free template included among the examples: a film archive UI with page-corner previews and draggable film strips, unrelated to the main photobook workflow.
How does the skill actually decide how my book looks?It follows a three-stage workflow: understand the photos (via search/contact sheets), define a style with the user (or fall back to a default photobook style), then build the final book using the bundled 2D runtime and serve it at a local URL.
Size
70.5 MB
Stars
530
Age
1mo
Commits · 90 Days