2019-03-16 16:14:54 +00:00
|
|
|
Plugins
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
Cutter supports writing plugins in both C++ and Python.
|
2019-12-28 20:54:00 +00:00
|
|
|
If you are unsure of which language to choose, starting with Python is strongly suggested as
|
|
|
|
|
it provides a faster and simpler workflow.
|
2019-03-16 16:14:54 +00:00
|
|
|
|
|
|
|
|
If you plan to implement support for a new file format or architecture, Cutter plugins are not the correct approach.
|
2020-12-15 08:49:50 +00:00
|
|
|
Instead, you will want to implement a Rizin plugin, which is documented `here <https://book.rizin.re/plugins/intro.html>`_.
|
2019-03-16 16:14:54 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Loading and Overview
|
2020-03-02 19:06:28 +00:00
|
|
|
----------------------
|
2019-03-16 16:14:54 +00:00
|
|
|
|
|
|
|
|
Plugins are loaded from an OS-dependent user-level directory.
|
|
|
|
|
To get the location of this directory and a list of currently loaded plugins, navigate to Edit -> Preferences -> Plugins.
|
|
|
|
|
|
2020-07-19 19:23:00 +00:00
|
|
|
.. image:: contributing/plugins/preferences-plugins.png
|
2019-03-16 16:14:54 +00:00
|
|
|
|
|
|
|
|
The plugins directory contains two subdirectories, ``native`` and ``python`` for C++ and Python plugins respectively,
|
|
|
|
|
which will be created automatically by Cutter.
|
|
|
|
|
|
2019-03-24 16:51:52 +00:00
|
|
|
.. note::
|
|
|
|
|
The support for Python plugins is only available if Cutter was built with the options ``CUTTER_ENABLE_PYTHON``
|
|
|
|
|
and ``CUTTER_ENABLE_PYTHON_BINDINGS`` enabled.
|
|
|
|
|
This is the case for all official builds from GitHub Releases starting with version 1.8.0.
|
2019-03-16 16:14:54 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Creating Plugins
|
2020-03-02 19:06:28 +00:00
|
|
|
------------------
|
2019-03-16 16:14:54 +00:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:glob:
|
|
|
|
|
|
2020-07-19 19:23:00 +00:00
|
|
|
contributing/plugins/*
|
