Skip to content

Commit

Permalink
chore: README link and tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
N3rdL0rd committed Dec 28, 2024
1 parent c5f9286 commit ad2f38f
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Pure Python HashLink bytecode parser/disassembler/decompiler/modding tool

- Pure Python with zero dependencies, integrates nicely in a lot of places (IDAPython compatible!)
- Allows values to be externally modified and reserialised through a scriptable interface
- A very nice little CLI with [hlbc](https://github.com/Gui-Yom/hlbc)-compatible mode.
- A very nice little CLI with [hlbc](https://github.com/Gui-Yom/hlbc)-compatible mode (coming soon)

## Installation

Expand All @@ -37,6 +37,22 @@ You also need to have Graphviz installed to generate control flow graphs. On mos

Either:

```txt
$ crashlink path/to/file.hl # or python -m crashlink
crashlink> funcs
f@22 static Clazz.main () -> Void (from Clazz.hx)
f@23 Clazz.method (Clazz) -> I32 (from Clazz.hx)
crashlink> fn 22
f@22 static Clazz.main () -> Void (from Clazz.hx)
Reg types:
0. Void
Ops:
0. Ret {'ret': 0} return
```

Or:

```py
from crashlink import *
code = Bytecode.from_path("path/to/file.hl")
Expand All @@ -52,21 +68,7 @@ elif code.fn(240):
# > 0. Ret {'ret': 0} return
```

Or:

```txt
$ crashlink path/to/file.hl # or python -m crashlink
crashlink> funcs
f@22 static Clazz.main () -> Void (from Clazz.hx)
f@23 Clazz.method (Clazz) -> I32 (from Clazz.hx)
crashlink> fn 22
f@22 static Clazz.main () -> Void (from Clazz.hx)
Reg types:
0. Void
Ops:
0. Ret {'ret': 0} return
```
Read the [API documentation](https://n3rdl0rd.github.io/crashlink/crashlink) for more information.

## Development

Expand Down

0 comments on commit ad2f38f

Please sign in to comment.