Overwolf

Overwolf

  • Getting Started
  • Docs
  • API
  • Events Status
  • Blog
  • Q&A
  • Support

›Using Plugins

Best Practices

  • Overview
  • App specific experience
  • First time user experience
  • App launch performance
  • Marketing Communications
  • User journey and error handling
  • Per-game settings
  • Hotkey best practices
  • Second monitor usage
  • Data persistence
  • Reduce OPK size
  • Use Tab as an app Hotkey
  • Type definition file
  • Download Link with referral ID
  • Video capture best practices
  • Enable Developer Tools
  • Exclusive Mode Overlay
  • Electron Migration

Using Windows API

  • Using Overwolf windows
  • Windows Communication
  • Windows Types
  • Resolution Size and Position
  • General Tips

Understanding OW logs

  • What are Overwolf logs
  • DxDiag log
  • Trace logs
  • OBS logs
  • OverwolfPerf log
  • Overlay game HTML

Using Plugins

  • Plugins overview
  • Plug-in Implementation
  • Write your own plugin
  • Sample plugin
  • Simple I/O plugin
  • TeamSpeak plugin
  • Downloader plugin
  • Process Manager plugin

Using Events

  • JavaScript events overview
  • Using game events in your app
  • Game events Simulator
  • Verifying event status

Developers Console

  • Submit a new version
  • Release notes
  • Submit for review
  • Update store listing
  • Manage your subscriptions
  • Users and permissions
  • Crash reports
  • Rating and reviews
  • App Channels
  • CLI

Integrations

  • Integrating app analytics
  • Login with Twitch
  • Login with Overwolf
  • Event SDK for Game Devs
  • Twitch Extensions

Request a Service

  • Marketing asset requirements
  • Looking for Group
  • Promoting your app
  • App recommendations

Community Help

  • Join the Community
  • Webinars
  • Developers Content
  • Code snippets

Legal

  • Legal overview
  • App terms
  • Developers terms
Edit

Implementing Plug-ins

important

When you finish developing your plugin, you should sign it to avoid security and deployment issues. Here you can find more on how to sign your code.

To implement an existing plugin for use in your app, follow these steps:

  1. Place the plugin’s DLL file or files in your app’s directory as well as inside your OPK when you create it.

  2. Make sure the DLL is "Unblocked". Windows automatically marks downloaded DLLs as unsafe and you will have to go into file properties and check the 'Unblock' option there.

alt-text

  1. Declare the plugin in your manifest.json under the data.extra-objects property. For example:
"data": {
"extra-objects": {
  "simple-io-plugin": {
    "file": "files/plugins/simple-io-plugin.dll",
    "class": "overwolf.plugins.simpleio.SimpleIOPlugin"
    }
  }
}

This tells Overwolf that your app contains a plugin named: simple-io-plugin which can be found inside the file: files/plugins/simple-io-plugin.dll with the .NET class name overwolf.plugins.simpleio.SimpleIOPlugin.

  1. Create an instance of this plug-in in your app's Javascript code:
var _plugin = null;
overwolf.extensions.current.getExtraObject(“simple-io-plugin”, (result) => {
  if (result.status === “success”) {
    _plugin = result.object;
  }
})

Now you can call on the plugin’s functions, events or properties directly.

Take a look at our Process Manager plugin on GitHub, for an example of using plugins. You can find there a generic helper class for initializing the plugin, so the initializing will look like this:

var plugin = new OverwolfPlugin("process-manager-plugin", true);

Feel free to use or modify it in your own app as needed.

Last updated on 2/16/2021 by eransharv
← Plugins overviewWrite your own plugin →
  • Legal
    • Terms overview
    • Developer's terms
    • App terms
    • Overwolf terms
    • Overwolf Privacy policy
  • Support
    • Questions and Answers
    • Discord
    • Slack
    • Facebook
    • Twitter
  • Documentation
    • Changelog
    • API
    • App Creation Process
    • Best Practices
    • Game Events status
  • Information
    • Careers
    • Fund
    • Developers Blog
    • Overwolf Appstore
    • Advertise on Overwolf
Overwolf 2022