Skip to content

Commit

Permalink
Add file format abstraction note to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Col-E committed Sep 25, 2023
1 parent 943bb1e commit 2b2a0dd
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,19 @@ An easy to use modern Java bytecode editor that abstracts away the complexities

## Features

- Edit Java bytecode with ease from a high or low level _(minus the annoying parts)_
- Editor features within Recaf abstract away complex details of compiled Java applications like:
- The constant pool
- Stack frame calculation
- Using wide instructions when needed
- And more!
- Easy to use navigable interface with context-sensitive actions
- Support for standard Java _and_ Android applications
- Multiple decompilers to switch between, with all of their parameters made fully configurable
- Built in compiler to allow recompiling decompiled classes, even if some referenced classes are missing *(When supported, support may vary depending on code complexity and obfuscation)*
- A bytecode assembler with a simple syntax, and supported tooling
- A bytecode assembler with a simple syntax, and supporting tooling
- See the state of local variables and stack values at any point in methods
- Access variables by names instead of indices for clearer code
- Access variables by names instead of indices for clearer disassembled code
- Convert snippets of Java source code to bytecode sequences automatically
- Searching for a variety of different content: Strings/numeric constants, classes and member references, instruction patterns
- Tools for deobfuscating obfuscated code
Expand Down Expand Up @@ -52,4 +58,4 @@ Open the project in an IDE or generate the build with gradle.

**Without IDE**:
1. Run `gradlew build`
- Output will be located at: `recaf-ui/build/recaf-ui-{VERSION}-all.jar`
- Output will be located at: `recaf-ui/build/recaf-ui-{VERSION}-all.jar`

0 comments on commit 2b2a0dd

Please sign in to comment.