@milesnl/ptx-core
v0.1.0
Published
Library for reading Paratext project scripture, interlinear and Biblical Terms data
Maintainers
Readme
@milesnl/ptx-core
Library for reading data from Paratext project folders: scripture text (USFM),
AKG-style interlinear glosses, and the Biblical Terms list. It is the data layer
used by the @milesnl/ptx-mcp MCP server.
Install
npm install @milesnl/ptx-coreRequires Node.js 20.11 or later. ESM only.
Usage
import { resolveProjectsRoot, listProjects, getScripture } from "@milesnl/ptx-core"
const root = resolveProjectsRoot("/path/to/My Paratext 9 Projects")
console.log(listProjects(root))Everything exported from the modules below is available from the package root:
discovery (project folders), scripture, usfmBook, interlinear, books, and biblicalTerms.
The Biblical Terms functions take the path to BiblicalTerms.xml; use
resolveBiblicalTermsPath(paratextInstallDir?) to locate it.
License
ISC
