# Building from source — Raylib Python documentation

# Building from source

## Have Pip build from source

This is useful if the binaries don’t work on your system, or you want to use a newer version of Raylib.

First make sure Raylib is installed. On Linux/Mac it must include the pkg-config files. Best way to ensure this is to compile and install Raylib using CMake: https://github.com/raysan5/raylib/wiki/Working-on-GNU-Linux#build-raylib-using-cmake

Requirements for build: cmake, pkg-config.

    cd raylib-5.0
    mkdir build
    cd build
    cmake  -DCUSTOMIZE_BUILD=ON -DSUPPORT_FILEFORMAT_JPG=ON -DSUPPORT_FILEFORMAT_FLAC=ON -DWITH_PIC=ON -DCMAKE_BUILD_TYPE=Release ..
    make
    sudo make install

Then ask Pip to build from source:

    pip3 install --no-cache-dir --no-binary raylib --upgrade --force-reinstall raylib

## Or, Build from source manually

Useful if the Pip build doesn’t work and you want to debug it, or you want to contribute to the project.

Attention

If the Pip build doesn’t work, please submit a bug. (And if you have fixed it, a PR.)

Manual instructions follow, but are probably outdated, so see instead how we actually build the wheels at https://github.com/electronstudio/raylib-python-cffi/blob/master/.github/workflows/build.yml

### Windows manual build

Clone this repo including submodules so you get correct version of Raylib.

    git clone --recurse-submodules https://github.com/electronstudio/raylib-python-cffi

Open Visual C++ command shell.

Fix the symlink that doesnt work on Windows

    cd raylib-python-cffi
    copy raylib-c\src\raylib.h raylib\raylib.h

Build and install Raylib from the raylib-c directory.

    cd raylib-python-cffi/raylib-c
    mkdir build
    cd build
    cmake -DWITH_PIC=on -DCMAKE_BUILD_TYPE=Release ..
    msbuild raylib.sln /target:raylib /property:Configuration=Release
    copy raylib\Release\raylib.lib ..\..
    cd ..\..

To build a binary wheel distribution:

    rmdir /Q /S build
    pip3 install cffi
    pip3 install wheel
    python setup.py bdist_wheel

Todo

There’s a hardcoded path (to the raylib header files) in raylib/build.py you will probably need to edit. Would be useful if some Windows user could figure out how to auto detect this.

Then install it:

    pip3 install dist\raylib-3.7.0-cp37-cp37m-win_amd64.whl

(Note: your wheel’s filename will probably be different than the one here.)

### Linux manual build

Clone this repo including submodules so you get correct version of Raylib.

    git clone --recurse-submodules https://github.com/electronstudio/raylib-python-cffi

Build and install Raylib from the raylib-c directory.

Note

You can instead use a different version of Raylib you installed from elsewhere, and it should still work!

    sudo apt install cmake libasound2-dev mesa-common-dev libx11-dev libxrandr-dev libxi-dev xorg-dev libgl1-mesa-dev libglu1-mesa-dev pkg-config cmake
    cd raylib-python-cffi/raylib-c
    mkdir build
    cd build
    cmake -DCUSTOMIZE_BUILD=ON -DSUPPORT_FILEFORMAT_JPG=ON -DSUPPORT_FILEFORMAT_FLAC=ON -DWITH_PIC=ON -DCMAKE_BUILD_TYPE=Release ..
    sudo make install

Note

Optional: Build the Raylib shared libs, if you plan to use `raylib_dynamic` binding.

    rm -rf *
    cmake -DWITH_PIC=on -DBUILD_SHARED_LIBS=on -DCMAKE_BUILD_TYPE=Release ..
    make
    sudo make install

    cd ../..

Build the Python library:

    pip3 install cffi
    rm -rf build raylib/_raylib_cffi.*
    python3 raylib/build.py

Note

(Optional) To update the Linux dynamic libs (names will be different on other platforms):

    rm dynamic/raylib/*.so*
    cp -P /usr/local/lib/libraylib.so* dynamic/raylib/

To build a binary wheel distribution:

    pip3 install wheel
    python3 setup.py bdist_wheel

Then install it:

    pip3 install dist/raylib*.whl

To build a complete set of libs for Python 3.6, 3.7, 3.8 and 3.9:

    ./raylib/build_multi.sh

Warning

pypi wont accept Linux packages unless they are built `--plat-name manylinux2014_x86_64` so on linux please run `./raylib/build_multi_linux.sh` )

Todo

Separate the instructions for preparing the dynamic module from the instructions for building the static module!

### Macos manual build

These instructions have been tested on Macos 10.14.

Clone this repo including submodules so you get correct version of Raylib.

    git clone --recurse-submodules https://github.com/electronstudio/raylib-python-cffi

Build and install Raylib from the raylib-c directory.

    cd raylib-python-cffi/raylib-c/
    mkdir build
    cd build
    cmake -DWITH_PIC=on -DCMAKE_BUILD_TYPE=Release ..
    make
    sudo make install
    cd ../..

Build and install module.

    pip3 install cffi
    rm -rf build raylib/_raylib_cffi.*
    python3 raylib/build.py
    pip3 install wheel
    python3 setup.py install