diff options
Diffstat (limited to 'python/examples/snippets')
| -rw-r--r-- | python/examples/snippets/README.md | 34 | ||||
| -rw-r--r-- | python/examples/snippets/plugin.json | 40 |
2 files changed, 52 insertions, 22 deletions
diff --git a/python/examples/snippets/README.md b/python/examples/snippets/README.md index 4e62c93d..f2b24889 100644 --- a/python/examples/snippets/README.md +++ b/python/examples/snippets/README.md @@ -1,14 +1,39 @@ +# Snippet UI Plugin (v1.1) +Author: **Vector 35 Inc** +_Example UI plugin demonstrating how to create a snippet manager that allows for quick one-liners to be bound to hotkeys._ +## Description: # Snippet UI Plugin (v1.0 alpha) + Author: **Vector 35 Inc** + _Example UI plugin demonstrating how to create a snippet manager that allows for quick one-liners to be bound to hotkeys._ + + + ## Description: + This plugin is dual purpose -- first, it demonstrates the new UI plugin interface available for third-party plugins, and secondly it implements the often-requested functionality of adding a snippet editor. This is particularly useful for binding commonly used snippets of python code from the ScriptingConsole to a hotkey to be able to trigger them more easily. + + +## Installation Instructions + +### Darwin + +no special instructions, package manager is recommended + +### Linux + +no special instructions, package manager is recommended + +### Windows + +no special instructions, package manager is recommended ## Minimum Version This plugin requires the following minimum version of Binary Ninja: - * release - 1401 - * dev - 1.2.0 + * 1401 + ## Required Dependencies @@ -18,5 +43,8 @@ The following dependencies are required for this plugin: ## License -This plugin is released under a [MIT](LICENSE) license. +This plugin is released under a MIT license. +## Metadata Version + +2 diff --git a/python/examples/snippets/plugin.json b/python/examples/snippets/plugin.json index 91421496..d2e4ebdf 100644 --- a/python/examples/snippets/plugin.json +++ b/python/examples/snippets/plugin.json @@ -1,21 +1,23 @@ { - "plugin": { - "name": "Snippet UI Plugin", - "type": ["ui"], - "api": ["python2", "python3"], - "description": "Example UI plugin demonstrating how to create a snippet manager that allows for quick one-liners to be bound to hotkeys.", - "longdescription": "This plugin is dual purpose -- first, it demonstrates the new UI plugin interface available for third-party plugins, and secondly it implements the often-requested functionality of adding a snippet editor. This is particularly useful for binding commonly used snippets of python code from the ScriptingConsole to a hotkey to be able to trigger them more easily.", - "license": { - "name": "MIT", - "text": "Copyright (c) 2019-2020 Vector 35 Inc\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE." - }, - "dependencies": { - }, - "version": "1.0 alpha", - "author": "Vector 35 Inc", - "minimumBinaryNinjaVersion": { - "dev": "1.2.0", - "release": "1401" - } - } + "pluginmetadataversion": 2, + "name": "Snippet UI Plugin", + "type": ["ui"], + "api": ["python2", "python3"], + "description": "Example UI plugin demonstrating how to create a snippet manager that allows for quick one-liners to be bound to hotkeys.", + "longdescription": "# Snippet UI Plugin (v1.0 alpha)\n\nAuthor: **Vector 35 Inc**\n\n_Example UI plugin demonstrating how to create a snippet manager that allows for quick one-liners to be bound to hotkeys._\n\n\n\n## Description:\n\nThis plugin is dual purpose -- first, it demonstrates the new UI plugin interface available for third-party plugins, and secondly it implements the often-requested functionality of adding a snippet editor. This is particularly useful for binding commonly used snippets of python code from the ScriptingConsole to a hotkey to be able to trigger them more easily.", + "license": { + "name": "MIT", + "text": "Copyright (c) 2019 Vector 35 Inc\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE." + }, + "platforms" : ["Darwin", "Linux", "Windows"], + "installinstructions" : { + "Darwin" : "no special instructions, package manager is recommended", + "Linux" : "no special instructions, package manager is recommended", + "Windows" : "no special instructions, package manager is recommended" + }, + "dependencies": { + }, + "version": "1.1", + "author": "Vector 35 Inc", + "minimumbinaryninjaversion": 1401 } |