Vector35 / Vector35/binaryninja-api

Tooltips on Opcodes and Registers

Open
#3,864 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Component: UI Effort: Medium Impact: Low UI: Linear
Dominant language
C++
Stars
1.3k
Forks
298
Avg merge
5d 5h
Merged PRs (30d)
19

Description

What is the feature you'd like to have?
Hovering over an opcode or register in disassembly showing documentation provided by a plugin.

This would make it easier to lookup unusual opcodes or system registers.

Implementation could be for the plugins to be able to register a provider for documentation, probably in RST or Markdown, that would be displayed.

Is your feature request related to a problem?
Quickly understanding an opcode

Are any alternative solutions acceptable?
Today it requires going outside of binja to the web

Additional Information:
Additional MSRs should also be able to be documented

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named in the issue. Start by locating the disassembly tooltip handling and plugin API extension points; done should include hover documentation for opcodes, registers, and additional MSRs supplied by plugins.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
reverse-engineering
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.