added plugin.json

README.md

@@ -16,9 +16,16 @@ This plugin requires the installation of the [`rpyc`](https://rpyc.readthedocs.i
 
 ## Installation
 
-Install the files in the Binary Ninja plugin directory, and start the service (Palette -> `Start RPyc Service`).
+Install the files in the Binary Ninja plugin directory, start Binary Ninja and check in the logs the plugin is correctly loaded.
+```
+Loaded python3 plugin 'binja-headless'
+```
+
+You can now start the service (Palette -> `Binja-RPyc - Start RPyc Service`). A popup will confirm the service is running, or show the error in the logs on failure.
+
+## Usage
 
-From a remote Python terminal, you can now access binja!
+From a remote Python terminal, you can now import the `rpyc` module and access your remote Binary Ninja.
 
 ```python
 >>> import rpyc
@@ -74,25 +81,23 @@ CreateWaitableTimerW -> 0x180001090
 [...]
 ```
 
+
 ## Minimum Version
 
 This plugin requires the following minimum version of Binary Ninja:
 
- * 1200
+ * 3164
 
 
 
 ## Required Dependencies
 
-The following dependencies are required for this plugin:
-
- * rpyc >= 5.0.0
-
+The required dependencies can be found in the `requirements.txt` file.
 
 
 ## License
 
-This plugin is released under a MIT license.
+This plugin is released under a MIT license. See the `LICENSE` file for complete details.
 
 
 ## Metadata Version

__init__.py

@@ -1,7 +1,8 @@
 from binaryninja import (
     PluginCommand,
 )
-from constants import SERVICE_NAME
+
+from .constants import SERVICE_NAME
 
 
 from .server import (

plugin.json

@@ -0,0 +1,39 @@
+{
+    "pluginmetadataversion": 2,
+    "name": "Binja-Headless",
+    "type": [
+        "ui",
+        "binaryview",
+        "helper"
+    ],
+    "api": [
+        "python3"
+    ],
+    "description": "Binja (sort of) headless.",
+    "longdescription": "This plugin allows you to use any version of Binary Ninja headlessly and remotely to script and control Binja remotely without the need of an entreprise license. This makes it convenient for creating scripts, or live reversing using Jupyter for instance. It works internally by simply creating an RPyc service within the Python environment, and expose it on a TCP socket. Note that this plugin is Binary Ninja specific: an equivalent for IDA was created in the repository [IDA-Headless](https://github.com/hugsy/ida-headless).",
+    "license": {
+        "name": "MIT",
+        "text": "Copyright (c) 2023 hugsy\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": "Just run `python -m pip install -r requirements.txt`",
+        "Linux": "Just run `python -m pip install -r requirements.txt`",
+        "Windows": "Just run `python -m pip install -r requirements.txt`"
+    },
+    "dependencies": {
+        "pip": [
+            "rpyc>=5.0.0"
+        ],
+        "apt": [],
+        "installers": [],
+        "other": []
+    },
+    "version": "0.1.0",
+    "author": "hugsy",
+    "minimumbinaryninjaversion": 3164
+}

requirements.txt

@@ -1 +1 @@
-rpyc
+rpyc>=5.0.0