Skip to content

Installation Guide

Archie_UwU edited this page Nov 20, 2023 · 12 revisions

Welcome to the Aurie wiki, here's how you get started:

Installation Guide (end-user)

Click here for an image

Visual Studio project setup guide

Click here for an image

Note: You can zoom into the images, they're high resolution.


Setting up on Linux under Wine

While Aurie is designed as a Windows-only framework, getting it to run under a Linux distribution of your choice is possible, provided you have access to Wine - there are however multiple caveats and gotchas in such environments:

  • AurieInstaller fails to proxy game executables correctly

In order for Aurie to initialize correctly, use the following command line:

$ pwd
/home/user/Desktop/example_game
$ wine ./mods/AurieLoader.exe game.exe --debug

Providing the --debug flag to GameMaker is necessary as of writing. Not including it will cause Aurie to indefinitely wait for the game window, halting any execution.

These steps are derived from @ramennnoodle's endeavor documented on the Arch Wizards Discord server.

Building Aurie on Linux under Wine

Installing prerequisites

Building the Aurie DLL (AurieCore) requires msvc-wine for compilation and cmake-converter for porting the Visual Studio project into CMake.

On Arch Linux, the installation of these prerequisites is done through the following command:

sudo pacman -Sy --needed git gcc cmake wine msitools samba python python-pipx python-simplejson python-six

Next up, we need to install MSVC:

git clone https://github.com/mstorsjo/msvc-wine.git
cd msvc-wine

# This example installs the compiler to ~/my_msvc/opt/msvc 
./vsdownload.py --dest ~/my_msvc/opt/msvc
./install.sh ~/my_msvc/opt/msvc

# Add compiler commands to PATH
export PATH=~/my_msvc/opt/msvc/bin/x64:$PATH

# Optional: Start a persistent wineserver
wineserver -k # Kill a potential old server
wineserver -p # Start a new server
wine64 wineboot # Run a process to start up all background wine processes

After Wine is set-up with MSVC, it is necessary to convert the Visual Studio project into a CMake one.

pipx install cmake-converter
cmake-converter -s Aurie.sln

Building

# Make folder for CMake's generated build files
mkdir build && cd build
# Generate build files with CMake
CC=cl CXX=cl cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_SYSTEM_NAME=Windows
# Compile with make

Provided everything works out, you should find the binaries in the x64/Release folder in the project repository's root directory.

Huge thank you to @ramennnoodle on the Arch Wizards Discord server, who was kind enough to provide these steps for everyone to use.