Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaitai-io/kaitai_struct_gui
Kaitai Struct: visualizer and hex viewer tool GUI in Java
https://github.com/kaitai-io/kaitai_struct_gui
hex-viewer java kaitai-struct visualizer
Last synced: about 2 months ago
JSON representation
Kaitai Struct: visualizer and hex viewer tool GUI in Java
- Host: GitHub
- URL: https://github.com/kaitai-io/kaitai_struct_gui
- Owner: kaitai-io
- License: gpl-3.0
- Created: 2016-10-21T20:22:40.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-08-01T07:09:50.000Z (over 1 year ago)
- Last Synced: 2024-07-21T07:35:01.935Z (5 months ago)
- Topics: hex-viewer, java, kaitai-struct, visualizer
- Language: Java
- Size: 110 KB
- Stars: 23
- Watchers: 9
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kaitai - Repository - io/kaitai_struct_gui/issues)) (Visualizers, IDEs, hex editors / Arbitrary file formats)
README
# Kaitai Struct: visualization GUI tool in Java
This is a Java-based GUI for data structure visualizations in binary
formats, based on [Kaitai Struct](http://kaitai.io) project. This vis
tool uses [Java's Swing](https://en.wikipedia.org/wiki/Swing_%28Java%29)
for its GUI elements.
Its functionality is akin to similar projects:
* [kaitai_struct_visualizer](https://github.com/kaitai-io/kaitai_struct_visualizer) in Ruby
* [WebIDE](https://ide.kaitai.io/) in TypeScript for web brosers
* [kaitai-struct-vscode](https://marketplace.visualstudio.com/items?itemName=fudgepops.kaitai-struct-vscode) in TypeScript for [VS Code](https://code.visualstudio.com/)
... but this Java version is significantly simpler and is no longer under
active development.
Kaitai Struct is a declarative language used to describe various
binary data structures, laid out in files or in memory: i.e. binary
file formats, network stream packet formats, etc.
The main idea is that a particular format is described in Kaitai
Struct language (`.ksy` files) only once and then can be compiled with
this compiler into source files in one of the supported programming
languages. These modules will include the generated code for a parser
that can read described data structure from a file / stream and give
access to it in a nice, easy-to-comprehend API.
## Build
Install java, maven and, if on windows, git-bash
Run in console:
```bash
mvn install
```
## Licensing
This GUI vis tool project itself is copyright (C) 2016-2019 Kaitai
Project.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
### Libraries used
Vis tool depends on the following libraries:
* [kaitai_struct_compiler](https://github.com/kaitai_struct_compiler) — GPLv3+ license
* [fastparse](http://www.lihaoyi.com/fastparse/) — MIT license
* [snakeyaml](https://bitbucket.org/asomov/snakeyaml) — Apache 2.0 license
* [JHexView](https://github.com/Mingun/JHexView) — LGPL-2.1 license