HimbeerserverDE
/
mt-multiserver-proxy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document plugins (#51)

master
HimbeerserverDE 2021-09-10 13:25:07 +02:00
parent 4f627b96a7
commit 10398bd66d
No known key found for this signature in database
GPG Key ID: 1A651504791E6A8B
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/plugins.md Normal file
View File

@ -0,0 +1,34 @@
# Plugins
mt-multiserver-proxy loads all plugin files in the `plugins` directory
on startup. Any errors will be logged and do not prevent other plugins
from being loaded. Plugins **cannot** be (re)loaded at runtime, you
need to restart the proxy.
## Installing plugins
To install a plugin, clone the repository, cd into it and run:
```
go build -buildmode=plugin
```
A .so file will be created. Copy or move this file into the `plugins`
directory. Restart the proxy to load the plugin.
## Developing plugins
A plugin is simply a main package without a main function. Use the init
functions instead. Plugins can import
```
github.com/HimbeerserverDE/mt-multiserver-proxy
```
and use the exported symbols to control the behavior of the proxy.
The API is documented [here](https://pkg.go.dev/github.com/HimbeerserverDE/mt-multiserver-proxy).
## Common issues
If mt-multiserver-proxy prints an error like this:
```
plugin.Open: plugin was built with a different version of package github.com/HimbeerserverDE/mt-multiserver-proxy
```
it usually means that either the plugin or the proxy is out of date.
Ugrade the proxy, then run
```
go get -u github.com/HimbeerserverDE/mt-multiserver-proxy
```
in the plugin repository and rebuild it.
You should compile the plugin and the proxy on the same machine since
the build environment needs to be identical. My build environment
can be found in [build_env.md](https://github.com/HimbeerserverDE/mt-multiserver-proxy/blob/main/doc/build_env.md).