Skip to content

flowerLoader/api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flower Loader API

Static Badge

NPM Downloads

Flower Loader is a Plugin loader and detour manager for Node.js applications. With Flower Loader, you can easily manage and develop Plugins. This repository contains the API definitions and interfaces used by Flower Loader Core. It is built with ESBuild and is source-available under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

License

Get Involved

Join the Discord

Supported Games

Steam
by kuetaro (くえたろう)

Table of Contents

Installing

From a released version

Flower API is already referenced in every plugin cloned from our Template Plugin. Activating it is as simple as running npm install in the source directory of your plugin.

From a preview version

First, clone the branch of the preview API with git clone. Navigate to your existing Flower API based project and remove the API with npm remove @flowerloader/api and then install the local version with npm install @flowerloader/api /path/to/cloned/repo. Note that preview version should only be used to preview upcoming features and not in release-ready plugins as preview APIs are subject to rapid, breaking change at Robin's whim.