Skip to content

Commit

Permalink
Update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Maschell committed Nov 1, 2023
1 parent 8abfbe2 commit 2544ee6
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
# Ghidra RPX/RPL loader

This is a (WIP) simple extension to open .rpx and .rpl files with Ghidra.
This is a simple extension to open .rpx and .rpl files with `Ghidra 10.4`.

# Dependencies
The loader includes the Gekko/Broadway/Espresso processor definitions that are based on the [Ghidra-GameCube-Loader](https://github.com/Cuyler36/Ghidra-GameCube-Loader).

This loader uses the Gekko/Broadway processor definitions for Ghidra if found - it is recommended that this should be installed prior to using the loader.
In case the Espresso language is not found, the loader will switch to the default PowerPC processor. However, it is not advisable to expect satisfactory results if the program uses paired single instructions.

https://github.com/aldelaro5/ghidra-gekko-broadway-lang

The loader will fallback to the default PowerPC processor if the Gekko/Broadway language is not found, but do not expect good results if the program uses any paired single instructions.
Imports in official .rpl/.rpx files may display as "func_xyz" instead of the function's actual name. This issue can be resolved by running the `fix_primary_imports.java` script, which is included with this loader.

## Building

- Ensure you have ``JAVA_HOME`` set to the path of your JDK 17 installation.
- Set ``GHIDRA_INSTALL_DIR`` to your Ghidra install directory. This can be done in one of the following ways:
- **Windows**: Running ``set GHIDRA_INSTALL_DIR=<Absolute path to Ghidra without quotations>``
Expand All @@ -21,13 +20,16 @@ The loader will fallback to the default PowerPC processor if the Gekko/Broadway
- You'll find the output zip file inside `/dist`

## Installation

- Copy the zip file to ``<Ghidra install directory>/Extensions/Ghidra``.
- Start Ghidra and use the "Install Extensions" dialog to finish the installation. (``File -> Install Extensions...``).

## Usage

- Choose the `Gekko/Broadway/Espresso` language if asked
- Run the `fix_primary_imports.java` script if imports are not displayed properly

# Credits

- Based on https://github.com/Relys/rpl2elf
- https://github.com/Cuyler36/Ghidra-GameCube-Loader
- Based on https://github.com/Cuyler36/Ghidra-GameCube-Loader

0 comments on commit 2544ee6

Please sign in to comment.