opencover-3d
v0.0.3
Published
Generate 3D book models and metadata from ISBN. powered by opencover.jp
Readme
opencover-3d
opencover-3d は、
opencover プロジェクトの一部として開発されている npm モジュールです。
ISBN をもとに opencover が提供する書影(表紙・背表紙)を利用し、 本の3Dモデル生成と 書誌情報の取得を行うことを目的としています。
書棚UI、蔵書ビュー、展示・インスタレーションなど、 本を立体的に扱う表現のための基盤ライブラリです。
opencover-3d is an npm module developed as part of the opencover project.
Its purpose is to generate 3D models of books and retrieve bibliographic information using the book cover images (front and spine) provided by opencover based on ISBNs.
It serves as a foundational library for expressions that handle books three-dimensionally, such as bookshelf UIs, library views, exhibitions, and installations.
📚 About opencover
opencover( https://opencover.jp/ ) は、 ISBN を指定することで 本の背表紙画像を生成・配信する非営利プロジェクトです。
- 日本の書籍を中心に対応
- 特に「背表紙画像」にフォーカス
- URL ベースで簡単に利用可能
- 書棚・ライブラリ系UIのために設計
OpenCover ( https://opencover.jp/ ) is a non-profit project that generates and distributes book spine images by specifying ISBN.
- Primarily supports Japanese books.
- Specifically focuses on "spine images."
- Easily usable via URLs.
- Designed for bookshelf and library-style UIs.
https://image.opencover.jp/v1/cover/spine/{isbn}.webpWhat you can do with opencover-3d
- Get opencover book cover images from ISBN
- Generate 3D models of books based on cover images
- Get bibliographic information such as author, title, and publisher
- API for unified handling of 3D models and metadata
Install
npm install opencover-3d threethreeis a peer dependency.- Please install it on the user's side.
How to Use
import { getBook } from "opencover-3d";
const { model, details } = await getBook("9784087213126");model: 3D model of the book (Three.js object)details: Bibliographic information
API
getBookModel
Retrieve only the 3D model of the book from the ISBN.
import { getBookModel } from "opencover-3d";
const model = await getBookModel("9784087213126");- For those who only need the 3D representation.
- Does not access the bibliographic information API.
🔹 getBookDetails
Retrieve only bibliographic information from the ISBN.
import { getBookDetails } from "opencover-3d";
const details = await getBookDetails("9784087213126");{
isbn: "9784087213126",
title: "なぜ働いていると本が読めなくなるのか",
author: "三宅香帆 著",
publisher: "集英社",
issued: "2024"
}getBook
Obtain the 3D model and bibliographic information simultaneously.
import { getBook } from "opencover-3d";
const { model, details } = await getBook("9784569857787");📄 License
MIT License
