Installing A Release

Table Of Contents

• Table Of Contents
• Linux And WSL
• MacOS
• Windows

Linux And WSL

Using a Linux/WSL release should be straightforward. Navigate to the Releases section. Find the release you want to download. If you care about stability, you can scroll back to the latest versioned release. Otherwise, I'd recommend grabbing the latest nightly. It may have bugfixes not yet incorporated into a versioned release.

Then simply download porytiles-linux-X.zip where X corresponds to the architecture of your system. If you're not sure what your system architecture is, it's probably amd64. You can check the output of uname -m to determine your architecture. Note that the Linux release for Porytiles is statically linked, so you do not need to install any additional libraries. Everything should work out of the box!

Next, unzip the download folder. And finally, place the Porytiles executable somewhere on your system $PATH. If you're not sure what this means, just run the following command:

$ sudo cp porytiles-linux-amd64/porytiles /usr/local/bin

This will copy the porytiles executable to /usr/local/bin, which is the default Linux directory for user-installed exectuables! Now you can run:

$ porytiles --help

to confirm everything is working.

MacOS

Using a MacOS release is a tad more complicated, since Apple discourages static linking for MacOS executables. Before downloading Porytiles from the Releases section, you'll need to install a few libraries. Assuming you already have Homebrew installed, install libpng by running:

$ brew install libpng

If you have been decomp hacking on Mac, you probably already had this installed. Next, you'll need the LLVM C++ libraries. You can get these by installing LLVM 16 via:

$ brew install llvm@16

Boom! Once that's done, navigate to the Releases section. Find the release you want to download. If you care about stability, you can scroll back to the latest versioned release. Otherwise, I'd recommend grabbing the latest nightly. It may have bugfixes not yet incorporated into a versioned release.

Go ahead and download the porytiles-macos-X.zip for the X that corresponds to your MacOS architecture. If you are using a newer Mac laptop (i.e. Apple silicon, M1, M2, etc) that's aarch64. If you happen to have an older Intel Mac, never fear, just grab the amd64 release.

Next, unzip the download folder. And finally, place the Porytiles executable somewhere on your system $PATH. If you're not sure what this means, just run the following command:

$ sudo cp porytiles-macos-aarch64/porytiles /usr/local/bin

This will copy the porytiles executable to /usr/local/bin, which is the default directory for user-installed exectuables! Now you can run:

$ porytiles --help

to confirm everything is working.

Windows

Unfortunately, Porytiles does not support pure Windows at this time. If you are on a Windows machine, I recommend setting up WSL to run Porytiles. Once you have WSL set up, you can follow the Linux and WSL instructions above. Alternatively, you could try building from source. I have heard that MinGW can compile Porytiles with a little massaging.