null/sm64
1
0
Fork 0
mirror of https://github.com/n64decomp/sm64 synced 2026-05-13 17:47:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
sm64/tools/ido-static-recomp/tools/rabbitizer
History
n64 ae770e0df5 Refresh 16
2023-08-17 08:56:02 -04:00
..
.github/workflows Refresh 16 2023-08-17 08:56:02 -04:00
cplusplus Refresh 16 2023-08-17 08:56:02 -04:00
include Refresh 16 2023-08-17 08:56:02 -04:00
rabbitizer Refresh 16 2023-08-17 08:56:02 -04:00
src Refresh 16 2023-08-17 08:56:02 -04:00
tests/cplusplus Refresh 16 2023-08-17 08:56:02 -04:00
.clang-format Refresh 16 2023-08-17 08:56:02 -04:00
.clang-tidy Refresh 16 2023-08-17 08:56:02 -04:00
.gitattributes Refresh 16 2023-08-17 08:56:02 -04:00
.gitignore Refresh 16 2023-08-17 08:56:02 -04:00
.gitrepo Refresh 16 2023-08-17 08:56:02 -04:00
LICENSE Refresh 16 2023-08-17 08:56:02 -04:00
Makefile Refresh 16 2023-08-17 08:56:02 -04:00
MANIFEST.in Refresh 16 2023-08-17 08:56:02 -04:00
pyproject.toml Refresh 16 2023-08-17 08:56:02 -04:00
r5900test.c Refresh 16 2023-08-17 08:56:02 -04:00
README.md Refresh 16 2023-08-17 08:56:02 -04:00
registersTrackerTest.c Refresh 16 2023-08-17 08:56:02 -04:00
rsptest.c Refresh 16 2023-08-17 08:56:02 -04:00
setup.cfg Refresh 16 2023-08-17 08:56:02 -04:00
setup.py Refresh 16 2023-08-17 08:56:02 -04:00
test.c Refresh 16 2023-08-17 08:56:02 -04:00

README.md

rabbitizer

PyPI - Downloads GitHub GitHub release (latest SemVer) PyPI GitHub contributors

A MIPS instruction decoder API.

Currently supports all the CPU instructions for MIPS I, II, III and IV.

Installing

The recommended way to install is using from the PyPi release, via pip:

pip install rabbitizer

In case you want to mess with the latest development version without wanting to clone the repository, then you could use the following command:

pip install git+https://github.com/Decompollaborate/rabbitizer.git@develop

NOTE: Installing the development version is not recommended. Proceed at your own risk.

Features

  • Should produces matching assembly.
  • Fully written in C for fast decoding.
  • Python bindings.
    • The minimal Python version is 3.7, older versions are not guaranteed to work.
  • Includes some minor tools to build your own pointer/symbol detection.
  • Configurable, many features can be turned on and off.
  • MIPS instructions features:
    • Named registers for MIPS VR4300's coprocessors.
    • Support for many pseudoinstructions.
    • Properly handle move to/from coprocessor instructions.
    • Support for numeric, o32, n32 and n64 ABI register names.
  • Some workarounds for some specific compilers/assemblers:
    • SN64:
      • div/divu fix: tweaks a bit the produced div, divu and break instructions.
  • N64 RSP instruction decoding support.
    • RSP decoding has been tested to build back to matching assemblies with armips.
  • R5900 (PS2's Emotion Engine processor) decoding support.

References