# LANrurugi

> A self-hosted library server for manga and comics that also reads PDF, EPUB, MOBI, DjVu, FB2 and TXT books. It started from LANraragi, can open an existing LANraragi library directly, and is rewritten in Rust + React with on-page manga translation, similar-work recommendations and AI plugin generation.

The documentation is written in Simplified Chinese (the default locale, no path prefix) and English (under `/en/`); both cover the same pages. The sets below split it by language and by guides versus API reference.

**HTTP API.** Every endpoint a LANrurugi server serves is described in one OpenAPI 3.1 document, [openapi.json](https://docs.lrrg.dev/openapi.json), generated from the server's own route registrations, so it lists exactly what the server serves. Endpoints shared with LANraragi keep that project's field-level documentation and stay compatible with its clients. Authenticate with an API token created in the instance's settings, sent as `Authorization: Bearer <token>`. The same document is browsable in [Swagger UI](https://api.lrrg.dev/) and, one page per group, in this site's API reference.

**Plugin SDK.** Plugins are single TypeScript files run by the server in their own Deno subprocess with only the network and file permissions they declare. Each exports `pluginInfo()` plus one entry point for its type: `execMetadata` (metadata), `execLogin` (login), `execDownload` (download) or `runScript` (script). The [SDK reference](https://sdk.lrrg.dev/) documents every type involved, generated by `deno doc` from the TypeScript the plugin runtime loads; [plugin-sdk.json](https://sdk.lrrg.dev/plugin-sdk.json) is the same reference as JSON. Start from the [plugin getting-started guide](https://docs.lrrg.dev/en/plugin/getting-started/).

## Documentation Sets

- [Abridged documentation](https://docs.lrrg.dev/llms-small.txt): a compact version of the documentation for LANrurugi, with non-essential content removed
- [Complete documentation](https://docs.lrrg.dev/llms-full.txt): the full documentation for LANrurugi
- [Guides (English)](https://docs.lrrg.dev/_llms-txt/guides-english.txt): installation, usage and plugin authoring
- [API reference (English)](https://docs.lrrg.dev/_llms-txt/api-reference-english.txt): every endpoint, one page per group
- [Guides (Simplified Chinese)](https://docs.lrrg.dev/_llms-txt/guides-simplified-chinese.txt): 安装、使用与插件开发
- [API reference (Simplified Chinese)](https://docs.lrrg.dev/_llms-txt/api-reference-simplified-chinese.txt): 全部端点，每组一页

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [OpenAPI document](https://docs.lrrg.dev/openapi.json): the complete HTTP API as OpenAPI 3.1 JSON
- [Plugin SDK reference (JSON)](https://sdk.lrrg.dev/plugin-sdk.json): every plugin-facing type, from deno doc
- [Source code](https://github.com/thelastfantasy/LANrurugi): MIT licensed