Setup

Prerequisites

• Ubuntu >= 24.04 or macOS >= 15 (with Homebrew).

• Python >= 3.12 (see pyenv).

• A copy of the source code (see Clone the Repository).

Note

All of the commands below should be run from the root of the repository.

Setup

To setup Undertale, first install the necessary dependencies:

sudo bash dependencies/production.{operating-system}.sh

Where {operating-system} is either ubuntu or macos.

Warning

There are some dependencies that the scripts cannot install automatically for you - please check the output for warnings and more information.

Then install the Python package with pip with frozen dependencies:

pip install . -c constraints.txt