diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2017-05-23 20:48:42 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2017-05-23 20:48:42 -0400 |
| commit | 3501dd765d8ad917fb60b72f2e6983ed76eb31bc (patch) | |
| tree | 0640df3831544beaf46ef569e83b56c7c09ec786 /docs | |
| parent | 7be5f0c6d6f1947e7836d097a7ce8831ba45e7f2 (diff) | |
basic plugin usage
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/getting-started.md | 14 | ||||
| -rw-r--r-- | docs/guide/troubleshooting.md | 6 |
2 files changed, 19 insertions, 1 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md index dbc99ae3..53aba268 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -14,6 +14,10 @@ Once the license key is installed, you can change it, back it up, or otherwise i - Linux: `~/.binaryninja` - Windows: `%APPDATA%\Binary Ninja` +## Linux Setup + +Because linux install locations can vary widely, we do not assume a Binary Ninja has been installed in any particular folder on linux. Rather, you can simply run `binaryninja/scripts/linux-setup.sh` after extracting the zip and various file associations, icons, and other settings will be set up. Run it with `-h` to see the customization options. + ## Loading Files You can load files in many ways: @@ -186,6 +190,16 @@ Note !!! Tip "Note" The current script console only supports Python at the moment, but it's fully extensible for other programming languages for advanced users who with to implement their own bindings. +## Using Plugins + +Plugins can be installed by one of two methods. First, they can be manually installed by adding the plugin (either a `.py` file or a folder implementing a python module with a `__init__.py` file) to the appropriate path: + +- OS X: `~/Library/Application Support/Binary Ninja/plugins/` +- Linux: `~/.binaryninja/plugins/` +- Windows: `%APPDATA%\Binary Ninja\plugins` + +Alternatively, plugins can be installed with the new [pluginmanager](https://api.binary.ninja/binaryninja.pluginmanager-module.html) API. + ## Preferences/Updates  diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md index 560b0f1f..efd9fab9 100644 --- a/docs/guide/troubleshooting.md +++ b/docs/guide/troubleshooting.md @@ -3,7 +3,7 @@ ## Basics - Have you searched [known issues]? - - Is your computer powered on? + - Have you tried rebooting? (Kidding!) - Did you read all the items on this page? - Then you should contact [support]! @@ -13,6 +13,10 @@ Running Binary Ninja with debug logging will make your bug report more useful. ./binaryninja --debug --stderr-log ``` +## Plugin Troubleshooting + +While third party plugins are not officially supported, there are a number of troubleshooting tips that can help identify the cause. The most importat is to enable debug logging as suggested in the previous section. This will often highlight problems with python paths or any other issues that prevent plugins from running. + ## License Problems - If experiencing problems with Windows UAC permissions during an update, the easiest fix is to completely un-install and [recover][recover] the latest installer and license. Preferences are saved outside the installation folder and are preserved, though you might want to remove your [license](/getting-started/index.html#license). |