donut

donut is an open source reimplementation of The Simpsons: Hit & Run written in modern C++ and modern OpenGL.

You still need to have the original game assets in order to use this.

Building

Clone the code using: git clone --recursive https://github.com/plowteam/donut.git

The simplest way to obtain all the required dependencies is through vcpkg.

PS> .\vcpkg install sdl2 bullet3 openal-soft fmt
Linux:~/$ ./vcpkg install sdl2 bullet3 openal-soft fmt

If you don't want to use vcpkg; CMake will fallback on installed system dependencies, or manually specified package directories.

Windows

Install Visual Studio 2019
Install CMake

You can either:

Open the donut folder directly in Visual Studio.
Or generate project files with the following:

cd donut
cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows

Linux

Note: These instructions are for Ubuntu, but can be easily applied to other distros.

Ensure you have dependencies first

sudo apt install cmake
cd donut
cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-linux
cmake --build build -j 5

Mesa drivers on Linux: if you are trying to run with Mesa drivers and are getting issues with OpenGL context try messing with MESA_GL_VERSION_OVERRIDE when running like so: MESA_GL_VERSION_OVERRIDE=4.3FC MESA_GLSL_VERSION_OVERRIDE=430 bin/donut

Docs

Contributing

Contributions are always welcome, whether it's modifying source code to add new features or bug fixes, documenting new file formats or simply editing some grammar.

You can also join the Discord for development discussion if you are unsure of anything.

License

donut is released as open source software under the GPL v3 license, see the LICENSE.md file in the project root for the full license text.