Flower Loader

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 core plugin loader. It is built with ESBuild and is source-available under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Get Involved

Table of Contents

• Supported Games
• Installing Flowerloader From a Release
• Automatic Install With FlowerCLI
• Development
  • Prerequisites
  • Clone the Repository
  • Install required packages
  • Build the project
• Contributing
• FAQ & Troubleshooting

Supported Games

by kuetaro (くえたろう)

Installing Flowerloader From a Release

For installation instructions, see the readme file for the specific supported title.

Supported Titles

• Creator of Another World
• Generic

Automatic Install With FlowerCLI

Visit FlowerCLI's page for more information on automatic installation

Development

Prerequisites

• Git
• NPM
• ESBuild (installed through NPM for you)

Note: This guide will assume the user is using VSCode as their IDE.

Clone the Repository

git clone https://github.com/flowerLoader/core.git
cd core

Install required packages

npm install

Build the project

You can simply run the build task from VSCode if you're using it or run the esbuild command from your terminal if you're not

#Example command to build for Creator of Another World:
npx esbuild --bundle gameSupport/coaw/index.ts --format=esm --outdir=build/ --platform=node

Your build command will vary based on which game you are building from. See the included tasks under .vscode/tasks.json for more details.

Contributing

We welcome contributions! Issue and pull requests are welcome, especially for game support files.

FAQ & Troubleshooting

• How do I report an issue?

  • Please visit our GitHub Issues page.

• How do I uninstall flowerloader

  • The simplest and fastest way is to run verify game files for the game on steam.
  • Alternatively, you may remove the line you added to index.html and flower will no longer be loaded.
  • Finally, either way, you may remove all the files you copied in to your base game directory or leave them, they won't be loaded or effect the game in any way anymore

• How do I configure what plugins Flower loads?

  • Simply edit the config.js file under your base install directory in the flower folder. There are comments inside this file that explain how to set flower to load plugins.

• More troubleshooting tips and frequently asked questions will be added soon.