Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 957 Bytes

quickstart.md

File metadata and controls

30 lines (21 loc) · 957 Bytes
Raw

Quick start

  1. Requirements
  2. Single plugin guide
  3. Multi-src guide

Requirements

  • git basics
  • Typescript or Javascript basics
  • Node >=18
  • 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)

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 icons/src/<lang>/<plugin-name>/icon.png

Warning

Icon size should be 96x96px!

Creating multi-source plugins