Flower Loader CLI

Flower Loader is a Plugin Manager for Creator of Another World. With Flower Loader, you can easily manage and develop Plugins. This repository contains the command-line interface (CLI) tool to manage plugins. It is built with Go and is source-available under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Get Involved

Supported Games

by kuetaro (くえたろう)

Table of Contents

• Installing the Tool
  • From a GitHub Release
  • From Source
• Usage
• Development
  • Prerequisites
  • Clone the Repository
  • Build the Project
  • Run the Project
• Plugin Ecosystem
• Contributing
• FAQ & Troubleshooting

Installing the Tool

From a GitHub Release

Choose your method of installation:

Windows via PowerShell

$INSTALL_DIR = "C:\Program Files\flower"

# Extract the archive
Expand-Archive `
  -DestinationPath $INSTALL_DIR `
  -Path flower_*.zip `
  -Force

# Add to PATH
$env:Path += ";$INSTALL_DIR"

# Check if it's installed
flower --version

Linux via bash (Ubuntu 20/22)

INSTALL_DIR="/usr/local/bin/flower"

# Extract the archive
sudo unzip flower_*.zip -d $INSTALL_DIR

# Add to PATH
echo "export PATH=\$PATH:$INSTALL_DIR" >> ~/.profile
source ~/.profile

# Check if it's installed
flower --version

From Source

First, if you haven't, install Go (version 1.20 or newer.) Then, run the following:

go install github.com/flowerLoader/tool/cmd/flower@latest

Usage

• Install a plugin: flower add FlowerTeam.LimitBreaker
• Update all plugins: flower update all
• Remove a plugin: flower remove FlowerTeam.LimitBreaker
• List plugins: flower list
• Search plugins: flower search <partial-term>

Development

Prerequisites

• Git
• Go 1.20+

Clone the Repository

git clone https://github.com/flowerLoader/tool flower
cd flower

Build the Project

go get ./...
go build ./cmd/flower

Run the Project

./flower --help

Plugin Ecosystem

Plugins are hosted in GitHub repositories with the #flower-plugin tag. Developers can learn more about creating plugins by visiting our plugin API documentation and loader code.

Contributing

We welcome contributions! More information will be added soon!

FAQ & Troubleshooting

• How do I update all plugins at once?

  • Use the command flower update all.

• How do I report an issue?

  • Please visit our GitHub Issues page.

• How do I uninstall the tool?

  • Delete the folder where the tool is installed. If you installed via go install, use go clean -i github.com/flowerLoader/tool/cmd/flower.

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