Kaila_Btw
bfbb5aec94
* Use included scripts to update client from remote github repo
* Hide patcher debug messages, only shows actually patched methods now
* Add spotless support to openrsc client subproject (automatic when building)
* this isn't required to pass pipeline right now
* Add patcher automatic spotless apply (required for pipeline)
* Remove create zip cache for now
* update resource folder path
* update cache sprites in assets
* always replace our jar when compiling (for now)
- our method of task (not copy specific task) does not respect MD5 hash checking, so we can't check versions here (yet)
* Move resources for client into main/java/bot folder for easier access
* always copyJar AFTER jar is finished running
* update release to include cache and exclude run files
* turn back on cache generation but include cache with main repo
- this is more for a fall back if cache gets removed, and for server and world switching in the future!!!
* include zipcache in the repo,
IdleRSC Patcher
This project takes the Open RSC client jar archive and then patches various methods inside of it. This is necessary for more complex functionality which requires callbacks to IdleRSC, such as painting progress reports on the screen every game frame, or detecting hitsplats.
This patcher is required to be ran by the project maintainer every time that a new OpenRSC release is made which results in a client break.
Compiling
Run the gradle task build via the top-level wrapper or system gradle.
How To Run
Run patcher.jar via java -jar patcher.jar source.jar destination.jar, where
source.jar is the unpatched Open RSC client jar archive and destination.jar
is the location to place the patched jar archive.
If there are any errors after replacing the patched jar archive, IdleRSC may need to be recompiled against the patched jar archive.
Adding new patches
Before adding patches, it is helpful to know how the patcher actually works at a high level:
- It unzips the jar.
- It reads the class files.
- The ASM library is then used to read or modify bytecode. MasterAdapter looks at the function names in the class and then passes it along to the appropriate "patch adapter" function.
- For example, Open RSC's mudclient.showMessage is passed to MessageAdapter.
- The adapter makes the changes to the class file in memory.
- The raw class bytecode is then saved to the class file on disk.
- The jar is then re-zipped using the modified classes.
Therefore, if you want to add a new patch, you need to:
- Add a new
ifstatement in MasterAdapter - Add a new
XyzAdapterinpatcher.hookers.
However, you still need to determine what bytecode/ASM code to throw into your
XyzAdapter. To do this, you need to install IntelliJ's ASM Bytecode Viewer.
The plugin will allow you to write Java code and then view the bytecode or the
corresponding ASMified bytecode.
For example, here are two pictures of "Hello World" being decoded by the viewer:
From here, it is up to you to learn how to take the ASMified portion of this
code and then integrate it into the adapter. There are plenty of examples in
patcher.hookers!