Setup

Gum Application (binaries): files.flatredball.com/content/Tools/Gum/Gum.zip

Gum Source Code: https://www.github.com/vchelaru/Gum

Windows

Currently the Gum tool requires XNA runtimes. Download and install the runtime prior to running Gum:

Download Microsoft XNA Framework Redistributable 4.0 from Official Microsoft Download CenterMicrosoft Store - Download Center

Since Gum is a prebuilt file in a .zip, Windows blocks the file which results in the "Windows protected your PC" popup:

Windows protected your PC popup

You can click More info, then Run anyway. Alternatively, you can right-click on the .zip file and select the option to unblock:

Unblocking the .zip file removes the "Windows protected your PC" popup

Mac

Prerequisites

Before proceeding, ensure that you have the following prerequisites installed on your macOS:

1. Homebrew

2. WINE

3. Winetricks

Install Homebrew

Homebrew is a package manager for macOS. If you haven't installed Homebrew yet, you can install it by following the instructions on the official Homebrew website.

Install WINE and Winetricks

You can install WINE and Winetricks using Homebrew. Open a terminal and run the following commands:

brew install --cask --no-quarantine wine-stable
brew install winetricks

Automated Setup

The following goes through the steps do download and run the setup_gum_mac.sh automation script. This script goes through the steps for you with minimal interaction to setup your environment on macOS to run the GUM tool using WINE. If you would prefer to do this setup manually, please see the Manual Setup Steps section below.

1. Download the setup_gum.mac.sh script https://raw.githubusercontent.com/vchelaru/Gum/master/setup_gum_mac.sh

2. Open a terminal and cd to the directory that the script was downloaded to

3. Make the script executable

chmod +x ./setup_gum_mac.sh

1. Execute the script

./setup_gum.mac.sh

Manual Setup Steps

The following goes through the steps setup your environment on macOS to run the GUM tool using WINE.

1. Open a new terminal

2. Install .NET Framework 4.8 using winetricks with the following command:

winetricks dotnet48

This command initiates the installation of .NET Framework 4.8. A total of two installer dialogs appear one after another. Follow the steps for both to complete the installation. This process may take a several minutes, so please be patient.

1. Download the XNA 4.0 Redistributable MSI file from Microsoft. You can download it using the following command:

curl -O https://download.microsoft.com/download/A/C/2/AC2C903B-E6E8-42C2-9FD7-BEBAC362A930/xnafx40_redist.msi

1. After downloading the MSI file, install it using the following command:

wine msiexec /i xnafx40_redist.msi

Follow the installation prompts. At the end of the installation, it may display an error related to launching DirectX. This is normal; just click "Close" on the error dialog.

1. Download the Gum Tool ZIP file from the FlatRedBall website and save it to your preferred location. You can download it using the following command:

curl -o Gum.zip https://files.flatredball.com/content/Tools/Gum/Gum.zip

1. Unzip the downloaded Gum Tool ZIP file into the Program Files directory of the WINE folder. Run the following command in the terminal:

unzip Gum.zip -d ~/.wine/drive_c/Program\ Files/Gum

1. After unzipping the Gum Tool, remove the downloaded ZIP file using the following command:

rm -f Gum.zip

1. Create a script to run the Gum Tool. Run the following command in the terminal:

echo '#!/bin/bash
wine ~/.wine/drive_c/Program\\ Files/Gum/Data/Gum.exe' > ~/bin/Gum

1. Make the script executable by running:

chmod +x ~/bin/Gum

1. To ensure you can run the Gum Tool from any directory, add the script directory to your PATH.

For Bash SHELL

if ! grep -q 'export PATH="\$HOME/bin:\$PATH"' ~/.bash_profile 2>/dev/null; then
    echo 'export PATH="$HOME/bin:$PATH"' >> ~/.bash_profile
fi

For ZSH Shell

if ! grep -q 'export PATH="\$HOME/bin:\$PATH"' ~/.zshrc 2>/dev/null; then
    echo 'export PATH="$HOME/bin:$PATH"' >> ~/.zshrc
fi

1. Reload the shell configuration to apply the changes. Run the following command:

For BASH Shell

source ~/.bash_profile

For ZSH Shell

source ~/.zshrc

Running the Gum Tool

Congratulations! You have now successfully set up the Gum Tool on macOS using WINE. You can open the Gum Tool by simply typing the following command in the terminal:

Gum

If the command doesn't work immediately, try closing and reopening the terminal.