lnreader-plugins/docs/quickstart.md

Quick start

1. Requirements
2. Single plugin guide
3. Multi-src guide
4. Testing your plugin

Requirements

• git basics
• Typescript or Javascript basics
• Node >=22
• Installing the dependencies with npm i

Guide

1. Create plugin script in /plugins (learn more)
2. Copy code from plugin-template.ts
3. Start coding (documentation)
4. Run npm run check:plugin -- plugins/<lang>/yourPlugin.ts before opening a PR — see Testing your plugin

Creating plugin script

1. Remember to create your plugin inside the language folder corresponding to the language of the novels
2. File should have the .ts extension Example plugins/english/nobleMTL.ts
3. Add an icon to public/static/src/<lang>/<plugin-name>/icon.png

Warning

Icon size should be 96x96px!

Creating multi-source plugins