Please read everything carefully. Follow all necessary links and read those thoroughly. They contain important information.
Environment Setup
This section provides the necessary steps for configuring a development environment to build and contribute to LÖVE Potion.
In order to start contributing, you will need to follow the instructions on the devkitPro Wiki for setting up a development environment. If you have an existing pacman installation (e.g. msys2 or Linux) then refer to this section on the devkitPro Wiki.
Dependencies
Once the environment is set up, open your terminal and run the following commands to sync your packages and install the base development groups. On Linux and macOS, prepend dkp-
to the pacman
command if pacman
was installed via the devkitPro installer.
- Windows (msys2)
- Unix-like (Linux, macOS)
pacman -Syu && pacman -S switch-dev 3ds-dev wiiu-dev
sudo (dkp-)pacman -Syu && sudo (dkp-)pacman -S switch-dev 3ds-dev wiiu-dev catnip
Next, please fork and clone the LÖVE Potion repository locally. Afterwords, change the working directory to where LÖVE Potion was cloned:
cd lovepotion
Install the required portlibs for whichever console that will be built:
- Windows (msys2)
- Unix-like (Linux, macOS)
pacman -S --needed - < platform/{console}/pkglist.txt
sudo (dkp-)pacman -S --needed - < platform/{console}/pkglist.txt
After everything has been installed, you can run the catnip
build command to compile the code for your chosen console.
catnip
is a build tool provided by devkitPro for managing CMake builds of homebrew. Here are commands for each supported console:
- Nintendo 3DS
- Nintendo Wii U
- Nintendo Switch
catnip -T 3DS
catnip -T WiiU
catnip -T Switch