Compiling PSXFunkin

Setting up the Development Environment

First off, you'll need a terminal one way or another.

Windows

On Windows, you basically have two choices:

MSYS2 (follow the instructions at https://www.msys2.org/ to set it up)
WSL (Windows 10 Linux terminal from the Windows Store, maintained by Microsoft, follow Linux instructions from here on).

MSYS2

Once you have MSYS2 set up, you'll need to copy the MIPS toolchain over. Download it here http://static.grumpycoder.net/pixel/mips/g++-mipsel-none-elf-10.3.0.zip.

Once you have it downloaded, make sure MSYS2 is closed, then open the zip up and extract the following folders into C:/msys64/usr/local/

bin
include
lib
libexec
mipsel-none-elf

IMPORTANT - DELETE THESE FILES IN bin OR YOUR TERMINAL WILL BE FUCKED

cat
cp
echo
make
mkdir
touch
rm
touch

Next, open up MSYS2 MinGW 64-bit from the Start Menu, and you'll need to install some libraries, so run the following command and accept the prompts that follow pacman -S mingw-w64-x86_64-cmake mingw-w64-x86_64-tinyxml2 mingw-w64-x86_64-ffmpeg

Linux

First, you'll need to install the GCC toolchain, run one of the following commands depending on your distro.

On Debian derivatives (Ubuntu, Mint...):

sudo apt-get install gcc-mipsel-linux-gnu g++-mipsel-linux-gnu binutils-mipsel-linux-gnu

On Arch derivatives (Manjaro), the mipsel environment can be installed from AUR : cross-mipsel-linux-gnu-binutils and cross-mipsel-linux-gnu-gcc using your AURhelper of choice:

trizen -S cross-mipsel-linux-gnu-binutils cross-mipsel-linux-gnu-gcc

You'll also need to install tinyxml2, ffmpeg (you may also need to install avformat and swscale separately), and cmake, which of course, depends on your distro of choice.

Compiling mkpsxiso

Download mkpsxiso's source from https://github.com/Lameguy64/mkpsxiso, cd to it, and run these two commands.

cmake -B build -DCMAKE_BUILD_TYPE=Release (add -G "MinGW Makefiles" to the end of this if you're using MSYS2)

cmake --build build --config Release

Then do ls build/, and if it went well, you should see a folder that starts with bin_, this is where the executable will be, so do cd build/bin_... to go to the executable's directory.

Finally, do sudo cp mkpsxiso /usr/local/bin/mkpsxiso (MSYS2 doesn't have sudo, so just omit it)

This will allow you to call mkpsxiso from anywhere (like the PSXFunkin repo).

Copying PsyQ files

First, go to the mips folder of the repo, and create a new folder named psyq.

Then, download the converted PsyQ library from http://psx.arthus.net/sdk/Psy-Q/psyq-4_7-converted-light.zip. Just extract the contents of this into the new psyq folder.

Compiling tools and converting assets

First, make sure to cd to the repo directory where all the makefiles are. You're gonna want to run a few commands from here.

TIP: For any make, try appending -jX to the end of it, where X is the number of CPU cores you have times two. This will try to put as much of your CPU as it can to doing whatever it needs to do and makes it go way quicker.

make -f Makefile.tools This will compile the tools found in tools/.

make -f Makefile.tim This will convert all the pngs in iso/ to TIM files that can be displayed by the PS1.

make -f Makefile.xa This will convert all the mp3s in iso/music/ to XA files that can be played by the PS1. This step will take a WHILE. Be patient!

make -f Makefile.cht This will convert all the jsons in iso/chart/ to cht files that can be played by the game.

You can read more about these asset formats in FORMATS.md