Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

65 lines (48 loc) · 2.71 KB
Raw

Contributing

This page contains general guidelines and instructions on how to develop a new plugin/pack

Plugins

Structure

pluginName
│
├── assets
│   └── icon.png
│
├── mobile
│
├── pc
│   ├── configMenu.ui
│   ├── default.cfg
│   └── main.lua
│
├── meta.json
└── README.md

* Please note the mobile component is yet to be developed on Extra Panel.

All of your plugin's files will be stored in a folder, called pluginName, which is your plugin name.

The root must contain two files:

  • meta.json - This is your plugin's metadata. Here you describe various aspects of your plugin:
    • Mandatory
      • id - Unique ID of your app.
      • name - Name of your plugin (title)
      • description - Short description of your plugin
      • icon - Icon location (typically assets/icon.png)
      • authors - List of authors
      • version - Version
    • Opcional
      • WIP

assets folder

In this folder you place any assets you use for the plugin. Most notably, you should include a 48x48 icon.png file to represent your plugin's logo.

mobile folder

This folder will contain every file nedded for the mobile version of the plugin. WIP

pc folder

This folder will contain every file needed for the pc version of the plugin. You can put any file you need here, but these 3 are mandatory:

  • configMenu.ui - This is your plugin's configuration menu that will appear inside Extra Panel's Config tab. Here you should make a nice UI to allow the user to edit several configs related to your plugin.
  • default.cfg - This is your plugin's configuration file. Here you save the custom configs needed for your plugin in .CFG format.
  • main.lua - This is your plugin's main script. This is your plugin's entrypoint: you can do any functionality your plugin requires, but you need to implement these 3 methods
    • setup(argument) - This is your setup method. It's called once when the daemon loads your plugin. It's argument contains the plugin's configurations separated by ;. You should return 0 if the plugin loaded fine or other code if there was an error.
    • query() - This method will be called by the daemon when it's time to collect information. Here you return info to be sent to mobile's plugin version. You should only return info if it has changed since the last call; this means keeping an internal state in your script to account for that.
    • change(data) - This method will be called when the daemon received commands from the mobile's plugin version. Here you should change the PC's state to the given info. You shouldn't return anything.

Packs

WIP...