Skip to content

Commit

Permalink
chore: Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Pazaz committed May 1, 2024
1 parent 4df638f commit b71aed5
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@ The TeaVM webclient is in the `webclient` branch until it can be made compatible

## Project Structure

`client` - Decompiled client source code. Some class names are original.
`client` - Decompiled client source code.

`runetek3` - Decompiled client engine source code. Some class names are original.

`deob-annotations` - OpenRS2 dedobfuscator annotations library. Useful for making the namings of everything reusable if starting again from scratch or comparing to the original bytecode.

`loader` - Decompiled loader source code. Class names are all original.

`mapview` - Decompiled mapview source code.

`tools` - Tooling specific to the client or loader.

## Sources
Expand All @@ -21,3 +25,7 @@ Thanks to these individuals' projects for shedding light on some things - this w
* [Dane's 317 refactor](https://github.com/thedaneeffect/RuneScape-317)
* [Dane's 186 refactor](https://github.com/thedaneeffect/RuneScape-Beta-Public)
* [James Monger's 317 refactor](https://github.com/Jameskmonger/317refactor)

## Running

Because there are multiple entry points, instead of `gradle run` you have to execute `gradle client:run` or `gradle mapview:run` else it will launch both sequentially.

0 comments on commit b71aed5

Please sign in to comment.