falso
/
papermario
mirror of https://github.com/pmret/papermario.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Decompilation of Paper Mario
1,281 Commits 6 Branches 0 Tags 282 MiB
C 96.6%
Python 2.8%
Assembly 0.5%
Go to file
Ethan Roseman 1f868bbaa4 All functions in the project are not static now 2020-12-27 21:30:24 +09:00
.github/workflows fix doxygen 2020-10-20 21:40:49 +01:00
.vscode update script syntax 2020-12-24 11:15:05 +00:00
asm All functions in the project are not static now 2020-12-27 21:30:24 +09:00
docs merge 2020-11-07 12:33:18 +00:00
include Merge pull request #138 from nanaian/worldpartners 2020-12-26 12:42:49 +00:00
src All functions in the project are not static now 2020-12-27 21:30:24 +09:00
tools All functions in the project are not static now 2020-12-27 21:30:24 +09:00
.clang-tidy Merge branch 'mac-support' into audio 2020-12-05 19:57:10 -05:00
.editorconfig new makefile 2020-10-23 01:28:24 +01:00
.gitattributes tell github *.h files are written in C 2020-08-17 13:45:46 +01:00
.gitignore match world partner table 2020-12-22 15:53:16 +00:00
.gitmodules add sprite editor gui 2020-12-22 00:09:55 +00:00
CONTRIBUTING.md Create CONTRIBUTING.md 2020-12-24 03:38:37 -05:00
Dockerfile Update Dockerfile 2020-05-12 00:45:15 -04:00
Doxyfile implement SCRIPT(...) dsl 2020-10-22 05:54:03 +01:00
Jenkinsfile Jenkins test 3 2020-08-15 00:20:15 -04:00
Makefile Merge pull request #138 from nanaian/worldpartners 2020-12-26 12:42:49 +00:00
README.md Update README.md 2020-12-24 03:40:01 -05:00
checksum.sha1 Refactoring stuff 2020-08-12 21:56:23 -04:00
coverage.py hotfix coverage.py bytes listing 2020-10-20 20:47:29 +01:00
diff.py saving for later 2020-10-02 02:07:54 -04:00
diff_settings.py watch includes 2020-10-28 21:34:04 +00: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
format.sh 4 more and format 2020-12-12 17:55:21 +09:00
install.sh More checking in install.sh 2020-11-24 15:45:37 -05:00
requirements.txt tidy up splat 2020-12-02 22:26:08 +00:00
requirements_extra.txt tidy up splat 2020-12-02 22:26:08 +00:00
sources.mk again 2020-12-22 16:33:26 +00:00
undefined_funcs.txt cleanup 2020-10-17 22:39:30 -04:00
undefined_funcs_auto.txt undefined_funcs_auto 2020-11-29 12:00:52 -05:00
undefined_syms.txt Merge pull request #138 from nanaian/worldpartners 2020-12-26 12:42:49 +00:00
undefined_syms_auto.txt asm update 2020-12-10 16:11:43 +09:00

README.md

Paper Mario

This is a WIP decompilation of Paper Mario (USA). It builds the following ROM:

  • papermario.z64 md5: a722f8161ff489943191330bf8416496

Discord: Paper Mario Modding

Setup

You'll need Linux, a Linux VM, or Windows 10 (WSL2) to work on this project.

Clone the repository

$ git clone https://github.com/ethteck/papermario.git
$ cd papermario

Install build dependencies

$ ./install.sh

Our install script does not yet support distros other than Ubuntu, Arch, and their derivatives. Please consider contributing to the script if you use another distro!

Base ROM

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

Install tools and extract ROM

$ make setup

Compile the game

$ make

If you get OK, you're all set! Otherwise, please feel free to reach out to us in our Discord channel.

Star Rod GUI

You can open our modified version of Star Rod with make editor.

Contributing

Please see CONTRIBUTING.md for information on how to contribute to the project. Any and all help is welcome!

Troubleshooting

  • If you are using Windows, you may encounter the following when you run make:
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

💡 Solution

Run git checkout checksum.sha1 and retry building. Windows has different line endings than Linux, causing some of our tools to break.