Creating a Plugin

The create-plugin command

To create a new plugin, open a terminal and navigate inside the devkit directory.

If you are using Windows CMD or PowerShell, type:

PowerShell

.\scripts\flare.bat create-plugin

If you are using Linux/Mac/WSL, type:

Terminal

./scripts/flare.sh create-plugin

Follow the instructions in the command prompt and enter the necessary details for your plugin. Below are the needed details for your plugin:

Package Name

This is the primary identifier of your plugin. It should be unique and follow reverse domain naming convention, e.g com.mydomain.myplugin. The package name should be in lowercase and should not contain any special characters or spaces except period, underscore and hyphen (., _, -).

Plugin Name

This is the name of your plugin, e.g. "System Monitor".

Description

This is a brief description of your plugin. It should describe the purpose of your plugin.

The main.go file

After that, your plugin will be created inside the plugins/local/[your-plugin-package] directory (plugins/local/com.mydomain.myplugin in this example). Inside your plugin directory, you will find a main.go file.

This file contains Init function which will be called when your plugin gets loaded into the system. Below is the initial content of main.go file:

main.go

package main

import (
    "net/http"

    sdkapi "sdk/api"
)

func main() {}

func Init(api sdkapi.PluginApi) {
    // Rest of the code...
}

Note

The api variable is an instance of the IPluginApi, the root API of the Flare Hotspot SDK. Throughout the documentation, when you see the variable api, it refers to IPluginApi.

Troubleshooting

For linux users, you must change the file permissions to fix errors in your code editor:

Terminal

sudo chown -R $USER .

For MacOS users, if you encouter Too many open files in system error, you can fix this by cleaning the Go build cache and fixing the file permissions:

Terminal

go clean -cache
sudo chown -R $USER .