diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2020-04-09 21:35:44 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2020-04-09 21:35:44 -0400 |
| commit | 555c7760770c9004bb66793ce33f231e9adfe3bb (patch) | |
| tree | 1b4a10dd8e9ed302fad0917e10f9fcda3291acdc /docs | |
| parent | f93c6d9aaec5c48f18bf03467039676291b06be8 (diff) | |
fix outdated ui plugin information
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/guide/plugins.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/guide/plugins.md b/docs/guide/plugins.md index f8388ca0..22a56e95 100644 --- a/docs/guide/plugins.md +++ b/docs/guide/plugins.md @@ -129,9 +129,9 @@ Available via [settings], enabling plugin debugging mode will enable additional ### UI Elements -While it is possible to use Qt to directly create [UI enhancements] to Binary Ninja, we don't recommend it. First, there's a chance that we'll change UI platforms in the future (in particular because Qt's QWidget performance is actually getting worse with newer versions and they're trying to move everyone to QTQuick which might as well be Electron). Secondly, it is much more difficult for other users to install your plugin given the much more complicated dependencies and cross-platform headache of setup. +There are several ways to create UI elements in Binary Ninja. The first is to use the simplified [interaction] API which lets you make simple UI elements for use in GUI plugins in Binary Ninja. As an added bonus, they all have fallbacks that will work in headless console-based applications as well. Plugins that use these API include the [angr] and [nampa] plugins. -The officially supported mechanism (until the 1.2 release which will include much more featureful UI API enhancements) are available from the [interaction API] and shown off in the [angr] and [nampa] plugins. +The second and more powerful (but more complicated) mechanism is to leverage the _binaryninjaui_ module. Documentation is forthcoming, but there are several examples ([1], [2], [3]) in the meantime. Additionally, the _binaryninjaui_ module is shipped with each build of binaryninja and includes header files that is helpful for using the APIs even when they're not documented. ### Testing @@ -152,3 +152,7 @@ For the Personal edition, we recommend simply commenting out the `register_` fun [installing the API]: https://github.com/Vector35/binaryninja-api/blob/dev/scripts/install_api.py [settings]: ../getting-started.html#ui.debugMode [python.interpreter setting]: ../getting-started.html#python.interpreter +[interaction]: https://api.binary.ninja/binaryninja.interaction-module.html +[1]: https://github.com/Vector35/binaryninja-api/tree/dev/python/examples/kaitai +[2]: https://github.com/Vector35/binaryninja-api/tree/dev/python/examples/snippets +[3]: https://github.com/Vector35/binaryninja-api/tree/dev/python/examples/triage
\ No newline at end of file |