masi/lnreader-plugins
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
Files
0d4d8509358dfc5aa235802bf79f7368cabd244f
lnreader-plugins/docs/quickstart.md
T
Marcin Majewski 211f30d5b2 Start adding documation and add host.ps1 for windows users (#725) 
* Add docs v0.0.1

* Add icon size warning

* Fix sourcenover caution

* Fix semver descriptions

* Filters fix

* Quickfix quickstart

* Add icon warning v2

* Fix typos

* Add NovelItem

* Update plugins host

* Update plugins host

* Remove unnecesarry .js and .dist

* Update plugins host

* Add host.ps1

* Fix readme.txt

* Fix READNE.txt, again

* Remove .js and .dist

* readme update with ost

* Add linux/windows hosting functions

* Fix workflows
2024-02-02 10:23:50 +07:00

957 B
Raw Blame History

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

Reference in New Issue View Git Blame Copy Permalink