edmcoverlay2

Authors

Status
Active
With an API
Required software
EDMC
Compatible with release
Sources available
License
GPL-3.0-only
Supported languages
English en
Platform
GameApplication Linux
Elite:Dangerous Application

Share

EDMC Overlay for Linux.

edmcoverlay2 allows other plugins to draw text and graphics on top of Elite: Dangerous on Linux systems. It aims to be 100% compatible with the original EDMC Overlay written by Ian Norton; it has yet to reach this goal, but most of the important features are implemented (including both the Python library and the local server on port 5010), and it already works as a drop-in replacement for EDMC Overlay for plugins like ED Recon.


Links

History

  • Dec 26, 2020 (sorrel) Add description of API
  • Dec 26, 2020 (sorrel) First revision

API

Identical (hopefully) to EDMC Overlay's. From your EDMC plugin, import the edmcoverlay module, then instantiate an Overlay and use its send_message() and send_shape() methods (and send_raw() if absolutely necessary). Do not use any other methods that may be present on the Overlay object.

The local server on port 5010 is also available, but its use is not advised in new plugins.

If for some reason you need a way to identify whether your plugin is using edmcoverlay2 rather than EDMC Overlay, check that the IS_PRETENDING_TO_BE_EDMCOVERLAY attribute on the edmcoverlay module is both present and truthy.

Tools using the API

API used by this tool