- [x] Add optional plugins:

- [x] LUA STATE

- [ ] ~~CARGO~~

- [x] Add plugin documentation

- [ ] ~~Mini overlay mode~~

Use OverlayStats instead (see [this](https://github.com/Oval-Tutu/bootstrap-love2d-project/blob/main/game/lib/overlayStats.lua)).

Feather plugins are any Lua modules that extend the functionality of the debugger.

To create a plugin, you need to create a Lua module that exports a table with the following functions:

- `init(config)`: This function is called when the plugin is initialized.

- `update(dt, feather)`: This function is called every frame.

- `onerror(msg, feather)`: This function is called when an error occurs. Errors in this function will close the game abruptly.

- `handleRequest(request, feather)`: This function is called when a request is received.

- `finish(feather)`: This function is called when the server is closed.

- `getConfig()`: This function returns the configuration for the plugin. Sent to the client app.

To help with the implementation, Feather provides the `FeatherPlugin` class, which you can extend to create your plugin.

local FeatherPlugin = require("feather.plugins.base")

local MyPlugin = Class({

__includes = FeatherPlugin,

})

function MyPlugin:init(config)

-- Do something with the config

function MyPlugin:update(dt, feather)

-- Do something with the dt and feather

function MyPlugin:onerror(msg, feather)

-- Do something with the msg and feather

function MyPlugin:handleRequest(request, feather)

-- Do something with the request and feather

function MyPlugin:finish(feather)

-- Do something with the feather

function MyPlugin:getConfig()

-- Return the configuration for the plugin

return {

type = "my-plugin",

color = "#ff0000",

icon = "my-plugin-icon",

}

return MyPlugin

To register a plugin, you need to create an instance of it and pass it to the FeatherPluginManager. The FeatherPluginManager will handle the lifecycle of the plugin and call the appropriate functions.

local MyPlugin = require("my-plugin")

local plugin = FeatherPluginManager.createPlugin(MyPlugin, "my-plugin", {

-- Plugin options

})

The FeatherPluginManager will handle the lifecycle of the plugin and call the appropriate functions. Here's a breakdown of the plugin lifecycle:

1. **Initialization**: The plugin is initialized with the provided options.

2. **Request Handling**: The plugin handles requests from the client.

3. **Update**: The plugin is updated every frame.

4. **Error Handling**: The plugin handles errors that occur in the game.

5. **Finish**: The plugin is finished and the game is closed.

The plugin options are passed to the plugin's constructor. Here's an example of a plugin with options:

local MyPlugin = require("my-plugin")

local plugin = FeatherPluginManager.createPlugin(MyPlugin, "my-plugin", {

option1 = "value1",

option2 = "value2",

})

By default, every plugin has the following properties available:

- `self.logger`: A logger that logs messages to the Feather logger.

- `self.observer`: A logger that logs messages to the Feather observer.

Feather plugins can return configuration that is sent to the client. This configuration is used to display the plugin in the plugins tab.

Here's an example of a plugin with configuration:

local MyPlugin = require("my-plugin")

function MyPlugin:getConfig()

return {

type = "my-plugin",

color = "#ff0000",

icon = "my-plugin-icon",

}

Here are some examples of Feather plugins:

- [Hump's Signal Plugin](../src-lua/plugins/hump/signal/README.md)

- [Lua State Machine Plugin](../src-lua/plugins/lua-state-machine/README.md)

Each plugin should have a README file that explains how to use it and provides examples.

import onDark from '@/assets/theme/dark';

import { useTheme } from '@/hooks/use-theme';

const theme = useTheme();

const style = theme === 'dark' ? onDark : oneLight;

style={style}

import { useSettingsStore } from '@/store/settings';

export const useTheme = () => {

const isDark = window.matchMedia('(prefers-color-scheme: dark)').matches;

const theme = useSettingsStore((state) => state.theme);

if (theme === 'system') {

return isDark ? 'dark' : 'light';

}

return theme;