Files
gocryptotrader/backtester/plugins/README.md
Adrian Gallagher ba92ba3254 docs: Add CODING_GUIDELINES.md and other adjustments (#1988)
* docs: Create new CODING_GUIDELINES doc

Rids excess contribution instructions from other packages
Adds AGENTS.md file for the AI overlords
Rids unused templates
Updates ADD_NEW_EXCHANGE.md with minor fixes

* docs: Fix linter issues and minor adjustments based on Copilot feedback

* docs: Update coding guidelines for API parameters and testing practices

* docs: Remove redundant GoDoc references

Adds copilot-instructions.md

* docs: Update CODING_GUIDELINES with export recommendations and test commentary

* docs: Fix formatting inconsistencies in ADD_NEW_EXCHANGE.md links

* docs: Update struct naming conventions for request and response types

* docs: Improve clarity and consistency in ADD_NEW_EXCHANGE.md and CODING_GUIDELINES.md

* refactor: Simplify error handling in QueryOrder method
2025-08-08 12:10:53 +10:00

2.9 KiB

GoCryptoTrader Backtester: Plugins package

Build Status Software License GoDoc Coverage Status Go Report Card

This plugins package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progress on our GoCryptoTrader Kanban board.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Plugins package overview

Golang Plugins are supported by the GoCryptoTrader Backtester. At present, only custom strategies are supported.

Please read the Golang documentation on plugins for more information.

Building Golang Plugins

Windows

Plugin support is not yet available for Windows. However, you can still build via WSL. See below for instructions on a basic setup for WSL. Once completed, follow the instructions for Linux.

WSL Setup

The following is a basic setup for WSL: here

Linux, macOS & WSL

A plugin is a Go main package with exported functions and variables that has been built with:

go build -buildmode=plugin

This outputs a file named plugins.so which can be loaded by the backtester. At present, only custom strategies can be loaded. See here for more information on building custom strategies via plugins.

You must ensure that the plugin is built with the same version of code as the GoCryptoTrader Backtester. Otherwise the plugin will refuse to load.

Installing Golang in WSL

See the following for instructions on installing Golang in WSL: here

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc