Skip to content

Compiling from sources

Jump to bottom
RetroAntho edited this page Jul 31, 2024 · 14 revisions

Compiling the project from source

This wiki explains how to install the development tools on your system (see below the list of available systems).

Before following this tutorial, we strongly recommend you to do a first installation from the release version thanks to this page.

It will provide you tools and command lines to install dependencies and avoid you some loss of time here!

It means that this tuturial is only needed if you wish to participate to the project itself and make your own contribution

Installing the development tools

Installing the development tools on Windows.

First at all, you have to install MSYS2 as provided in the installation documentation here. Just follow the instructions from step 1 to 5.

When MSYS2 is installed, we want first to be sure that all is updated.

In the MSYS2 terminal, update it:

  • Run pacman -Suuy to update the rest of the packages (allowing downgrades). You MUST restart MSYS2.

Now we can install the development tools needed to compile PVSNESLIB.

In the MSYS2 terminal, install the following packages:

pacman -Sy mingw-w64-ucrt-x86_64-toolchain
pacman -Sy mingw-w64-ucrt-x86_64-cmake
pacman -Sy mingw-w64-ucrt-x86_64-doxygen
pacman -Sy mingw-w64-ucrt-x86_64-pcre2 
pacman -Sy base-devel
pacman -Sy git
pacman -Sy zip

Congratulations, you're done to start to compile PVSNESLIB on Windows !

Now, to use the MSYS2 UCRT64 toolchain, just open the MSYS2 UCRT64 terminal. See here to integrate it under Visual Studio Code.

Installing the development tools on Linux.

Installing the development tools on Ubuntu.

This procedure explains how to install the development tools on Ubuntu latest (22).

First at all, you have to ensure that your distribution is up to date.

In a terminal:

sudo apt update -y

Once it's done, in case of change, you should reboot your system.

Then, you can install the development tools:

sudo apt-get install -y build-essential \
    gcc-12 \
    cmake \
    make \
    git \
    doxygen \
    texi2html \
    texlive-latex-base \
    texlive-latex-recommended \
    texlive-latex-extra

Finally, set gcc-12 as your default compiler:

sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-12 90

This step will set gcc-12 as your the default compiler. the 90 is the priority, here higher priority. We need to do it because the default compiler on Ubuntu 22 is clang.

Congratulations, you're done to start to compile PVSNESLIB on Ubuntu!

Installing the development tools on Debian.

This procedure explains how to install the development tools on debian latest (11).

First at all, we need to add the testing component from the Debian repository, which contains gcc-12.

echo 'deb http://deb.debian.org/debian testing main' >> /etc/apt/sources.list

Then, let's ensure that your distribution is up to date.

In a terminal:

sudo apt update -y

Once it's done, in case of change, you should reboot your system.

Then, you can install the development tools:

sudo apt-get install -y build-essential \
    gcc-12 \
    cmake \
    make \
    git \
    doxygen \
    texi2html \
    texlive-latex-base \
    texlive-latex-recommended \
    texlive-latex-extra

Finally, set gcc-12 as your default compiler:

sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-12 90

This step will set gcc-12 as your the default compiler. the 90 is the priority, here higher priority. We need to do it because the default compiler on Debian 11 is gcc-11.

Congratulations, you're done to start to compile PVSNESLIB on Debian!

Installing the development tools on Fedora.

This procedure explains how to install the development tools on Fedora latest (37).

First at all, you have to ensure that your distribution is up to date.

In a terminal:

sudo dnf update -y

Once it's done, in case of change, you should reboot your system.

Then, you can install the development tools:

sudo dnf -y groupinstall "Development Tools"
sudo dnf -y install cmake \
    gcc-c++ \
    glibc-static \
    libstdc++-static \
    git \
    doxygen \
    texi2html \
    texlive-scheme-basic

Congratulations, you're done to start to compile PVSNESLIB on Fedora!

Installing the development tools on Centos.

This procedure explains how to install the development tools on Centos latest (7).

First at all, you have to ensure that your distribution is up to date and that the powertools repository is enable on your system.

In a terminal:

sudo dnf -y install dnf-plugins-core
sudo dnf -y config-manager --set-enabled powertools
sudo dnf update -y

Once it's done, in case of change, you should reboot your system.

Then, you can install the development tools:

sudo dnf -y groupinstall "Development Tools"
sudo dnf -y install cmake \
        gcc-c++ \
        glibc-static \
        libstdc++-static \
        git \
        doxygen \
        texi2html \
        texlive-scheme-basic

Congratulations, you're done to start to compile PVSNESLIB on Centos!

Installing the development tools on MacOS.

This procedure explains how to install the development tools on MacOS.

First at all, you have to ensure that your distribution is up to date.

In a terminal:

sudo softwareupdate -i -a

Note: You can also use the graphical interface to perform the same action. It's really up to you.

Then, install Xcode.

Xcode-select —install

Then, install brew:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Finally, install brew packages:

brew install doxygen
brew install gnu-sed
brew install texi2html
brew install texlive

For the same reason that Ubuntu (clang being installed as the default compiler) We need to create symlinks to set gcc and g++ to respectively gcc-12 and g++-12:

sudo ln -s /usr/local/bin/gcc-12 /usr/local/bin/gcc
sudo ln -s /usr/local/bin/g++-12 /usr/local/bin/g++

Ditto for gnu-sed, we need to set it as your default sed command. Let's do it by updating the PATH environment.

A quick way to do this is by adding PATH at the end of your ~/.zshrc

Edit this file and add this the end, or update the existing environment variable PATH if it already exists by using your favorite file editor (nano, vim, ...).

# Some people mention that the path is now "/opt/homebrew/opt/gnu-sed/libexec/gnubin", please confirm us!
PATH="/usr/local/opt/gnu-sed/libexec/gnubin:$PATH"
export PATH

Save the file and reload it:

source ~/.zshrc

Now gnu-sed will be used by default because it precedes all other sed commands installed on your system.

Congratulations, you're done to start to compile PVSNESLIB on MacOS!

Installing the development tools on ChromeOS.

This procedure explains how to install the development tools on ChromeOS (running Debian 12 bookworm).

If you haven't set up your Linux Development Environment yet:

  1. Open your system settings.
  2. Go to "About ChromeOS".
  3. Scroll down to "Linux development environment".
  4. Select "Turn On".
  5. Follow the on-screen instructions.

Next, let's ensure that your container is up to date.

In your Terminal, type (or paste by right-clicking):

sudo apt update -y

After that's done updating, right click Terminal in your taskbar, and press "Shut down Linux".

Then, reopen your Linux container by re-opening Terminal if needed and selecting the name of your Linux container (usually "penguin").

Next, let's install the build tools:

sudo apt-get install -y build-essential \
    gcc-12 \
    cmake \
    make \
    git \
    doxygen \
    texi2html \
    texlive-latex-base \
    texlive-latex-recommended \
    texlive-latex-extra

And lastly, set gcc-12 as your default compiler:

sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-12 90

This sets gcc-12 as your gcc compiler with priority 90. This step may not be needed if you're already using gcc 12 or if you didn't have gcc installed before. You can check what version of gcc you're currently using with gcc -v. If it mentions at the end that you're running "gcc version 12", you should be fine.

Congratulations, you're now ready to compile PVSNESLIB on ChromeOS! From here, you can continue from Compiling the project.

Compiling the project

This procedure is supposed to work whatever the system used: Windows under MSYS2, Linux, MacOS, or ChromeOS.

Clone the repository

By using the git command, clone the repository first :

git clone --recurse-submodules --depth=1 https://github.com/alekmaul/pvsneslib.git

The recurse-submodules option will download WLA and TCC tools which are required and stored in other repositories.

depth=1 is optional but allow you to download only the last version of source code. If you do not want all modifications history, you will probably win some time and disk space by using it.

Set the PVSNESLIB_HOME environment variable

To avoid forgetting it later, we can begin from this point. Just create an environment variable PVSNESLIB_HOME pointing on your pvsneslib directory.

You can accomplish it by using the following command in your terminal:

export PVSNESLIB_HOME=$(pwd)

Please remember that:

  • PVSNESLIB_HOME environment variable (or any folder you will create under its tree) CANNOT contains spaces.
  • This environment variable is not persistent. It means you'll have to set it if you launch a new terminal, or close the current one.

Don't worry, if you forget, you will be notified of an error message by running the make command.

Build the whole project

Building the whole project can be performed by simply running the make command at the root of the project.

Note: The Makefile at the root of the project is written to run the all the others Makefile in the subdirectories. It will always perform a full clean recipe before to compile as well as the install recipe after compilation.

Once the compilation is done, you can find all the tools, compilers and libraries in the devkitsnes directory.

Build the whole project and create your own release

This procedure is pretty the same as building the whole project, just add the release after your make command:

make release

Once the compilation is done, you can find your compressed release (zip) in the release directory.

Participate to pvsneslib improvments

You can help use to improve pvsneslib but you need to make all changes on `develop``.

Don't forget to be on this branch before requesting a Pull Request !

git checkout develop

Installation

  1. Installation
  2. PVSneslib and Visual Studio Code
  3. First steps with No$sns emulator
  4. Compiling from sources

Programming

  1. Introduction
  2. Hello World example
  3. Input and Output
  4. Sprites
  5. Dynamic Sprites
  6. Backgrounds
  7. Sounds and Musics
  8. HiRom and FastRom
  9. Map Engine 1: Import maps for Tiled
  10. Map Engine 2: Update maps in Tiled
  11. Map Engine 3: Display map on SNES (I)

Misc

  1. Contribute
  2. Community FAQ
  3. Community code
  4. Roadmap
  5. Tips and Bugs
  6. SNES ROM Header todo
Clone this wiki locally