Byte Field Diagrams

approved

by natri0

Adds diagrams that show how structures are laid out in memory / network.

★ 5 stars↓ 386 downloadsUpdated 1y agoMIT

bytefield

a simple Obsidian plugin adding support for byte-field diagrams.

usage

a byte-field diagram is one of those tables that show offsets of fields in e.g. network packets:

image

to create one, simply make a codeblock and add your fields.

```bytefield
field1: 3
field2: 4
field3: 1
```
simple diagram as above

every line has to contain the name of the field, : as the delimiter and the length of the field in bytes. lines that do not contain : are silently ignored, so feel free to use them as comments.

also, it is possible to change the offset where the diagram starts:

```bytefield
!curOffset: 7
field1: 5
field2: 3
field3: 4
```
diagram with starting offset set to 7

fields are wrapped around if they're longer than the row:

diagram with one of the fields wrapping around

also, to make an unnamed field that still takes up space (padding), just omit the part before the : :

```bytefield
field1: 3
: 1
field2: 4
```
diagram with one empty/padding byte

building

unlike most, this project is built with Bun. to build the main.js file:

bun run build

to watch:

bun run watch

doing it this way keeps minimal dependencies as Bun supports TypeScript out of the box, and also has a bundler built-in.

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.