pmret/papermario
1
0
Fork 0
mirror of https://github.com/pmret/papermario.git synced 2024-11-08 12:02:30 +01:00
Code Issues Packages Projects Releases Wiki Activity
9b96f91dc6
papermario/SETUP.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

86 lines
2.3 KiB
Markdown
Raw Normal View History

ninjatō
2021-01-15 17:28:05 +01:00
# Setup
This repository supports:
- [Linux](#unix)
fix INSTALL.md typo
2021-01-15 17:49:09 +01:00
- [macOS](#unix)
ninjatō
2021-01-15 17:28:05 +01:00
- [Windows Subsystem for Linux 2](#wsl-2)
update diccord links to new server
2023-08-21 08:51:35 +02:00
If you encounter any issues setting up the repo, please feel free to [reach out to us on Discord](https://discord.gg/PgcMpQTzh5).
ninjatō
2021-01-15 17:28:05 +01:00
Skip 'sudo' in install.sh if you are already root user (#343)
2021-07-27 13:17:51 +02:00
## Common
ninjatō
2021-01-15 17:28:05 +01:00
Clone the repository:
```sh
git clone https://github.com/pmret/papermario
cd papermario
```
Add mention of pigment64 to SETUP.md
2023-10-01 02:19:02 +02:00
Install pigment64 (our image-processing tool)
```sh
curl https://sh.rustup.rs -sSf | sh
cargo install pigment64
```
and make sure pigment64 is in your system path.
Skip 'sudo' in install.sh if you are already root user (#343)
2021-07-27 13:17:51 +02:00
## Unix
ninjatō
2021-01-15 17:28:05 +01:00
Install build dependencies:
```sh
Player sprites & more (#1055) * WIP work on sprites (sprite_stuff.py) * cleanup of various stuff * separate compiler installation into separate script * wipz * more * renames, bugfixes * more * very grood * cleanin * goods and services * oopth * oopth2 * Parse palette data from xml * more work * more wipperz * more * it working * git subrepo pull --force tools/splat subrepo: subdir: "tools/splat" merged: "e72a868f9f" upstream: origin: "https://github.com/ethteck/splat.git" branch: "master" commit: "e72a868f9f" git-subrepo: version: "0.4.5" origin: "https://github.com/ingydotnet/git-subrepo" commit: "aa416e4" * fix symbol_addrs for new splat * upd8s * Use generated header, other versions, fixes * fixes & formatting * wip fusing npc + player extraction & cleanup * remove npc_files * buildin * fix some bugs * Cleanup, yay0s separately * cleen * cleanup * Respect stack during build * jp spritz * dun * fix c files --------- Co-authored-by: pixel-stuck <mathmcclintic@gmail.com>
2023-06-26 12:27:37 +02:00
./install_deps.sh
whoooooweee that is some good ol' fashioned decomp (pal funcs) (#1076) * whoooooweee that is some good ol' fashioned decomp * fixins * PRomment * Fixes #1075 * change ver to pal * another * some more * progress.py formatting * oopth * Promment * Promment2
2023-07-03 11:35:05 +02:00
./install_compilers.sh
ninjatō
2021-01-15 17:28:05 +01:00
```
Fix some stuff for Mac installation (#753)
2022-08-28 06:12:47 +02:00
> **NOTE:** On Mac, if you get an error that looks like
>
>```sh
>Error: Cannot install md5sha1sum because conflicting formulae are installed.
> coreutils: because both install `md5sum` and `sha1sum` binaries
>
>Please `brew unlink coreutils` before continuing.
>```
>
Player sprites & more (#1055) * WIP work on sprites (sprite_stuff.py) * cleanup of various stuff * separate compiler installation into separate script * wipz * more * renames, bugfixes * more * very grood * cleanin * goods and services * oopth * oopth2 * Parse palette data from xml * more work * more wipperz * more * it working * git subrepo pull --force tools/splat subrepo: subdir: "tools/splat" merged: "e72a868f9f" upstream: origin: "https://github.com/ethteck/splat.git" branch: "master" commit: "e72a868f9f" git-subrepo: version: "0.4.5" origin: "https://github.com/ingydotnet/git-subrepo" commit: "aa416e4" * fix symbol_addrs for new splat * upd8s * Use generated header, other versions, fixes * fixes & formatting * wip fusing npc + player extraction & cleanup * remove npc_files * buildin * fix some bugs * Cleanup, yay0s separately * cleen * cleanup * Respect stack during build * jp spritz * dun * fix c files --------- Co-authored-by: pixel-stuck <mathmcclintic@gmail.com>
2023-06-26 12:27:37 +02:00
>it's fine to just open `install_deps.sh` in a text editor, delete the `md5sha1sum` from the `brew install` line, and rerun it (put it back after so you don't accidentally commit it!)
ninjatō
2021-01-15 17:28:05 +01:00
Player sprites & more (#1055) * WIP work on sprites (sprite_stuff.py) * cleanup of various stuff * separate compiler installation into separate script * wipz * more * renames, bugfixes * more * very grood * cleanin * goods and services * oopth * oopth2 * Parse palette data from xml * more work * more wipperz * more * it working * git subrepo pull --force tools/splat subrepo: subdir: "tools/splat" merged: "e72a868f9f" upstream: origin: "https://github.com/ethteck/splat.git" branch: "master" commit: "e72a868f9f" git-subrepo: version: "0.4.5" origin: "https://github.com/ingydotnet/git-subrepo" commit: "aa416e4" * fix symbol_addrs for new splat * upd8s * Use generated header, other versions, fixes * fixes & formatting * wip fusing npc + player extraction & cleanup * remove npc_files * buildin * fix some bugs * Cleanup, yay0s separately * cleen * cleanup * Respect stack during build * jp spritz * dun * fix c files --------- Co-authored-by: pixel-stuck <mathmcclintic@gmail.com>
2023-06-26 12:27:37 +02:00
Continue onto [building](#building)
ninjatō
2021-01-15 17:28:05 +01:00
## WSL 2
1. Install or upgrade to **WSL 2** following [these instructions](https://aka.ms/wsl2-install) (Ubuntu is recommended)
2. Open a WSL terminal
3. Run the following command: `sudo apt update && sudo apt upgrade && cd ~`
whoooooweee that is some good ol' fashioned decomp (pal funcs) (#1076) * whoooooweee that is some good ol' fashioned decomp * fixins * PRomment * Fixes #1075 * change ver to pal * another * some more * progress.py formatting * oopth * Promment * Promment2
2023-07-03 11:35:05 +02:00
4. Install build dependencies:
```sh
./install_deps.sh
./install_compilers.sh
```
5. Continue with [building](#building)
ninjatō
2021-01-15 17:28:05 +01:00
update INSTALL.md
2021-01-15 17:50:06 +01:00
If you have Visual Studio Code, you can type `code .` to open the repo within it.
ninjatō
2021-01-15 17:28:05 +01:00
`Ctrl + J` opens up a Linux terminal within VS Code.
Player sprites & more (#1055) * WIP work on sprites (sprite_stuff.py) * cleanup of various stuff * separate compiler installation into separate script * wipz * more * renames, bugfixes * more * very grood * cleanin * goods and services * oopth * oopth2 * Parse palette data from xml * more work * more wipperz * more * it working * git subrepo pull --force tools/splat subrepo: subdir: "tools/splat" merged: "e72a868f9f" upstream: origin: "https://github.com/ethteck/splat.git" branch: "master" commit: "e72a868f9f" git-subrepo: version: "0.4.5" origin: "https://github.com/ingydotnet/git-subrepo" commit: "aa416e4" * fix symbol_addrs for new splat * upd8s * Use generated header, other versions, fixes * fixes & formatting * wip fusing npc + player extraction & cleanup * remove npc_files * buildin * fix some bugs * Cleanup, yay0s separately * cleen * cleanup * Respect stack during build * jp spritz * dun * fix c files --------- Co-authored-by: pixel-stuck <mathmcclintic@gmail.com>
2023-06-26 12:27:37 +02:00
# Building
Copy baseroms into the following places (at least 1 is required):
* `ver/us/baserom.z64` (sha1: `3837f44cda784b466c9a2d99df70d77c322b97a0`)
* `ver/jp/baserom.z64` (sha1: `b9cca3ff260b9ff427d981626b82f96de73586d3`)
* `ver/pal/baserom.z64` (sha1: `2111d39265a317414d359e35a7d971c4dfa5f9e1`)
* `ver/ique/baserom.z64` (sha1: `5c724685085eba796537573dd6f84aaddedc8582`)
(If you're using WSL, you can enter the Linux filesystem by opening `\\wsl$` in File Explorer; e.g. `\\wsl$\Ubuntu\home\<your username>\papermario`.)
Configure the build and extract assets from the base ROM:
```sh
./configure
```
Compile the game:
```
ninja
```
If you get `papermario.z64: OK` at the end, the build succeeded and the built rom matches the input rom!
Reference in New Issue Copy Permalink