Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 3.24 KB

Plugins.md

File metadata and controls

53 lines (40 loc) · 3.24 KB
Raw

Plugins

What is a Plugin?

A plugin is an external or internal dependcy (dll). The ABI (Application Binary Interface) is defined in MinerPlugin project and plugin developers must implement the following interfaces IMinerPlugin and IMiner. This means that you create a new project inside Miners directory and implement all required functions from IMinerPlugin and IMiner interfaces. It is recommended that each one is in its own file (Plugin and Miner file).

Each plugin project should implement at least 1 plugin. You can implement more, but good practice is to keep 1 plugin inside 1 project.
IMinerPlugin is used for registering the plugin and there will be only 1 instance created. Its job is to give basic info such as name, UUID, version, etc.
IMiner is the mandatory interface for all miners containing bare minimum functionalities and is being used as miner process instance created by IMinerPlugin.

Bare minimum example of plugin is written in Example Plugin project. The Plugin file contains implementation of IMinerPlugin interface for registration and creation of the plugin instance. The Miner file contains implementation of IMiner interface, providing required functionalities.

What is MinerPluginToolkitV1 used for?

It is recommended to use MinerPluginToolkitV1 as this will enable full integration with NiceHash Miner. It will save time developing it and enable implementation of additional advanced features. If you are writing a plugin we highly recommend that you use MinerPluginToolkitV1. All miner plugins that are developed by NiceHash miner dev team are using MinerPluginToolkitV1. For example you can check NBMiner Plugin.

MinerPluginToolkitV1 also enables creation of Background Services, check out Ethlargement plugin for example.

Advantages Disadvantages

Implementation of all basic actions like Start/Stop mining, Start benchmarking, retrieve data from API, create command line, etc.

Use of additional features like Configs and Extra Launch Parameters

Access to usefull interfaces providing features like checking for missing files, device cross referencing, initializing internal settings, etc.

 The current API is not final and might change in the future.

List of Included Plugins

Miner Plugins

NVIDIA and AMD

  • LolMiner
  • NanoMiner
  • Excavator
  • NBMiner

CPU

  • XMRig

Background Services

  • Ethlargement Pill