pmret/papermario
1
0
Fork 0
mirror of https://github.com/pmret/papermario.git synced 2024-11-18 08:52:40 +01:00
Code Issues Packages Projects Releases Wiki Activity
Decompilation of Paper Mario - Mirror of https://github.com/pmret/papermario
209 Commits 5 Branches 0 Tags 205 MiB
C 96.6%
Python 2.8%
Assembly 0.5%
de5e3891b9
Go to file
sonicspiral de5e3891b9
Add FAQ section for possible common issues 
* Fix for /bin/bash: mips-linux-gnu-as: command not found.
* Fix for sha1sum: 'papermario.z64'$'\r': No such file or directory.
2020-08-12 20:35:59 -07:00
asm removing .inc 2020-08-12 22:37:16 -04:00
include Adding macro.inc include to macro 2020-08-12 22:46:59 -04:00
src Refactoring stuff 2020-08-12 21:56:23 -04:00
tools Refactoring stuff 2020-08-12 21:56:23 -04:00
.clang-format Refactoring stuff 2020-08-12 21:56:23 -04:00
.clang-tidy Refactoring stuff 2020-08-12 21:56:23 -04:00
.gitignore Refactoring stuff 2020-08-12 21:56:23 -04:00
.gitmodules Refactoring stuff 2020-08-12 21:56:23 -04:00
checksum.sha1 Refactoring stuff 2020-08-12 21:56:23 -04:00
diff_settings.py meow 2020-08-12 22:56:47 -04:00
diff.py Refactoring stuff 2020-08-12 21:56:23 -04:00
docker-compose.yml gud changes 2020-04-24 00:26:17 -04:00
docker-sync.yml gud changes 2020-04-24 00:26:17 -04:00
Dockerfile Update Dockerfile 2020-05-12 00:45:15 -04:00
format.sh Refactoring stuff 2020-08-12 21:56:23 -04:00
Makefile Update Makefile and readme 2020-08-12 22:32:41 -04:00
papermario.ld Refactoring stuff 2020-08-12 21:56:23 -04:00
Readme.md Add FAQ section for possible common issues 2020-08-12 20:35:59 -07:00
undefined_syms.txt Refactoring stuff 2020-08-12 21:56:23 -04:00

Readme.md

Paper Mario Decompilation

Setup

Requirements

You'll need Linux or Windows 10 (WSL) to work on this project.

Dependencies

  • *mips-linux-gnu binutils: You may be able to just download this via your package manager (sudo apt install binutils-mips-linux-gnu), or you'll have to build it yourself. (guide todo)

Ubuntu and co (easy mode):

For a quick and easy way to install all relevant decomp-related tools on Ubuntu and other similar distros,

sudo apt install -y binutils-mips-linux-gnu build-essential pkg-config python3 python3-pip wget git clang-tidy clang-format nano vbindiff zlib1g-dev libyaml-dev libcapstone-dev

Building mips-linux-gnu

todo

Fork and clone the repo

Click the "fork" button in the top right corner of the main repo's webpage (https://github.com/ethteck/papermario) to fork this repo to your own GitHub account. After this, clone the repo to your computer via the command below:

git clone https://github.com/YOUR_GITHUB_USERNAME/papermario.git

The Rom

You'll need a US Paper Mario rom to work on this project. Copy it into the root directory of the repository with the name baserom.z64.

Make setup

run make setup to set up tools and extract the rom

Make

run make to rebuild the rom. Get OK? If so, you're all set! Otherwise, please feel free to reach out to us in the discord.

FAQ

  • make setup failed with this error? One of the packages from the Ubuntu and co (easy mode) script did not install correctly. Try to run as sudo sudo su, run the script again and append --fix-missing to it.
/bin/bash: mips-linux-gnu-as: command not found
Makefile:92: recipe for target 'build/asm/boot.o' failed
make: *** [build/asm/boot.o] Error 127
  • make failed with this error? This is a Windows line ending issue run git checkout checksum.sha1 to fix it.
sha1sum -c checksum.sha1
sha1sum: 'papermario.z64'$'\r': No such file or directory
: FAILED open or read
sha1sum: WARNING: 1 listed file could not be read
Makefile:118: recipe for target 'verify' failed
make: *** [verify] Error 1