https://github.com/d0c-s4vage/pfp-vim

A vim hex-editor plugin that uses 010 templates to parse binary data using pfp
https://github.com/d0c-s4vage/pfp-vim

010editor binary-data hex parse pfp vim-plugin

Last synced: 4 days ago
JSON representation

A vim hex-editor plugin that uses 010 templates to parse binary data using pfp

• Host: GitHub
• URL: https://github.com/d0c-s4vage/pfp-vim
• Owner: d0c-s4vage
• License: mit
• Created: 2015-07-10T15:35:10.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-09-21T13:50:38.000Z (about 5 years ago)
• Last Synced: 2024-10-31T13:45:57.620Z (11 days ago)
• Topics: 010editor, binary-data, hex, parse, pfp, vim-plugin
• Language: Python
• Size: 21.5 KB
• Stars: 58
• Watchers: 7
• Forks: 10
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pfp-vim

A vim hex-editor plugin that uses 

[010 templates](http://www.sweetscape.com/010editor/templates/) to parse binary

data using [pfp](https://github.com/d0c-s4vage/pfp). Tested to work with

vim versions that support python2 or python3.

- [Install pfp](#install-pfp)

- [Install Plugin](#install-plugin)

  * [Pathogen](#pathogen)

  * [Vim Plug](#vim-plug)

- [Usage](#usage)

- [Notes](#notes)

- [TODO](#todo)

## Install pfp

Install [pfp](https://github.com/d0c-s4vage/pfp):

```bash

pip install --upgrade pfp

```

If you see errors that mention not being able to locate `Python.h`, install

the `python-dev` package and try again:

```bash

sudo apt-get install python-dev

```

## Install Plugin

### Pathogen

Clone this repo into `~/.vim/bundle`:

    git clone https://github.com/d0c-s4vage/pfp-vim.git ~/.vim/bundle/pfp-vim

Use your vim plugin manager (pathogen, etc) to load the plugin (you probably

already have this setup in your `~/.vimrc` or something:

	call pathogen#infect()

### Vim Plug

Add `Plug 'd0c-s4vage/pfp-vim'` to your plug section

## Usage

With a binary file loaded in the current window, the `PfpParse` command

will parse the file.

You may be asked to specify a directory that contains your 010 templates

(looks for `*.bt` files).

You will also be asked which template should be used to parse the binary

file.

After choosing a template to use, a hex-view of the binary file will

be displayed in a new tab on the left, with the parsed-out fields

displayed on the right.

Navigating the data structure on the right will highlight the relevant

bytes in the hex-view on the left

![demo.gif](https://user-images.githubusercontent.com/5090146/65373814-4cb8c400-dc37-11e9-8d2a-a1c3de2e0c94.gif)

## Notes

A `PfpInit` command also exists. This can be used to add additional

directories within which 010 templates will be searched for.

## TODO

* Editing

* Saving

* Packed/Nested fields