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

Update Makefile and readme

Browse Source
This commit is contained in:
Ethan Roseman 2020-08-12 22:32:41 -04:00
parent a8a66bde47
commit 3cd498cc2f
2 changed files with 34 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Makefile
View File

@ -72,10 +72,13 @@ clean:
submodules: submodules:
git submodule update --init --recursive git submodule update --init --recursive
n64split:
make -C tools/n64splitter
split: split:
rm -rf $(DATA_DIRS) $(BGM_DIRS) && ./tools/n64splitter/bin/n64split -b -v -o . -c tools/n64split.yaml baserom.z64 rm -rf $(DATA_DIRS) $(BGM_DIRS) && ./tools/n64splitter/bin/n64split -b -v -o . -c tools/n64split.yaml baserom.z64
setup: clean submodules split setup: clean submodules n64split split
print-% : ; $(info $* is a $(flavor $*) variable set to [$($*)]) @true print-% : ; $(info $* is a $(flavor $*) variable set to [$($*)]) @true

34
Readme.md
View File

@ -1,6 +1,32 @@
# Generate the .bin files by splitting the rom # Paper Mario Decompilation
Place Paper Mario (U) (named baserom.z64) in the root directory, build `n64split`, and run:
## 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,
``` ```
./splitrom.sh 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
``` ```
You'll need to build binutils manually with two targets: mips-sgi-irix5 and mips-linux-gnu - we don't have proper instructions yet, but see the Dockerfile for an example.
#### 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.