Quick start
May 18, 2026 ยท View on GitHub
Requirements
- git basics
- Typescript or Javascript basics
- Node >=22
- Installing the dependencies with
npm i
Guide
- Create plugin script in
/plugins(learn more) - Copy code from plugin-template.ts
- Start coding (documentation)
Creating plugin script
- Remember to create your plugin inside the language folder corresponding to the language of the novels
- File should have the
.tsextension Exampleplugins/english/nobleMTL.ts - Add an icon to
public/static/src/<lang>/<plugin-name>/icon.png
Warning
Icon size should be 96x96px!