Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 2.1 KB

README.md

File metadata and controls

47 lines (30 loc) · 2.1 KB
Raw

Update

Binary Ninja Plugins

Repository to track Binary Ninja Plugins, Themes, and other related tools

Plugins

Binary Ninja plugins are available in different channels. Currently, there are two channels:

  • Official: The official channel includes plugins written directly by Vector 35 or written by a third-party and verified by Vector 35. We have at least done our best to ensure they use the current plugin writing best-practices and provide useful functionality.

  • Community: The community channel includes plugins written by third-parties that are not verified for quality, safety, or efficacy.

  • Combined: A combined list of all plugins.

A sample plugin is available to demonstrate the required format for plugins.

Installing Plugins

To install plugins, you can either clone this repository, or clone the specific plugin you are interested in into your plugin folder.

Contributing Plugins

  1. Create a new repository (Optionally, just copy it from the sample plugin)
  2. Fill out a plugin.json
  3. (Optional) Run generate-readme.md to update your readme and license
  4. Fork this repository
  5. Add your plugin as a submodule: git submodule add https://github.com/YourName/YourPlugin plugins/community/YourPlugin
  6. Regenerate the plugin directory with generate-index.py
  7. Commit and issue a pull request

Required Fields

To be displayed in the plugin loader, your plugin.json MUST have the following fields:

  • name
  • author
  • api
  • license['name']
  • description
  • version

All other fields are optional.

License

Note that content contained in the root of this repository itself is Copyright 2016, Vector 35 LLC and available under an MIT license, but that each individual plugin may be released under a different license.