Skip to content

Plugin "FunkMan"

This plugin adds support for the Moose Funkman protocol. You need to install FunkMan for it to work.

Important

You do not need to run the FunkMan bot! I just use some modules from FunkMan, so all you need is to tell the bot where it finds the files.

FunkMan supports the following Moose modules: * AIRBOSS * RANGE (Bombing & Strafing)

For samples on how to configure FunkMan support into Moose, see the respective samples in the samples directory.

Note

You need to set the DCSServerBot port to be used by FunkMan. The default for both, DCSServeBot and Funkman is port 10042.

Configuration

As FunkMan is an optional plugin, you need to activate it in main.yaml first like so:

# config/main.yaml
opt_plugins:
  - funkman

The plugin itself is configured with a yaml file in config/plugins/funkman.yaml. For a start, you just need to add the path to your FunkMan installation to your funkman.yaml. If you have configured your FunkMan.ini already, DCSServerBot will automatically take over your config parameters.

# config/plugins/funkman.yaml
DEFAULT:
  install: ../FunkMan

Channels to publish range- and trap-sheets

If you have configured your FunkMan.ini already, DCSServerBot will automatically take over your config parameters.

# config/plugins/funkman.yaml
DEFAULT:
  install: ../FunkMan
  CHANNELID_MAIN: 1122334455667788
  CHANNELID_RANGE: 8877665544332211
  CHANNELID_AIRBOSS: 1188227733664455
  IMAGEPATH: ../FunkMan/funkpics/
  message_autodelete: 300 # Optional, delete range or trap sheets after this amount of seconds

If you want to use different channels for your different servers, you can add a section for each server:

# config/plugins/funkman.yaml
DEFAULT:
  install: ../FunkMan
  IMAGEPATH: ../FunkMan/funkpics/
DCS.dcs_serverrelease:
  CHANNELID_MAIN: 1122334455667788
  CHANNELID_RANGE: 8877665544332211
  CHANNELID_AIRBOSS: 1188227733664455
DCS.dcs_serverrelease02:
  CHANNELID_MAIN: 1234567812345678
  CHANNELID_RANGE: 8765432187654321

Rangeboards for Strafing and Bombing

You can display the top X (default: 10) players for your bomb- and strafe-runs in a nice persistent board in some of your channels. For greenieboards see the respective plugin.

# config/plugins/funkman.yaml
DEFAULT:
  install: ../FunkMan
  # [...]
  strafe_board: true
  strafe_channel: 1122334455667788
  bomb_board: true
  bomb_channel: 8877665544332211

Discord Commands

Command Parameter Channel Role Description
/strafeboard clear [user] admin DCS Admin Wipes the strafeboard (optional: for a user).
/bombboard clear [user] admin DCS Admin Wipes the bombboard (optional: for a user).

Credits

Thanks to funkyfranky and the Moose team to align the FunkMan protocol with me, which made it very easy for me to add support for it and to provide this awesome functionality to you!


Configuration reference

Key Type Description Example
DEFAULT map

DEFAULT

Key Type Description Example
DEFAULT.install str (required) Path to your FunkMan installation directory. (range: min 1) ../FunkMan
DEFAULT.CHANNELID_MAIN text Discord channel for the main FunkMan output. 1122334455667788
DEFAULT.CHANNELID_RANGE text Discord channel for strafing and bombing range sheets. 8877665544332211
DEFAULT.CHANNELID_AIRBOSS text Discord channel for LSO trap sheets. 1188227733664455
DEFAULT.IMAGEPATH str (required) Directory holding the generated range and trap images. (range: min 1) ../FunkMan/funkpics/
DEFAULT.strafe_board bool Show a persistent strafing range board in a channel. true
DEFAULT.strafe_channel int Discord channel that shows the strafing board. 1122334455667788
DEFAULT.bomb_board bool Show a persistent bombing range board in a channel. true
DEFAULT.bomb_channel int Discord channel that shows the bombing board. 8877665544332211
DEFAULT.message_autodelete int Delete range or trap sheets after this many seconds. 300

<(.+)>

Key Type Description Example
<(.+)> any (one of: element_schema, instance_schema)